Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: minimal FTP implementation |
| 3 | * Description: minimal FTP implementation allowing to fetch resources |
| 4 | * like external subset. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 5 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 6 | * Copy: See Copyright for the status of this software. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 7 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 8 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | #ifndef __NANO_FTP_H__ |
| 12 | #define __NANO_FTP_H__ |
| 13 | |
| 14 | #include <libxml/xmlversion.h> |
Igor Zlatkovic | 7ae91bc | 2002-11-08 17:18:52 +0000 | [diff] [blame] | 15 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 16 | #ifdef LIBXML_FTP_ENABLED |
| 17 | |
| 18 | #ifdef __cplusplus |
| 19 | extern "C" { |
| 20 | #endif |
| 21 | |
| 22 | /** |
| 23 | * ftpListCallback: |
| 24 | * @userData: user provided data for the callback |
| 25 | * @filename: the file name (including "->" when links are shown) |
| 26 | * @attrib: the attribute string |
| 27 | * @owner: the owner string |
| 28 | * @group: the group string |
| 29 | * @size: the file size |
| 30 | * @links: the link count |
| 31 | * @year: the year |
| 32 | * @month: the month |
| 33 | * @day: the day |
| 34 | * @hour: the hour |
| 35 | * @minute: the minute |
| 36 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 37 | * A callback for the xmlNanoFTPList command. |
| 38 | * Note that only one of year and day:minute are specified. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 39 | */ |
| 40 | typedef void (*ftpListCallback) (void *userData, |
Daniel Veillard | 963d2ae | 2002-01-20 22:08:18 +0000 | [diff] [blame] | 41 | const char *filename, const char *attrib, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 42 | const char *owner, const char *group, |
| 43 | unsigned long size, int links, int year, |
| 44 | const char *month, int day, int hour, |
| 45 | int minute); |
| 46 | /** |
| 47 | * ftpDataCallback: |
Daniel Veillard | f69bb4b | 2001-05-19 13:24:56 +0000 | [diff] [blame] | 48 | * @userData: the user provided context |
| 49 | * @data: the data received |
| 50 | * @len: its size in bytes |
| 51 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 52 | * A callback for the xmlNanoFTPGet command. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 53 | */ |
Daniel Veillard | 963d2ae | 2002-01-20 22:08:18 +0000 | [diff] [blame] | 54 | typedef void (*ftpDataCallback) (void *userData, |
| 55 | const char *data, |
| 56 | int len); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 57 | |
| 58 | /* |
| 59 | * Init |
| 60 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 61 | XMLPUBFUN void XMLCALL |
| 62 | xmlNanoFTPInit (void); |
| 63 | XMLPUBFUN void XMLCALL |
| 64 | xmlNanoFTPCleanup (void); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 65 | |
| 66 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 67 | * Creating/freeing contexts. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 68 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 69 | XMLPUBFUN void * XMLCALL |
| 70 | xmlNanoFTPNewCtxt (const char *URL); |
| 71 | XMLPUBFUN void XMLCALL |
| 72 | xmlNanoFTPFreeCtxt (void * ctx); |
| 73 | XMLPUBFUN void * XMLCALL |
| 74 | xmlNanoFTPConnectTo (const char *server, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 75 | int port); |
| 76 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 77 | * Opening/closing session connections. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 78 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 79 | XMLPUBFUN void * XMLCALL |
| 80 | xmlNanoFTPOpen (const char *URL); |
| 81 | XMLPUBFUN int XMLCALL |
| 82 | xmlNanoFTPConnect (void *ctx); |
| 83 | XMLPUBFUN int XMLCALL |
| 84 | xmlNanoFTPClose (void *ctx); |
| 85 | XMLPUBFUN int XMLCALL |
| 86 | xmlNanoFTPQuit (void *ctx); |
| 87 | XMLPUBFUN void XMLCALL |
| 88 | xmlNanoFTPScanProxy (const char *URL); |
| 89 | XMLPUBFUN void XMLCALL |
| 90 | xmlNanoFTPProxy (const char *host, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 91 | int port, |
| 92 | const char *user, |
| 93 | const char *passwd, |
| 94 | int type); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 95 | XMLPUBFUN int XMLCALL |
| 96 | xmlNanoFTPUpdateURL (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 97 | const char *URL); |
| 98 | |
| 99 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 100 | * Rather internal commands. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 101 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 102 | XMLPUBFUN int XMLCALL |
| 103 | xmlNanoFTPGetResponse (void *ctx); |
| 104 | XMLPUBFUN int XMLCALL |
| 105 | xmlNanoFTPCheckResponse (void *ctx); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 106 | |
| 107 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 108 | * CD/DIR/GET handlers. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 109 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 110 | XMLPUBFUN int XMLCALL |
| 111 | xmlNanoFTPCwd (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 112 | char *directory); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 113 | XMLPUBFUN int XMLCALL |
| 114 | xmlNanoFTPDele (void *ctx, |
Daniel Veillard | 6c73cb8 | 2003-03-05 16:45:40 +0000 | [diff] [blame] | 115 | char *file); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 116 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 117 | XMLPUBFUN int XMLCALL |
| 118 | xmlNanoFTPGetConnection (void *ctx); |
| 119 | XMLPUBFUN int XMLCALL |
| 120 | xmlNanoFTPCloseConnection(void *ctx); |
| 121 | XMLPUBFUN int XMLCALL |
| 122 | xmlNanoFTPList (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 123 | ftpListCallback callback, |
| 124 | void *userData, |
| 125 | char *filename); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 126 | XMLPUBFUN int XMLCALL |
| 127 | xmlNanoFTPGetSocket (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 128 | const char *filename); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 129 | XMLPUBFUN int XMLCALL |
| 130 | xmlNanoFTPGet (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 131 | ftpDataCallback callback, |
| 132 | void *userData, |
| 133 | const char *filename); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 134 | XMLPUBFUN int XMLCALL |
| 135 | xmlNanoFTPRead (void *ctx, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 136 | void *dest, |
| 137 | int len); |
| 138 | |
| 139 | #ifdef __cplusplus |
| 140 | } |
| 141 | #endif /* LIBXML_FTP_ENABLED */ |
| 142 | #endif |
| 143 | #endif /* __NANO_FTP_H__ */ |