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