blob: 1093622e25f428b137d9d1532d8c050a1cc7184d [file] [log] [blame]
Owen Taylor3473f882001-02-23 17:55:21 +00001/*
2 * xmlIO.c : implementation of the I/O interfaces used by the parser
3 *
4 * See Copyright for the status of this software.
5 *
Daniel Veillard344cee72001-08-20 00:08:40 +00006 * daniel@veillard.com
Owen Taylor3473f882001-02-23 17:55:21 +00007 *
8 * 14 Nov 2000 ht - for VMS, truncated name of long functions to under 32 char
9 */
10
Daniel Veillard34ce8be2002-03-18 19:37:11 +000011#define IN_LIBXML
Bjorn Reese70a9da52001-04-21 16:57:29 +000012#include "libxml.h"
Owen Taylor3473f882001-02-23 17:55:21 +000013
Owen Taylor3473f882001-02-23 17:55:21 +000014#include <string.h>
Daniel Veillard92727042002-09-17 17:59:20 +000015#ifdef HAVE_ERRNO_H
Owen Taylor3473f882001-02-23 17:55:21 +000016#include <errno.h>
Daniel Veillard92727042002-09-17 17:59:20 +000017#endif
18
Owen Taylor3473f882001-02-23 17:55:21 +000019
20#ifdef HAVE_SYS_TYPES_H
21#include <sys/types.h>
22#endif
23#ifdef HAVE_SYS_STAT_H
24#include <sys/stat.h>
25#endif
26#ifdef HAVE_FCNTL_H
27#include <fcntl.h>
28#endif
29#ifdef HAVE_UNISTD_H
30#include <unistd.h>
31#endif
32#ifdef HAVE_STDLIB_H
33#include <stdlib.h>
34#endif
35#ifdef HAVE_ZLIB_H
36#include <zlib.h>
37#endif
38
39/* Figure a portable way to know if a file is a directory. */
40#ifndef HAVE_STAT
41# ifdef HAVE__STAT
Daniel Veillard50f34372001-08-03 12:06:36 +000042 /* MS C library seems to define stat and _stat. The definition
43 is identical. Still, mapping them to each other causes a warning. */
44# ifndef _MSC_VER
45# define stat(x,y) _stat(x,y)
46# endif
Owen Taylor3473f882001-02-23 17:55:21 +000047# define HAVE_STAT
48# endif
49#endif
50#ifdef HAVE_STAT
51# ifndef S_ISDIR
52# ifdef _S_ISDIR
53# define S_ISDIR(x) _S_ISDIR(x)
54# else
55# ifdef S_IFDIR
56# ifndef S_IFMT
57# ifdef _S_IFMT
58# define S_IFMT _S_IFMT
59# endif
60# endif
61# ifdef S_IFMT
62# define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
63# endif
64# endif
65# endif
66# endif
67#endif
68
69#include <libxml/xmlmemory.h>
70#include <libxml/parser.h>
71#include <libxml/parserInternals.h>
72#include <libxml/xmlIO.h>
Daniel Veillard388236f2001-07-08 18:35:48 +000073#include <libxml/uri.h>
Owen Taylor3473f882001-02-23 17:55:21 +000074#include <libxml/nanohttp.h>
75#include <libxml/nanoftp.h>
76#include <libxml/xmlerror.h>
Daniel Veillard7d6fd212001-05-10 15:34:11 +000077#ifdef LIBXML_CATALOG_ENABLED
78#include <libxml/catalog.h>
79#endif
Daniel Veillard3c01b1d2001-10-17 15:58:35 +000080#include <libxml/globals.h>
Owen Taylor3473f882001-02-23 17:55:21 +000081
Daniel Veillardf012a642001-07-23 19:10:52 +000082/* #define VERBOSE_FAILURE */
Daniel Veillard1fd36d22001-07-04 22:54:28 +000083/* #define DEBUG_EXTERNAL_ENTITIES */
Owen Taylor3473f882001-02-23 17:55:21 +000084/* #define DEBUG_INPUT */
85
86#ifdef DEBUG_INPUT
87#define MINLEN 40
88#else
89#define MINLEN 4000
90#endif
91
92/*
93 * Input I/O callback sets
94 */
95typedef struct _xmlInputCallback {
96 xmlInputMatchCallback matchcallback;
97 xmlInputOpenCallback opencallback;
98 xmlInputReadCallback readcallback;
99 xmlInputCloseCallback closecallback;
100} xmlInputCallback;
101
102#define MAX_INPUT_CALLBACK 15
103
Daniel Veillard22090732001-07-16 00:06:07 +0000104static xmlInputCallback xmlInputCallbackTable[MAX_INPUT_CALLBACK];
105static int xmlInputCallbackNr = 0;
106static int xmlInputCallbackInitialized = 0;
Owen Taylor3473f882001-02-23 17:55:21 +0000107
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000108#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +0000109/*
110 * Output I/O callback sets
111 */
112typedef struct _xmlOutputCallback {
113 xmlOutputMatchCallback matchcallback;
114 xmlOutputOpenCallback opencallback;
115 xmlOutputWriteCallback writecallback;
116 xmlOutputCloseCallback closecallback;
117} xmlOutputCallback;
118
119#define MAX_OUTPUT_CALLBACK 15
120
Daniel Veillard22090732001-07-16 00:06:07 +0000121static xmlOutputCallback xmlOutputCallbackTable[MAX_OUTPUT_CALLBACK];
122static int xmlOutputCallbackNr = 0;
123static int xmlOutputCallbackInitialized = 0;
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000124#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +0000125
Daniel Veillard05d987b2003-10-08 11:54:57 +0000126/************************************************************************
127 * *
128 * Tree memory error handler *
129 * *
130 ************************************************************************/
Daniel Veillardf4862f02002-09-10 11:13:43 +0000131
Daniel Veillard05d987b2003-10-08 11:54:57 +0000132static const char *IOerr[] = {
Daniel Veillarda8856222003-10-08 19:26:03 +0000133 "Unknown IO error", /* UNKNOWN */
Daniel Veillard05d987b2003-10-08 11:54:57 +0000134 "Permission denied", /* EACCES */
135 "Resource temporarily unavailable",/* EAGAIN */
136 "Bad file descriptor", /* EBADF */
137 "Bad message", /* EBADMSG */
138 "Resource busy", /* EBUSY */
139 "Operation canceled", /* ECANCELED */
140 "No child processes", /* ECHILD */
141 "Resource deadlock avoided",/* EDEADLK */
142 "Domain error", /* EDOM */
143 "File exists", /* EEXIST */
144 "Bad address", /* EFAULT */
145 "File too large", /* EFBIG */
146 "Operation in progress", /* EINPROGRESS */
147 "Interrupted function call",/* EINTR */
148 "Invalid argument", /* EINVAL */
149 "Input/output error", /* EIO */
150 "Is a directory", /* EISDIR */
151 "Too many open files", /* EMFILE */
152 "Too many links", /* EMLINK */
153 "Inappropriate message buffer length",/* EMSGSIZE */
154 "Filename too long", /* ENAMETOOLONG */
155 "Too many open files in system",/* ENFILE */
156 "No such device", /* ENODEV */
157 "No such file or directory",/* ENOENT */
158 "Exec format error", /* ENOEXEC */
159 "No locks available", /* ENOLCK */
160 "Not enough space", /* ENOMEM */
161 "No space left on device", /* ENOSPC */
162 "Function not implemented", /* ENOSYS */
163 "Not a directory", /* ENOTDIR */
164 "Directory not empty", /* ENOTEMPTY */
165 "Not supported", /* ENOTSUP */
166 "Inappropriate I/O control operation",/* ENOTTY */
167 "No such device or address",/* ENXIO */
168 "Operation not permitted", /* EPERM */
169 "Broken pipe", /* EPIPE */
170 "Result too large", /* ERANGE */
171 "Read-only file system", /* EROFS */
172 "Invalid seek", /* ESPIPE */
173 "No such process", /* ESRCH */
174 "Operation timed out", /* ETIMEDOUT */
175 "Improper link", /* EXDEV */
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000176 "Attempt to load network entity %s", /* XML_IO_NETWORK_ATTEMPT */
Daniel Veillard05d987b2003-10-08 11:54:57 +0000177 "encoder error", /* XML_IO_ENCODER */
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000178 "flush error",
179 "write error",
180 "no input",
181 "buffer full",
182 "loading error",
183 "not a socket", /* ENOTSOCK */
184 "already connected", /* EISCONN */
185 "connection refuxed", /* ECONNREFUSED */
186 "unreachable network", /* ENETUNREACH */
187 "adddress in use", /* EADDRINUSE */
188 "already in use", /* EALREADY */
189 "unknown address familly", /* EAFNOSUPPORT */
Daniel Veillard05d987b2003-10-08 11:54:57 +0000190};
191
192/**
193 * xmlIOErrMemory:
194 * @extra: extra informations
195 *
196 * Handle an out of memory condition
197 */
198static void
199xmlIOErrMemory(const char *extra)
200{
201 __xmlSimpleError(XML_FROM_IO, XML_ERR_NO_MEMORY, NULL, NULL, extra);
202}
203
204/**
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000205 * __xmlIOErr:
Daniel Veillard05d987b2003-10-08 11:54:57 +0000206 * @code: the error number
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000207 * @
Daniel Veillard05d987b2003-10-08 11:54:57 +0000208 * @extra: extra informations
209 *
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000210 * Handle an I/O error
Daniel Veillard05d987b2003-10-08 11:54:57 +0000211 */
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000212void
213__xmlIOErr(int domain, int code, const char *extra)
Daniel Veillard05d987b2003-10-08 11:54:57 +0000214{
215 unsigned int idx;
216
217 if (code == 0) {
218#ifdef HAVE_ERRNO_H
219 if (errno == 0) code = 0;
220#ifdef EACCES
221 else if (errno == EACCES) code = XML_IO_EACCES;
222#endif
223#ifdef EAGAIN
224 else if (errno == EAGAIN) code = XML_IO_EAGAIN;
225#endif
226#ifdef EBADF
227 else if (errno == EBADF) code = XML_IO_EBADF;
228#endif
229#ifdef EBADMSG
230 else if (errno == EBADMSG) code = XML_IO_EBADMSG;
231#endif
232#ifdef EBUSY
233 else if (errno == EBUSY) code = XML_IO_EBUSY;
234#endif
235#ifdef ECANCELED
236 else if (errno == ECANCELED) code = XML_IO_ECANCELED;
237#endif
238#ifdef ECHILD
239 else if (errno == ECHILD) code = XML_IO_ECHILD;
240#endif
241#ifdef EDEADLK
242 else if (errno == EDEADLK) code = XML_IO_EDEADLK;
243#endif
244#ifdef EDOM
245 else if (errno == EDOM) code = XML_IO_EDOM;
246#endif
247#ifdef EEXIST
248 else if (errno == EEXIST) code = XML_IO_EEXIST;
249#endif
250#ifdef EFAULT
251 else if (errno == EFAULT) code = XML_IO_EFAULT;
252#endif
253#ifdef EFBIG
254 else if (errno == EFBIG) code = XML_IO_EFBIG;
255#endif
256#ifdef EINPROGRESS
257 else if (errno == EINPROGRESS) code = XML_IO_EINPROGRESS;
258#endif
259#ifdef EINTR
260 else if (errno == EINTR) code = XML_IO_EINTR;
261#endif
262#ifdef EINVAL
263 else if (errno == EINVAL) code = XML_IO_EINVAL;
264#endif
265#ifdef EIO
266 else if (errno == EIO) code = XML_IO_EIO;
267#endif
268#ifdef EISDIR
269 else if (errno == EISDIR) code = XML_IO_EISDIR;
270#endif
271#ifdef EMFILE
272 else if (errno == EMFILE) code = XML_IO_EMFILE;
273#endif
274#ifdef EMLINK
275 else if (errno == EMLINK) code = XML_IO_EMLINK;
276#endif
277#ifdef EMSGSIZE
278 else if (errno == EMSGSIZE) code = XML_IO_EMSGSIZE;
279#endif
280#ifdef ENAMETOOLONG
281 else if (errno == ENAMETOOLONG) code = XML_IO_ENAMETOOLONG;
282#endif
283#ifdef ENFILE
284 else if (errno == ENFILE) code = XML_IO_ENFILE;
285#endif
286#ifdef ENODEV
287 else if (errno == ENODEV) code = XML_IO_ENODEV;
288#endif
289#ifdef ENOENT
290 else if (errno == ENOENT) code = XML_IO_ENOENT;
291#endif
292#ifdef ENOEXEC
293 else if (errno == ENOEXEC) code = XML_IO_ENOEXEC;
294#endif
295#ifdef ENOLCK
296 else if (errno == ENOLCK) code = XML_IO_ENOLCK;
297#endif
298#ifdef ENOMEM
299 else if (errno == ENOMEM) code = XML_IO_ENOMEM;
300#endif
301#ifdef ENOSPC
302 else if (errno == ENOSPC) code = XML_IO_ENOSPC;
303#endif
304#ifdef ENOSYS
305 else if (errno == ENOSYS) code = XML_IO_ENOSYS;
306#endif
307#ifdef ENOTDIR
308 else if (errno == ENOTDIR) code = XML_IO_ENOTDIR;
309#endif
310#ifdef ENOTEMPTY
311 else if (errno == ENOTEMPTY) code = XML_IO_ENOTEMPTY;
312#endif
313#ifdef ENOTSUP
314 else if (errno == ENOTSUP) code = XML_IO_ENOTSUP;
315#endif
316#ifdef ENOTTY
317 else if (errno == ENOTTY) code = XML_IO_ENOTTY;
318#endif
319#ifdef ENXIO
320 else if (errno == ENXIO) code = XML_IO_ENXIO;
321#endif
322#ifdef EPERM
323 else if (errno == EPERM) code = XML_IO_EPERM;
324#endif
325#ifdef EPIPE
326 else if (errno == EPIPE) code = XML_IO_EPIPE;
327#endif
328#ifdef ERANGE
329 else if (errno == ERANGE) code = XML_IO_ERANGE;
330#endif
331#ifdef EROFS
332 else if (errno == EROFS) code = XML_IO_EROFS;
333#endif
334#ifdef ESPIPE
335 else if (errno == ESPIPE) code = XML_IO_ESPIPE;
336#endif
337#ifdef ESRCH
338 else if (errno == ESRCH) code = XML_IO_ESRCH;
339#endif
340#ifdef ETIMEDOUT
341 else if (errno == ETIMEDOUT) code = XML_IO_ETIMEDOUT;
342#endif
343#ifdef EXDEV
344 else if (errno == EXDEV) code = XML_IO_EXDEV;
345#endif
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000346#ifdef ENOTSOCK
347 else if (errno == ENOTSOCK) code = XML_IO_ENOTSOCK;
348#endif
349#ifdef EISCONN
350 else if (errno == EISCONN) code = XML_IO_EISCONN;
351#endif
352#ifdef ECONNREFUSED
353 else if (errno == ECONNREFUSED) code = XML_IO_ECONNREFUSED;
354#endif
355#ifdef ETIMEDOUT
356 else if (errno == ETIMEDOUT) code = XML_IO_ETIMEDOUT;
357#endif
358#ifdef ENETUNREACH
359 else if (errno == ENETUNREACH) code = XML_IO_ENETUNREACH;
360#endif
361#ifdef EADDRINUSE
362 else if (errno == EADDRINUSE) code = XML_IO_EADDRINUSE;
363#endif
364#ifdef EINPROGRESS
365 else if (errno == EINPROGRESS) code = XML_IO_EINPROGRESS;
366#endif
367#ifdef EALREADY
368 else if (errno == EALREADY) code = XML_IO_EALREADY;
369#endif
370#ifdef EAFNOSUPPORT
371 else if (errno == EAFNOSUPPORT) code = XML_IO_EAFNOSUPPORT;
372#endif
Daniel Veillard05d987b2003-10-08 11:54:57 +0000373 else code = XML_IO_UNKNOWN;
374#endif /* HAVE_ERRNO_H */
375 }
376 idx = 0;
377 if (code >= XML_IO_UNKNOWN) idx = code - XML_IO_UNKNOWN;
378 if (idx >= (sizeof(IOerr) / sizeof(IOerr[0]))) idx = 0;
379
Daniel Veillard2b0f8792003-10-10 19:36:36 +0000380 __xmlSimpleError(domain, code, NULL, IOerr[idx], extra);
381}
382
383/**
384 * xmlIOErr:
385 * @code: the error number
386 * @extra: extra informations
387 *
388 * Handle an I/O error
389 */
390static void
391xmlIOErr(int code, const char *extra)
392{
393 __xmlIOErr(XML_FROM_IO, code, extra);
Daniel Veillard05d987b2003-10-08 11:54:57 +0000394}
395
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000396/**
Daniel Veillarde8039df2003-10-27 11:25:13 +0000397 * __xmlLoaderErr:
398 * @ctx: the parser context
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000399 * @extra: extra informations
400 *
401 * Handle a resource access error
402 */
Daniel Veillarde8039df2003-10-27 11:25:13 +0000403void
404__xmlLoaderErr(void *ctx, const char *msg, const char *filename)
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000405{
Daniel Veillarde8039df2003-10-27 11:25:13 +0000406 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
Daniel Veillard659e71e2003-10-10 14:10:40 +0000407 xmlStructuredErrorFunc schannel = NULL;
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000408 xmlGenericErrorFunc channel = NULL;
409 void *data = NULL;
410 xmlErrorLevel level = XML_ERR_ERROR;
411
Daniel Veillard157fee02003-10-31 10:36:03 +0000412 if ((ctxt != NULL) && (ctxt->disableSAX != 0) &&
413 (ctxt->instate == XML_PARSER_EOF))
414 return;
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000415 if ((ctxt != NULL) && (ctxt->sax != NULL)) {
416 if (ctxt->validate) {
417 channel = ctxt->sax->error;
418 level = XML_ERR_ERROR;
419 } else {
420 channel = ctxt->sax->warning;
421 level = XML_ERR_WARNING;
422 }
Daniel Veillard659e71e2003-10-10 14:10:40 +0000423 schannel = ctxt->sax->serror;
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000424 data = ctxt->userData;
425 }
Daniel Veillard659e71e2003-10-10 14:10:40 +0000426 __xmlRaiseError(schannel, channel, data, ctxt, NULL, XML_FROM_IO,
Daniel Veillardcd6ff282003-10-08 22:38:13 +0000427 XML_IO_LOAD_ERROR, level, NULL, 0,
428 filename, NULL, NULL, 0, 0,
429 msg, filename);
430
431}
432
Daniel Veillard05d987b2003-10-08 11:54:57 +0000433/************************************************************************
434 * *
435 * Tree memory error handler *
436 * *
437 ************************************************************************/
Daniel Veillardf4862f02002-09-10 11:13:43 +0000438/**
Daniel Veillard01c13b52002-12-10 15:19:08 +0000439 * xmlNormalizeWindowsPath:
Daniel Veillard33300b42003-04-17 09:09:19 +0000440 * @path: the input file path
Daniel Veillardf4862f02002-09-10 11:13:43 +0000441 *
Igor Zlatkovic5f9fada2003-02-19 14:51:00 +0000442 * This function is obsolete. Please see xmlURIFromPath in uri.c for
443 * a better solution.
Daniel Veillard33300b42003-04-17 09:09:19 +0000444 *
445 * Returns a canonicalized version of the path
Daniel Veillardf4862f02002-09-10 11:13:43 +0000446 */
447xmlChar *
448xmlNormalizeWindowsPath(const xmlChar *path)
449{
Igor Zlatkovic5f9fada2003-02-19 14:51:00 +0000450 return xmlCanonicPath(path);
Daniel Veillardf4862f02002-09-10 11:13:43 +0000451}
452
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000453/**
454 * xmlCleanupInputCallbacks:
455 *
456 * clears the entire input callback table. this includes the
457 * compiled-in I/O.
458 */
459void
460xmlCleanupInputCallbacks(void)
461{
462 int i;
463
464 if (!xmlInputCallbackInitialized)
465 return;
466
Daniel Veillard107ccaa2001-11-27 16:23:50 +0000467 for (i = xmlInputCallbackNr - 1; i >= 0; i--) {
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000468 xmlInputCallbackTable[i].matchcallback = NULL;
469 xmlInputCallbackTable[i].opencallback = NULL;
470 xmlInputCallbackTable[i].readcallback = NULL;
471 xmlInputCallbackTable[i].closecallback = NULL;
472 }
473
474 xmlInputCallbackNr = 0;
Aleksey Sanin9c45ba82002-06-06 21:46:13 +0000475 xmlInputCallbackInitialized = 0;
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000476}
477
Daniel Veillardaecc0dc2004-05-08 02:32:07 +0000478/**
479 * xmlPopInputCallback:
480 *
481 * Clear the top input callback from the input stack. this includes the
482 * compiled-in I/O.
483 *
484 * Returns the number of input callback registered or -1 in case of error.
485 */
486int
487xmlPopInputCallbacks(void)
488{
489 if (!xmlInputCallbackInitialized)
490 return(-1);
491
492 if (xmlInputCallbackNr <= 0)
493 return(-1);
494
495 xmlInputCallbackNr--;
496 xmlInputCallbackTable[xmlInputCallbackNr].matchcallback = NULL;
497 xmlInputCallbackTable[xmlInputCallbackNr].opencallback = NULL;
498 xmlInputCallbackTable[xmlInputCallbackNr].readcallback = NULL;
499 xmlInputCallbackTable[xmlInputCallbackNr].closecallback = NULL;
500
501 return(xmlInputCallbackNr);
502}
503
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000504#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000505/**
506 * xmlCleanupOutputCallbacks:
507 *
508 * clears the entire output callback table. this includes the
509 * compiled-in I/O callbacks.
510 */
511void
512xmlCleanupOutputCallbacks(void)
513{
514 int i;
515
516 if (!xmlOutputCallbackInitialized)
517 return;
518
Daniel Veillard107ccaa2001-11-27 16:23:50 +0000519 for (i = xmlOutputCallbackNr - 1; i >= 0; i--) {
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000520 xmlOutputCallbackTable[i].matchcallback = NULL;
521 xmlOutputCallbackTable[i].opencallback = NULL;
522 xmlOutputCallbackTable[i].writecallback = NULL;
523 xmlOutputCallbackTable[i].closecallback = NULL;
524 }
525
526 xmlOutputCallbackNr = 0;
Aleksey Sanin9c45ba82002-06-06 21:46:13 +0000527 xmlOutputCallbackInitialized = 0;
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000528}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000529#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardacf7ff02001-10-29 20:21:47 +0000530
Owen Taylor3473f882001-02-23 17:55:21 +0000531/************************************************************************
532 * *
533 * Standard I/O for file accesses *
534 * *
535 ************************************************************************/
536
537/**
Daniel Veillarda9b66d02002-12-11 14:23:49 +0000538 * xmlCheckFilename:
Owen Taylor3473f882001-02-23 17:55:21 +0000539 * @path: the path to check
540 *
541 * function checks to see if @path is a valid source
542 * (file, socket...) for XML.
543 *
544 * if stat is not available on the target machine,
545 * returns 1. if stat fails, returns 0 (if calling
546 * stat on the filename fails, it can't be right).
547 * if stat succeeds and the file is a directory,
Daniel Veillard819d5cb2002-10-14 11:15:18 +0000548 * returns 2. otherwise returns 1.
Owen Taylor3473f882001-02-23 17:55:21 +0000549 */
550
Daniel Veillard819d5cb2002-10-14 11:15:18 +0000551int
Owen Taylor3473f882001-02-23 17:55:21 +0000552xmlCheckFilename (const char *path)
553{
554#ifdef HAVE_STAT
Owen Taylor3473f882001-02-23 17:55:21 +0000555 struct stat stat_buffer;
556
557 if (stat(path, &stat_buffer) == -1)
558 return 0;
559
Daniel Veillard819d5cb2002-10-14 11:15:18 +0000560#ifdef S_ISDIR
Owen Taylor3473f882001-02-23 17:55:21 +0000561 if (S_ISDIR(stat_buffer.st_mode)) {
Daniel Veillard819d5cb2002-10-14 11:15:18 +0000562 return 2;
Owen Taylor3473f882001-02-23 17:55:21 +0000563 }
Owen Taylor3473f882001-02-23 17:55:21 +0000564#endif
565#endif
566 return 1;
567}
568
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000569static int
Owen Taylor3473f882001-02-23 17:55:21 +0000570xmlNop(void) {
571 return(0);
572}
573
574/**
Owen Taylor3473f882001-02-23 17:55:21 +0000575 * xmlFdRead:
576 * @context: the I/O context
577 * @buffer: where to drop data
578 * @len: number of bytes to read
579 *
580 * Read @len bytes to @buffer from the I/O channel.
581 *
582 * Returns the number of bytes written
583 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000584static int
Owen Taylor3473f882001-02-23 17:55:21 +0000585xmlFdRead (void * context, char * buffer, int len) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000586 int ret;
587
588 ret = read((int) (long) context, &buffer[0], len);
589 if (ret < 0) xmlIOErr(0, "read()");
590 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000591}
592
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000593#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +0000594/**
595 * xmlFdWrite:
596 * @context: the I/O context
597 * @buffer: where to get data
598 * @len: number of bytes to write
599 *
600 * Write @len bytes from @buffer to the I/O channel.
601 *
602 * Returns the number of bytes written
603 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000604static int
Owen Taylor3473f882001-02-23 17:55:21 +0000605xmlFdWrite (void * context, const char * buffer, int len) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000606 int ret;
607
608 ret = write((int) (long) context, &buffer[0], len);
609 if (ret < 0) xmlIOErr(0, "write()");
610 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000611}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000612#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +0000613
614/**
615 * xmlFdClose:
616 * @context: the I/O context
617 *
618 * Close an I/O channel
Daniel Veillardf012a642001-07-23 19:10:52 +0000619 *
620 * Returns 0 in case of success and error code otherwise
Owen Taylor3473f882001-02-23 17:55:21 +0000621 */
Daniel Veillardf012a642001-07-23 19:10:52 +0000622static int
Owen Taylor3473f882001-02-23 17:55:21 +0000623xmlFdClose (void * context) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000624 int ret;
625 ret = close((int) (long) context);
626 if (ret < 0) xmlIOErr(0, "close()");
627 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000628}
629
630/**
631 * xmlFileMatch:
632 * @filename: the URI for matching
633 *
634 * input from FILE *
635 *
636 * Returns 1 if matches, 0 otherwise
637 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000638int
Daniel Veillardc86a4fa2001-03-26 16:28:29 +0000639xmlFileMatch (const char *filename ATTRIBUTE_UNUSED) {
Owen Taylor3473f882001-02-23 17:55:21 +0000640 return(1);
641}
642
643/**
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000644 * xmlFileOpen_real:
Owen Taylor3473f882001-02-23 17:55:21 +0000645 * @filename: the URI for matching
646 *
647 * input from FILE *, supports compressed input
648 * if @filename is " " then the standard input is used
649 *
650 * Returns an I/O context or NULL in case of error
651 */
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000652static void *
653xmlFileOpen_real (const char *filename) {
Owen Taylor3473f882001-02-23 17:55:21 +0000654 const char *path = NULL;
655 FILE *fd;
656
657 if (!strcmp(filename, "-")) {
658 fd = stdin;
659 return((void *) fd);
660 }
661
Daniel Veillardf4862f02002-09-10 11:13:43 +0000662 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000663#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardb212bbb2002-08-25 14:39:16 +0000664 path = &filename[17];
665#else
Owen Taylor3473f882001-02-23 17:55:21 +0000666 path = &filename[16];
Daniel Veillardb212bbb2002-08-25 14:39:16 +0000667#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000668 else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000669#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardfe703322001-08-14 12:18:09 +0000670 path = &filename[8];
671#else
Daniel Veillard3c2758d2001-05-31 18:43:43 +0000672 path = &filename[7];
Daniel Veillardfe703322001-08-14 12:18:09 +0000673#endif
674 } else
Owen Taylor3473f882001-02-23 17:55:21 +0000675 path = filename;
676
677 if (path == NULL)
678 return(NULL);
679 if (!xmlCheckFilename(path))
680 return(NULL);
681
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000682#if defined(WIN32) || defined (__DJGPP__) && !defined (__CYGWIN__)
Owen Taylor3473f882001-02-23 17:55:21 +0000683 fd = fopen(path, "rb");
684#else
685 fd = fopen(path, "r");
686#endif /* WIN32 */
Daniel Veillard05d987b2003-10-08 11:54:57 +0000687 if (fd == NULL) xmlIOErr(0, path);
Owen Taylor3473f882001-02-23 17:55:21 +0000688 return((void *) fd);
689}
690
691/**
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000692 * xmlFileOpen:
693 * @filename: the URI for matching
694 *
695 * Wrapper around xmlFileOpen_real that try it with an unescaped
696 * version of @filename, if this fails fallback to @filename
Daniel Veillard71531f32003-02-05 13:19:53 +0000697 *
698 * Returns a handler or NULL in case or failure
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000699 */
700void *
701xmlFileOpen (const char *filename) {
702 char *unescaped;
703 void *retval;
704 unescaped = xmlURIUnescapeString(filename, 0, NULL);
705 if (unescaped != NULL) {
706 retval = xmlFileOpen_real(unescaped);
707 } else {
708 retval = xmlFileOpen_real(filename);
709 }
710 xmlFree(unescaped);
711 return retval;
712}
713
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000714#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000715/**
Owen Taylor3473f882001-02-23 17:55:21 +0000716 * xmlFileOpenW:
717 * @filename: the URI for matching
718 *
719 * output to from FILE *,
720 * if @filename is "-" then the standard output is used
721 *
722 * Returns an I/O context or NULL in case of error
723 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000724static void *
Owen Taylor3473f882001-02-23 17:55:21 +0000725xmlFileOpenW (const char *filename) {
726 const char *path = NULL;
727 FILE *fd;
728
729 if (!strcmp(filename, "-")) {
730 fd = stdout;
731 return((void *) fd);
732 }
733
Daniel Veillardf4862f02002-09-10 11:13:43 +0000734 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000735#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardf4862f02002-09-10 11:13:43 +0000736 path = &filename[17];
737#else
Owen Taylor3473f882001-02-23 17:55:21 +0000738 path = &filename[16];
Daniel Veillardf4862f02002-09-10 11:13:43 +0000739#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000740 else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000741#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardfe703322001-08-14 12:18:09 +0000742 path = &filename[8];
743#else
Daniel Veillard3c2758d2001-05-31 18:43:43 +0000744 path = &filename[7];
Daniel Veillardfe703322001-08-14 12:18:09 +0000745#endif
746 } else
Owen Taylor3473f882001-02-23 17:55:21 +0000747 path = filename;
748
749 if (path == NULL)
750 return(NULL);
751
Daniel Veillardcbbd78d2003-07-20 15:21:30 +0000752 fd = fopen(path, "wb");
Daniel Veillard05d987b2003-10-08 11:54:57 +0000753 if (fd == NULL) xmlIOErr(0, path);
Owen Taylor3473f882001-02-23 17:55:21 +0000754 return((void *) fd);
755}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000756#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +0000757
758/**
759 * xmlFileRead:
760 * @context: the I/O context
761 * @buffer: where to drop data
762 * @len: number of bytes to write
763 *
764 * Read @len bytes to @buffer from the I/O channel.
765 *
766 * Returns the number of bytes written
767 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000768int
Owen Taylor3473f882001-02-23 17:55:21 +0000769xmlFileRead (void * context, char * buffer, int len) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000770 int ret;
771 ret = fread(&buffer[0], 1, len, (FILE *) context);
772 if (ret < 0) xmlIOErr(0, "fread()");
773 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000774}
775
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000776#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +0000777/**
778 * xmlFileWrite:
779 * @context: the I/O context
780 * @buffer: where to drop data
781 * @len: number of bytes to write
782 *
783 * Write @len bytes from @buffer to the I/O channel.
784 *
785 * Returns the number of bytes written
786 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000787static int
Owen Taylor3473f882001-02-23 17:55:21 +0000788xmlFileWrite (void * context, const char * buffer, int len) {
Daniel Veillard4a6d39b2002-12-17 18:33:01 +0000789 int items;
790
791 items = fwrite(&buffer[0], len, 1, (FILE *) context);
Daniel Veillard97bf4d02003-10-08 18:58:28 +0000792 if ((items == 0) && (ferror((FILE *) context))) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000793 xmlIOErr(0, "fwrite()");
Daniel Veillard97bf4d02003-10-08 18:58:28 +0000794 return(-1);
795 }
Daniel Veillard4a6d39b2002-12-17 18:33:01 +0000796 return(items * len);
Owen Taylor3473f882001-02-23 17:55:21 +0000797}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000798#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +0000799
800/**
801 * xmlFileClose:
802 * @context: the I/O context
803 *
804 * Close an I/O channel
Daniel Veillarda9b66d02002-12-11 14:23:49 +0000805 *
806 * Returns 0 or -1 in case of error
Owen Taylor3473f882001-02-23 17:55:21 +0000807 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000808int
Owen Taylor3473f882001-02-23 17:55:21 +0000809xmlFileClose (void * context) {
Daniel Veillarda9e65e82001-10-30 10:32:36 +0000810 FILE *fil;
Daniel Veillard05d987b2003-10-08 11:54:57 +0000811 int ret;
Daniel Veillarda9e65e82001-10-30 10:32:36 +0000812
813 fil = (FILE *) context;
Daniel Veillard500a1de2004-03-22 15:22:58 +0000814 if ((fil == stdout) || (fil == stderr)) {
815 ret = fflush(fil);
816 if (ret < 0)
817 xmlIOErr(0, "fflush()");
818 return(0);
819 }
Daniel Veillarda9e65e82001-10-30 10:32:36 +0000820 if (fil == stdin)
821 return(0);
Daniel Veillard05d987b2003-10-08 11:54:57 +0000822 ret = ( fclose((FILE *) context) == EOF ) ? -1 : 0;
823 if (ret < 0)
824 xmlIOErr(0, "fclose()");
825 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000826}
827
828/**
829 * xmlFileFlush:
830 * @context: the I/O context
831 *
832 * Flush an I/O channel
833 */
Daniel Veillardf012a642001-07-23 19:10:52 +0000834static int
Owen Taylor3473f882001-02-23 17:55:21 +0000835xmlFileFlush (void * context) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000836 int ret;
837 ret = ( fflush((FILE *) context) == EOF ) ? -1 : 0;
838 if (ret < 0)
839 xmlIOErr(0, "fflush()");
840 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000841}
842
843#ifdef HAVE_ZLIB_H
844/************************************************************************
845 * *
846 * I/O for compressed file accesses *
847 * *
848 ************************************************************************/
849/**
850 * xmlGzfileMatch:
851 * @filename: the URI for matching
852 *
853 * input from compressed file test
854 *
855 * Returns 1 if matches, 0 otherwise
856 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000857static int
Daniel Veillardc86a4fa2001-03-26 16:28:29 +0000858xmlGzfileMatch (const char *filename ATTRIBUTE_UNUSED) {
Owen Taylor3473f882001-02-23 17:55:21 +0000859 return(1);
860}
861
862/**
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000863 * xmlGzfileOpen_real:
Owen Taylor3473f882001-02-23 17:55:21 +0000864 * @filename: the URI for matching
865 *
866 * input from compressed file open
867 * if @filename is " " then the standard input is used
868 *
869 * Returns an I/O context or NULL in case of error
870 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000871static void *
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000872xmlGzfileOpen_real (const char *filename) {
Owen Taylor3473f882001-02-23 17:55:21 +0000873 const char *path = NULL;
874 gzFile fd;
875
876 if (!strcmp(filename, "-")) {
Daniel Veillarda9e65e82001-10-30 10:32:36 +0000877 fd = gzdopen(dup(0), "rb");
Owen Taylor3473f882001-02-23 17:55:21 +0000878 return((void *) fd);
879 }
880
Daniel Veillardf4862f02002-09-10 11:13:43 +0000881 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000882#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardf4862f02002-09-10 11:13:43 +0000883 path = &filename[17];
884#else
Owen Taylor3473f882001-02-23 17:55:21 +0000885 path = &filename[16];
Daniel Veillardf4862f02002-09-10 11:13:43 +0000886#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000887 else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000888#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardfe703322001-08-14 12:18:09 +0000889 path = &filename[8];
890#else
Owen Taylor3473f882001-02-23 17:55:21 +0000891 path = &filename[7];
Daniel Veillardfe703322001-08-14 12:18:09 +0000892#endif
893 } else
Owen Taylor3473f882001-02-23 17:55:21 +0000894 path = filename;
895
896 if (path == NULL)
897 return(NULL);
898 if (!xmlCheckFilename(path))
899 return(NULL);
900
901 fd = gzopen(path, "rb");
902 return((void *) fd);
903}
904
905/**
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000906 * xmlGzfileOpen:
907 * @filename: the URI for matching
908 *
Daniel Veillard4e9b1bc2003-06-09 10:30:33 +0000909 * Wrapper around xmlGzfileOpen if the open fais, it will
910 * try to unescape @filename
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000911 */
912static void *
913xmlGzfileOpen (const char *filename) {
914 char *unescaped;
915 void *retval;
Daniel Veillard4e9b1bc2003-06-09 10:30:33 +0000916
917 retval = xmlGzfileOpen_real(filename);
918 if (retval == NULL) {
919 unescaped = xmlURIUnescapeString(filename, 0, NULL);
920 if (unescaped != NULL) {
921 retval = xmlGzfileOpen_real(unescaped);
922 }
923 xmlFree(unescaped);
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000924 }
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000925 return retval;
926}
927
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000928#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardcacbe5d2003-01-10 16:09:51 +0000929/**
Owen Taylor3473f882001-02-23 17:55:21 +0000930 * xmlGzfileOpenW:
931 * @filename: the URI for matching
932 * @compression: the compression factor (0 - 9 included)
933 *
934 * input from compressed file open
935 * if @filename is " " then the standard input is used
936 *
937 * Returns an I/O context or NULL in case of error
938 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000939static void *
Owen Taylor3473f882001-02-23 17:55:21 +0000940xmlGzfileOpenW (const char *filename, int compression) {
941 const char *path = NULL;
942 char mode[15];
943 gzFile fd;
944
Aleksey Sanin49cc9752002-06-14 17:07:10 +0000945 snprintf(mode, sizeof(mode), "wb%d", compression);
Owen Taylor3473f882001-02-23 17:55:21 +0000946 if (!strcmp(filename, "-")) {
Daniel Veillarda9e65e82001-10-30 10:32:36 +0000947 fd = gzdopen(dup(1), mode);
Owen Taylor3473f882001-02-23 17:55:21 +0000948 return((void *) fd);
949 }
950
Daniel Veillardf4862f02002-09-10 11:13:43 +0000951 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000952#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardf4862f02002-09-10 11:13:43 +0000953 path = &filename[17];
954#else
Owen Taylor3473f882001-02-23 17:55:21 +0000955 path = &filename[16];
Daniel Veillardf4862f02002-09-10 11:13:43 +0000956#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +0000957 else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +0000958#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardfe703322001-08-14 12:18:09 +0000959 path = &filename[8];
960#else
Daniel Veillard3c2758d2001-05-31 18:43:43 +0000961 path = &filename[7];
Daniel Veillardfe703322001-08-14 12:18:09 +0000962#endif
963 } else
Owen Taylor3473f882001-02-23 17:55:21 +0000964 path = filename;
965
966 if (path == NULL)
967 return(NULL);
968
969 fd = gzopen(path, mode);
970 return((void *) fd);
971}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000972#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +0000973
974/**
975 * xmlGzfileRead:
976 * @context: the I/O context
977 * @buffer: where to drop data
978 * @len: number of bytes to write
979 *
980 * Read @len bytes to @buffer from the compressed I/O channel.
981 *
982 * Returns the number of bytes written
983 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000984static int
Owen Taylor3473f882001-02-23 17:55:21 +0000985xmlGzfileRead (void * context, char * buffer, int len) {
Daniel Veillard05d987b2003-10-08 11:54:57 +0000986 int ret;
987
988 ret = gzread((gzFile) context, &buffer[0], len);
989 if (ret < 0) xmlIOErr(0, "gzread()");
990 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +0000991}
992
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000993#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +0000994/**
995 * xmlGzfileWrite:
996 * @context: the I/O context
997 * @buffer: where to drop data
998 * @len: number of bytes to write
999 *
1000 * Write @len bytes from @buffer to the compressed I/O channel.
1001 *
1002 * Returns the number of bytes written
1003 */
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001004static int
Owen Taylor3473f882001-02-23 17:55:21 +00001005xmlGzfileWrite (void * context, const char * buffer, int len) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001006 int ret;
1007
1008 ret = gzwrite((gzFile) context, (char *) &buffer[0], len);
1009 if (ret < 0) xmlIOErr(0, "gzwrite()");
1010 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +00001011}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001012#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00001013
1014/**
1015 * xmlGzfileClose:
1016 * @context: the I/O context
1017 *
1018 * Close a compressed I/O channel
1019 */
Daniel Veillardf012a642001-07-23 19:10:52 +00001020static int
Owen Taylor3473f882001-02-23 17:55:21 +00001021xmlGzfileClose (void * context) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001022 int ret;
1023
1024 ret = (gzclose((gzFile) context) == Z_OK ) ? 0 : -1;
1025 if (ret < 0) xmlIOErr(0, "gzclose()");
1026 return(ret);
Owen Taylor3473f882001-02-23 17:55:21 +00001027}
1028#endif /* HAVE_ZLIB_H */
1029
1030#ifdef LIBXML_HTTP_ENABLED
1031/************************************************************************
1032 * *
1033 * I/O for HTTP file accesses *
1034 * *
1035 ************************************************************************/
Daniel Veillardf012a642001-07-23 19:10:52 +00001036
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001037#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardf012a642001-07-23 19:10:52 +00001038typedef struct xmlIOHTTPWriteCtxt_
1039{
1040 int compression;
1041
1042 char * uri;
1043
1044 void * doc_buff;
1045
1046} xmlIOHTTPWriteCtxt, *xmlIOHTTPWriteCtxtPtr;
1047
1048#ifdef HAVE_ZLIB_H
1049
1050#define DFLT_WBITS ( -15 )
1051#define DFLT_MEM_LVL ( 8 )
1052#define GZ_MAGIC1 ( 0x1f )
1053#define GZ_MAGIC2 ( 0x8b )
1054#define LXML_ZLIB_OS_CODE ( 0x03 )
1055#define INIT_HTTP_BUFF_SIZE ( 32768 )
1056#define DFLT_ZLIB_RATIO ( 5 )
1057
1058/*
1059** Data structure and functions to work with sending compressed data
1060** via HTTP.
1061*/
1062
1063typedef struct xmlZMemBuff_
1064{
1065 unsigned long size;
1066 unsigned long crc;
1067
1068 unsigned char * zbuff;
1069 z_stream zctrl;
1070
1071} xmlZMemBuff, *xmlZMemBuffPtr;
1072
1073/**
1074 * append_reverse_ulong
1075 * @buff: Compressed memory buffer
1076 * @data: Unsigned long to append
1077 *
1078 * Append a unsigned long in reverse byte order to the end of the
1079 * memory buffer.
1080 */
1081static void
1082append_reverse_ulong( xmlZMemBuff * buff, unsigned long data ) {
1083
1084 int idx;
1085
1086 if ( buff == NULL )
1087 return;
1088
1089 /*
1090 ** This is plagiarized from putLong in gzio.c (zlib source) where
1091 ** the number "4" is hardcoded. If zlib is ever patched to
1092 ** support 64 bit file sizes, this code would need to be patched
1093 ** as well.
1094 */
1095
1096 for ( idx = 0; idx < 4; idx++ ) {
1097 *buff->zctrl.next_out = ( data & 0xff );
1098 data >>= 8;
1099 buff->zctrl.next_out++;
1100 }
1101
1102 return;
1103}
1104
1105/**
1106 *
1107 * xmlFreeZMemBuff
1108 * @buff: The memory buffer context to clear
1109 *
1110 * Release all the resources associated with the compressed memory buffer.
1111 */
1112static void
1113xmlFreeZMemBuff( xmlZMemBuffPtr buff ) {
William M. Brack78637da2003-07-31 14:47:38 +00001114
1115#ifdef DEBUG_HTTP
Daniel Veillardf012a642001-07-23 19:10:52 +00001116 int z_err;
William M. Brack78637da2003-07-31 14:47:38 +00001117#endif
Daniel Veillardf012a642001-07-23 19:10:52 +00001118
1119 if ( buff == NULL )
1120 return;
1121
1122 xmlFree( buff->zbuff );
Daniel Veillardf012a642001-07-23 19:10:52 +00001123#ifdef DEBUG_HTTP
William M. Brack78637da2003-07-31 14:47:38 +00001124 z_err = deflateEnd( &buff->zctrl );
Daniel Veillardf012a642001-07-23 19:10:52 +00001125 if ( z_err != Z_OK )
1126 xmlGenericError( xmlGenericErrorContext,
1127 "xmlFreeZMemBuff: Error releasing zlib context: %d\n",
1128 z_err );
William M. Brack78637da2003-07-31 14:47:38 +00001129#else
1130 deflateEnd( &buff->zctrl );
William M. Brack779af002003-08-01 15:55:39 +00001131#endif
Daniel Veillardf012a642001-07-23 19:10:52 +00001132
1133 xmlFree( buff );
1134 return;
1135}
1136
1137/**
1138 * xmlCreateZMemBuff
1139 *@compression: Compression value to use
1140 *
1141 * Create a memory buffer to hold the compressed XML document. The
1142 * compressed document in memory will end up being identical to what
1143 * would be created if gzopen/gzwrite/gzclose were being used to
1144 * write the document to disk. The code for the header/trailer data to
1145 * the compression is plagiarized from the zlib source files.
1146 */
1147static void *
1148xmlCreateZMemBuff( int compression ) {
1149
1150 int z_err;
1151 int hdr_lgth;
1152 xmlZMemBuffPtr buff = NULL;
1153
1154 if ( ( compression < 1 ) || ( compression > 9 ) )
1155 return ( NULL );
1156
1157 /* Create the control and data areas */
1158
1159 buff = xmlMalloc( sizeof( xmlZMemBuff ) );
1160 if ( buff == NULL ) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001161 xmlIOErrMemory("creating buffer context");
Daniel Veillardf012a642001-07-23 19:10:52 +00001162 return ( NULL );
1163 }
1164
1165 (void)memset( buff, 0, sizeof( xmlZMemBuff ) );
1166 buff->size = INIT_HTTP_BUFF_SIZE;
1167 buff->zbuff = xmlMalloc( buff->size );
1168 if ( buff->zbuff == NULL ) {
1169 xmlFreeZMemBuff( buff );
Daniel Veillard05d987b2003-10-08 11:54:57 +00001170 xmlIOErrMemory("creating buffer");
Daniel Veillardf012a642001-07-23 19:10:52 +00001171 return ( NULL );
1172 }
1173
1174 z_err = deflateInit2( &buff->zctrl, compression, Z_DEFLATED,
1175 DFLT_WBITS, DFLT_MEM_LVL, Z_DEFAULT_STRATEGY );
1176 if ( z_err != Z_OK ) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001177 xmlChar msg[500];
Daniel Veillardf012a642001-07-23 19:10:52 +00001178 xmlFreeZMemBuff( buff );
1179 buff = NULL;
Daniel Veillard05d987b2003-10-08 11:54:57 +00001180 xmlStrPrintf(msg, 500,
1181 (const xmlChar *) "xmlCreateZMemBuff: %s %d\n",
1182 "Error initializing compression context. ZLIB error:",
1183 z_err );
1184 xmlIOErr(XML_IO_WRITE, (const char *) msg);
Daniel Veillardf012a642001-07-23 19:10:52 +00001185 return ( NULL );
1186 }
1187
1188 /* Set the header data. The CRC will be needed for the trailer */
Daniel Veillardf012a642001-07-23 19:10:52 +00001189 buff->crc = crc32( 0L, Z_NULL, 0 );
Aleksey Sanin49cc9752002-06-14 17:07:10 +00001190 hdr_lgth = snprintf( (char *)buff->zbuff, buff->size,
1191 "%c%c%c%c%c%c%c%c%c%c",
Daniel Veillardf012a642001-07-23 19:10:52 +00001192 GZ_MAGIC1, GZ_MAGIC2, Z_DEFLATED,
1193 0, 0, 0, 0, 0, 0, LXML_ZLIB_OS_CODE );
1194 buff->zctrl.next_out = buff->zbuff + hdr_lgth;
1195 buff->zctrl.avail_out = buff->size - hdr_lgth;
1196
1197 return ( buff );
1198}
1199
1200/**
1201 * xmlZMemBuffExtend
1202 * @buff: Buffer used to compress and consolidate data.
1203 * @ext_amt: Number of bytes to extend the buffer.
1204 *
1205 * Extend the internal buffer used to store the compressed data by the
1206 * specified amount.
1207 *
1208 * Returns 0 on success or -1 on failure to extend the buffer. On failure
1209 * the original buffer still exists at the original size.
1210 */
1211static int
1212xmlZMemBuffExtend( xmlZMemBuffPtr buff, size_t ext_amt ) {
1213
1214 int rc = -1;
1215 size_t new_size;
1216 size_t cur_used;
1217
1218 unsigned char * tmp_ptr = NULL;
1219
1220 if ( buff == NULL )
1221 return ( -1 );
1222
1223 else if ( ext_amt == 0 )
1224 return ( 0 );
1225
1226 cur_used = buff->zctrl.next_out - buff->zbuff;
1227 new_size = buff->size + ext_amt;
1228
1229#ifdef DEBUG_HTTP
1230 if ( cur_used > new_size )
1231 xmlGenericError( xmlGenericErrorContext,
1232 "xmlZMemBuffExtend: %s\n%s %d bytes.\n",
1233 "Buffer overwrite detected during compressed memory",
1234 "buffer extension. Overflowed by",
1235 (cur_used - new_size ) );
1236#endif
1237
1238 tmp_ptr = xmlRealloc( buff->zbuff, new_size );
1239 if ( tmp_ptr != NULL ) {
1240 rc = 0;
1241 buff->size = new_size;
1242 buff->zbuff = tmp_ptr;
1243 buff->zctrl.next_out = tmp_ptr + cur_used;
1244 buff->zctrl.avail_out = new_size - cur_used;
1245 }
1246 else {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001247 xmlChar msg[500];
1248 xmlStrPrintf(msg, 500,
1249 (const xmlChar *) "xmlZMemBuffExtend: %s %lu bytes.\n",
1250 "Allocation failure extending output buffer to",
1251 new_size );
1252 xmlIOErr(XML_IO_WRITE, (const char *) msg);
Daniel Veillardf012a642001-07-23 19:10:52 +00001253 }
1254
1255 return ( rc );
1256}
1257
1258/**
1259 * xmlZMemBuffAppend
1260 * @buff: Buffer used to compress and consolidate data
1261 * @src: Uncompressed source content to append to buffer
1262 * @len: Length of source data to append to buffer
1263 *
1264 * Compress and append data to the internal buffer. The data buffer
1265 * will be expanded if needed to store the additional data.
1266 *
1267 * Returns the number of bytes appended to the buffer or -1 on error.
1268 */
1269static int
1270xmlZMemBuffAppend( xmlZMemBuffPtr buff, const char * src, int len ) {
1271
1272 int z_err;
1273 size_t min_accept;
1274
1275 if ( ( buff == NULL ) || ( src == NULL ) )
1276 return ( -1 );
1277
1278 buff->zctrl.avail_in = len;
1279 buff->zctrl.next_in = (unsigned char *)src;
1280 while ( buff->zctrl.avail_in > 0 ) {
1281 /*
1282 ** Extend the buffer prior to deflate call if a reasonable amount
1283 ** of output buffer space is not available.
1284 */
1285 min_accept = buff->zctrl.avail_in / DFLT_ZLIB_RATIO;
1286 if ( buff->zctrl.avail_out <= min_accept ) {
1287 if ( xmlZMemBuffExtend( buff, buff->size ) == -1 )
1288 return ( -1 );
1289 }
1290
1291 z_err = deflate( &buff->zctrl, Z_NO_FLUSH );
1292 if ( z_err != Z_OK ) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001293 xmlChar msg[500];
1294 xmlStrPrintf(msg, 500,
1295 (const xmlChar *) "xmlZMemBuffAppend: %s %d %s - %d",
Daniel Veillardf012a642001-07-23 19:10:52 +00001296 "Compression error while appending",
1297 len, "bytes to buffer. ZLIB error", z_err );
Daniel Veillard05d987b2003-10-08 11:54:57 +00001298 xmlIOErr(XML_IO_WRITE, (const char *) msg);
Daniel Veillardf012a642001-07-23 19:10:52 +00001299 return ( -1 );
1300 }
1301 }
1302
1303 buff->crc = crc32( buff->crc, (unsigned char *)src, len );
1304
1305 return ( len );
1306}
1307
1308/**
1309 * xmlZMemBuffGetContent
1310 * @buff: Compressed memory content buffer
1311 * @data_ref: Pointer reference to point to compressed content
1312 *
1313 * Flushes the compression buffers, appends gzip file trailers and
1314 * returns the compressed content and length of the compressed data.
1315 * NOTE: The gzip trailer code here is plagiarized from zlib source.
1316 *
1317 * Returns the length of the compressed data or -1 on error.
1318 */
1319static int
1320xmlZMemBuffGetContent( xmlZMemBuffPtr buff, char ** data_ref ) {
1321
1322 int zlgth = -1;
1323 int z_err;
1324
1325 if ( ( buff == NULL ) || ( data_ref == NULL ) )
1326 return ( -1 );
1327
1328 /* Need to loop until compression output buffers are flushed */
1329
1330 do
1331 {
1332 z_err = deflate( &buff->zctrl, Z_FINISH );
1333 if ( z_err == Z_OK ) {
1334 /* In this case Z_OK means more buffer space needed */
1335
1336 if ( xmlZMemBuffExtend( buff, buff->size ) == -1 )
1337 return ( -1 );
1338 }
1339 }
1340 while ( z_err == Z_OK );
1341
1342 /* If the compression state is not Z_STREAM_END, some error occurred */
1343
1344 if ( z_err == Z_STREAM_END ) {
1345
1346 /* Need to append the gzip data trailer */
1347
1348 if ( buff->zctrl.avail_out < ( 2 * sizeof( unsigned long ) ) ) {
1349 if ( xmlZMemBuffExtend(buff, (2 * sizeof(unsigned long))) == -1 )
1350 return ( -1 );
1351 }
1352
1353 /*
1354 ** For whatever reason, the CRC and length data are pushed out
1355 ** in reverse byte order. So a memcpy can't be used here.
1356 */
1357
1358 append_reverse_ulong( buff, buff->crc );
1359 append_reverse_ulong( buff, buff->zctrl.total_in );
1360
1361 zlgth = buff->zctrl.next_out - buff->zbuff;
1362 *data_ref = (char *)buff->zbuff;
1363 }
1364
Daniel Veillard05d987b2003-10-08 11:54:57 +00001365 else {
1366 xmlChar msg[500];
1367 xmlStrPrintf(msg, 500,
1368 (const xmlChar *) "xmlZMemBuffGetContent: %s - %d\n",
1369 "Error flushing zlib buffers. Error code", z_err );
1370 xmlIOErr(XML_IO_WRITE, (const char *) msg);
1371 }
Daniel Veillardf012a642001-07-23 19:10:52 +00001372
1373 return ( zlgth );
1374}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001375#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001376#endif /* HAVE_ZLIB_H */
1377
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001378#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardf012a642001-07-23 19:10:52 +00001379/**
1380 * xmlFreeHTTPWriteCtxt
1381 * @ctxt: Context to cleanup
1382 *
1383 * Free allocated memory and reclaim system resources.
1384 *
1385 * No return value.
1386 */
1387static void
1388xmlFreeHTTPWriteCtxt( xmlIOHTTPWriteCtxtPtr ctxt )
1389{
1390 if ( ctxt->uri != NULL )
Daniel Veillard819d5cb2002-10-14 11:15:18 +00001391 xmlFree( ctxt->uri );
Daniel Veillardf012a642001-07-23 19:10:52 +00001392
1393 if ( ctxt->doc_buff != NULL ) {
1394
1395#ifdef HAVE_ZLIB_H
1396 if ( ctxt->compression > 0 ) {
1397 xmlFreeZMemBuff( ctxt->doc_buff );
1398 }
1399 else
1400#endif
1401 {
1402 xmlOutputBufferClose( ctxt->doc_buff );
1403 }
1404 }
1405
Daniel Veillard819d5cb2002-10-14 11:15:18 +00001406 xmlFree( ctxt );
Daniel Veillardf012a642001-07-23 19:10:52 +00001407 return;
1408}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001409#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001410
1411
Owen Taylor3473f882001-02-23 17:55:21 +00001412/**
1413 * xmlIOHTTPMatch:
1414 * @filename: the URI for matching
1415 *
1416 * check if the URI matches an HTTP one
1417 *
1418 * Returns 1 if matches, 0 otherwise
1419 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001420int
Owen Taylor3473f882001-02-23 17:55:21 +00001421xmlIOHTTPMatch (const char *filename) {
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001422 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "http://", 7))
Owen Taylor3473f882001-02-23 17:55:21 +00001423 return(1);
1424 return(0);
1425}
1426
1427/**
1428 * xmlIOHTTPOpen:
1429 * @filename: the URI for matching
1430 *
1431 * open an HTTP I/O channel
1432 *
1433 * Returns an I/O context or NULL in case of error
1434 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001435void *
Owen Taylor3473f882001-02-23 17:55:21 +00001436xmlIOHTTPOpen (const char *filename) {
1437 return(xmlNanoHTTPOpen(filename, NULL));
1438}
1439
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001440#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00001441/**
Daniel Veillarda9b66d02002-12-11 14:23:49 +00001442 * xmlIOHTTPOpenW:
Daniel Veillardf012a642001-07-23 19:10:52 +00001443 * @post_uri: The destination URI for the document
1444 * @compression: The compression desired for the document.
1445 *
1446 * Open a temporary buffer to collect the document for a subsequent HTTP POST
1447 * request. Non-static as is called from the output buffer creation routine.
1448 *
1449 * Returns an I/O context or NULL in case of error.
1450 */
1451
1452void *
Daniel Veillard572577e2002-01-18 16:23:55 +00001453xmlIOHTTPOpenW(const char *post_uri, int compression)
1454{
Daniel Veillardf012a642001-07-23 19:10:52 +00001455
Daniel Veillard572577e2002-01-18 16:23:55 +00001456 xmlIOHTTPWriteCtxtPtr ctxt = NULL;
Daniel Veillardf012a642001-07-23 19:10:52 +00001457
Daniel Veillard572577e2002-01-18 16:23:55 +00001458 if (post_uri == NULL)
1459 return (NULL);
Daniel Veillardf012a642001-07-23 19:10:52 +00001460
Daniel Veillard572577e2002-01-18 16:23:55 +00001461 ctxt = xmlMalloc(sizeof(xmlIOHTTPWriteCtxt));
1462 if (ctxt == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001463 xmlIOErrMemory("creating HTTP output context");
Daniel Veillard572577e2002-01-18 16:23:55 +00001464 return (NULL);
Daniel Veillardf012a642001-07-23 19:10:52 +00001465 }
1466
Daniel Veillard572577e2002-01-18 16:23:55 +00001467 (void) memset(ctxt, 0, sizeof(xmlIOHTTPWriteCtxt));
Daniel Veillardf012a642001-07-23 19:10:52 +00001468
Daniel Veillard572577e2002-01-18 16:23:55 +00001469 ctxt->uri = (char *) xmlStrdup((const xmlChar *)post_uri);
1470 if (ctxt->uri == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001471 xmlIOErrMemory("copying URI");
Daniel Veillard572577e2002-01-18 16:23:55 +00001472 xmlFreeHTTPWriteCtxt(ctxt);
1473 return (NULL);
Daniel Veillardf012a642001-07-23 19:10:52 +00001474 }
1475
1476 /*
Daniel Veillard572577e2002-01-18 16:23:55 +00001477 * ** Since the document length is required for an HTTP post,
1478 * ** need to put the document into a buffer. A memory buffer
1479 * ** is being used to avoid pushing the data to disk and back.
1480 */
Daniel Veillardf012a642001-07-23 19:10:52 +00001481
1482#ifdef HAVE_ZLIB_H
Daniel Veillard572577e2002-01-18 16:23:55 +00001483 if ((compression > 0) && (compression <= 9)) {
1484
1485 ctxt->compression = compression;
1486 ctxt->doc_buff = xmlCreateZMemBuff(compression);
1487 } else
Daniel Veillardf012a642001-07-23 19:10:52 +00001488#endif
1489 {
Daniel Veillard572577e2002-01-18 16:23:55 +00001490 /* Any character conversions should have been done before this */
Daniel Veillardf012a642001-07-23 19:10:52 +00001491
Daniel Veillard572577e2002-01-18 16:23:55 +00001492 ctxt->doc_buff = xmlAllocOutputBuffer(NULL);
Daniel Veillardf012a642001-07-23 19:10:52 +00001493 }
1494
Daniel Veillard572577e2002-01-18 16:23:55 +00001495 if (ctxt->doc_buff == NULL) {
1496 xmlFreeHTTPWriteCtxt(ctxt);
1497 ctxt = NULL;
Daniel Veillardf012a642001-07-23 19:10:52 +00001498 }
1499
Daniel Veillard572577e2002-01-18 16:23:55 +00001500 return (ctxt);
Daniel Veillardf012a642001-07-23 19:10:52 +00001501}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001502#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001503
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001504#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardf012a642001-07-23 19:10:52 +00001505/**
1506 * xmlIOHTTPDfltOpenW
1507 * @post_uri: The destination URI for this document.
1508 *
1509 * Calls xmlIOHTTPOpenW with no compression to set up for a subsequent
1510 * HTTP post command. This function should generally not be used as
1511 * the open callback is short circuited in xmlOutputBufferCreateFile.
1512 *
1513 * Returns a pointer to the new IO context.
1514 */
1515static void *
1516xmlIOHTTPDfltOpenW( const char * post_uri ) {
1517 return ( xmlIOHTTPOpenW( post_uri, 0 ) );
1518}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001519#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001520
1521/**
Owen Taylor3473f882001-02-23 17:55:21 +00001522 * xmlIOHTTPRead:
1523 * @context: the I/O context
1524 * @buffer: where to drop data
1525 * @len: number of bytes to write
1526 *
1527 * Read @len bytes to @buffer from the I/O channel.
1528 *
1529 * Returns the number of bytes written
1530 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001531int
Owen Taylor3473f882001-02-23 17:55:21 +00001532xmlIOHTTPRead(void * context, char * buffer, int len) {
1533 return(xmlNanoHTTPRead(context, &buffer[0], len));
1534}
1535
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001536#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00001537/**
Daniel Veillardf012a642001-07-23 19:10:52 +00001538 * xmlIOHTTPWrite
1539 * @context: previously opened writing context
1540 * @buffer: data to output to temporary buffer
1541 * @len: bytes to output
1542 *
1543 * Collect data from memory buffer into a temporary file for later
1544 * processing.
1545 *
1546 * Returns number of bytes written.
1547 */
1548
1549static int
1550xmlIOHTTPWrite( void * context, const char * buffer, int len ) {
1551
1552 xmlIOHTTPWriteCtxtPtr ctxt = context;
1553
1554 if ( ( ctxt == NULL ) || ( ctxt->doc_buff == NULL ) || ( buffer == NULL ) )
1555 return ( -1 );
1556
1557 if ( len > 0 ) {
1558
1559 /* Use gzwrite or fwrite as previously setup in the open call */
1560
1561#ifdef HAVE_ZLIB_H
1562 if ( ctxt->compression > 0 )
1563 len = xmlZMemBuffAppend( ctxt->doc_buff, buffer, len );
1564
1565 else
1566#endif
1567 len = xmlOutputBufferWrite( ctxt->doc_buff, len, buffer );
1568
1569 if ( len < 0 ) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001570 xmlChar msg[500];
1571 xmlStrPrintf(msg, 500,
1572 (const xmlChar *) "xmlIOHTTPWrite: %s\n%s '%s'.\n",
Daniel Veillardf012a642001-07-23 19:10:52 +00001573 "Error appending to internal buffer.",
1574 "Error sending document to URI",
1575 ctxt->uri );
Daniel Veillard05d987b2003-10-08 11:54:57 +00001576 xmlIOErr(XML_IO_WRITE, (const char *) msg);
Daniel Veillardf012a642001-07-23 19:10:52 +00001577 }
1578 }
1579
1580 return ( len );
1581}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001582#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001583
1584
1585/**
Owen Taylor3473f882001-02-23 17:55:21 +00001586 * xmlIOHTTPClose:
1587 * @context: the I/O context
1588 *
1589 * Close an HTTP I/O channel
Daniel Veillarda9b66d02002-12-11 14:23:49 +00001590 *
1591 * Returns 0
Owen Taylor3473f882001-02-23 17:55:21 +00001592 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001593int
Owen Taylor3473f882001-02-23 17:55:21 +00001594xmlIOHTTPClose (void * context) {
1595 xmlNanoHTTPClose(context);
Daniel Veillardf012a642001-07-23 19:10:52 +00001596 return 0;
Owen Taylor3473f882001-02-23 17:55:21 +00001597}
Daniel Veillardf012a642001-07-23 19:10:52 +00001598
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001599#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillardf012a642001-07-23 19:10:52 +00001600/**
1601 * xmlIOHTTCloseWrite
1602 * @context: The I/O context
1603 * @http_mthd: The HTTP method to be used when sending the data
1604 *
1605 * Close the transmit HTTP I/O channel and actually send the data.
1606 */
1607static int
1608xmlIOHTTPCloseWrite( void * context, const char * http_mthd ) {
1609
1610 int close_rc = -1;
1611 int http_rtn = 0;
1612 int content_lgth = 0;
1613 xmlIOHTTPWriteCtxtPtr ctxt = context;
1614
1615 char * http_content = NULL;
1616 char * content_encoding = NULL;
1617 char * content_type = (char *) "text/xml";
1618 void * http_ctxt = NULL;
1619
1620 if ( ( ctxt == NULL ) || ( http_mthd == NULL ) )
1621 return ( -1 );
1622
1623 /* Retrieve the content from the appropriate buffer */
1624
1625#ifdef HAVE_ZLIB_H
1626
1627 if ( ctxt->compression > 0 ) {
1628 content_lgth = xmlZMemBuffGetContent( ctxt->doc_buff, &http_content );
1629 content_encoding = (char *) "Content-Encoding: gzip";
1630 }
1631 else
1632#endif
1633 {
1634 /* Pull the data out of the memory output buffer */
1635
1636 xmlOutputBufferPtr dctxt = ctxt->doc_buff;
1637 http_content = (char *)dctxt->buffer->content;
1638 content_lgth = dctxt->buffer->use;
1639 }
1640
1641 if ( http_content == NULL ) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001642 xmlChar msg[500];
1643 xmlStrPrintf(msg, 500,
1644 (const xmlChar *) "xmlIOHTTPCloseWrite: %s '%s' %s '%s'.\n",
1645 "Error retrieving content.\nUnable to",
1646 http_mthd, "data to URI", ctxt->uri );
1647 xmlIOErr(XML_IO_WRITE, (const char *) msg);
Daniel Veillardf012a642001-07-23 19:10:52 +00001648 }
1649
1650 else {
1651
1652 http_ctxt = xmlNanoHTTPMethod( ctxt->uri, http_mthd, http_content,
1653 &content_type, content_encoding,
1654 content_lgth );
1655
1656 if ( http_ctxt != NULL ) {
1657#ifdef DEBUG_HTTP
1658 /* If testing/debugging - dump reply with request content */
1659
1660 FILE * tst_file = NULL;
1661 char buffer[ 4096 ];
1662 char * dump_name = NULL;
1663 int avail;
1664
1665 xmlGenericError( xmlGenericErrorContext,
1666 "xmlNanoHTTPCloseWrite: HTTP %s to\n%s returned %d.\n",
1667 http_mthd, ctxt->uri,
1668 xmlNanoHTTPReturnCode( http_ctxt ) );
1669
1670 /*
1671 ** Since either content or reply may be gzipped,
1672 ** dump them to separate files instead of the
1673 ** standard error context.
1674 */
1675
1676 dump_name = tempnam( NULL, "lxml" );
1677 if ( dump_name != NULL ) {
Aleksey Sanin49cc9752002-06-14 17:07:10 +00001678 (void)snprintf( buffer, sizeof(buffer), "%s.content", dump_name );
Daniel Veillardf012a642001-07-23 19:10:52 +00001679
Daniel Veillardcbbd78d2003-07-20 15:21:30 +00001680 tst_file = fopen( buffer, "wb" );
Daniel Veillardf012a642001-07-23 19:10:52 +00001681 if ( tst_file != NULL ) {
1682 xmlGenericError( xmlGenericErrorContext,
1683 "Transmitted content saved in file: %s\n", buffer );
1684
1685 fwrite( http_content, sizeof( char ),
1686 content_lgth, tst_file );
1687 fclose( tst_file );
1688 }
1689
Aleksey Sanin49cc9752002-06-14 17:07:10 +00001690 (void)snprintf( buffer, sizeof(buffer), "%s.reply", dump_name );
Daniel Veillardcbbd78d2003-07-20 15:21:30 +00001691 tst_file = fopen( buffer, "wb" );
Daniel Veillardf012a642001-07-23 19:10:52 +00001692 if ( tst_file != NULL ) {
1693 xmlGenericError( xmlGenericErrorContext,
1694 "Reply content saved in file: %s\n", buffer );
1695
1696
1697 while ( (avail = xmlNanoHTTPRead( http_ctxt,
1698 buffer, sizeof( buffer ) )) > 0 ) {
1699
1700 fwrite( buffer, sizeof( char ), avail, tst_file );
1701 }
1702
1703 fclose( tst_file );
1704 }
1705
1706 free( dump_name );
1707 }
1708#endif /* DEBUG_HTTP */
1709
1710 http_rtn = xmlNanoHTTPReturnCode( http_ctxt );
1711 if ( ( http_rtn >= 200 ) && ( http_rtn < 300 ) )
1712 close_rc = 0;
Daniel Veillard05d987b2003-10-08 11:54:57 +00001713 else {
1714 xmlChar msg[500];
1715 xmlStrPrintf(msg, 500,
1716 (const xmlChar *) "xmlIOHTTPCloseWrite: HTTP '%s' of %d %s\n'%s' %s %d\n",
Daniel Veillardf012a642001-07-23 19:10:52 +00001717 http_mthd, content_lgth,
1718 "bytes to URI", ctxt->uri,
1719 "failed. HTTP return code:", http_rtn );
Daniel Veillard05d987b2003-10-08 11:54:57 +00001720 xmlIOErr(XML_IO_WRITE, (const char *) msg);
1721 }
Daniel Veillardf012a642001-07-23 19:10:52 +00001722
1723 xmlNanoHTTPClose( http_ctxt );
1724 xmlFree( content_type );
1725 }
1726 }
1727
1728 /* Final cleanups */
1729
1730 xmlFreeHTTPWriteCtxt( ctxt );
1731
1732 return ( close_rc );
1733}
1734
1735/**
1736 * xmlIOHTTPClosePut
1737 *
1738 * @context: The I/O context
1739 *
1740 * Close the transmit HTTP I/O channel and actually send data using a PUT
1741 * HTTP method.
1742 */
1743static int
1744xmlIOHTTPClosePut( void * ctxt ) {
1745 return ( xmlIOHTTPCloseWrite( ctxt, "PUT" ) );
1746}
1747
1748
1749/**
1750 * xmlIOHTTPClosePost
1751 *
1752 * @context: The I/O context
1753 *
1754 * Close the transmit HTTP I/O channel and actually send data using a POST
1755 * HTTP method.
1756 */
1757static int
1758xmlIOHTTPClosePost( void * ctxt ) {
1759 return ( xmlIOHTTPCloseWrite( ctxt, "POST" ) );
1760}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001761#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001762
Owen Taylor3473f882001-02-23 17:55:21 +00001763#endif /* LIBXML_HTTP_ENABLED */
1764
1765#ifdef LIBXML_FTP_ENABLED
1766/************************************************************************
1767 * *
1768 * I/O for FTP file accesses *
1769 * *
1770 ************************************************************************/
1771/**
1772 * xmlIOFTPMatch:
1773 * @filename: the URI for matching
1774 *
1775 * check if the URI matches an FTP one
1776 *
1777 * Returns 1 if matches, 0 otherwise
1778 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001779int
Owen Taylor3473f882001-02-23 17:55:21 +00001780xmlIOFTPMatch (const char *filename) {
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001781 if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "ftp://", 6))
Owen Taylor3473f882001-02-23 17:55:21 +00001782 return(1);
1783 return(0);
1784}
1785
1786/**
1787 * xmlIOFTPOpen:
1788 * @filename: the URI for matching
1789 *
1790 * open an FTP I/O channel
1791 *
1792 * Returns an I/O context or NULL in case of error
1793 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001794void *
Owen Taylor3473f882001-02-23 17:55:21 +00001795xmlIOFTPOpen (const char *filename) {
1796 return(xmlNanoFTPOpen(filename));
1797}
1798
1799/**
1800 * xmlIOFTPRead:
1801 * @context: the I/O context
1802 * @buffer: where to drop data
1803 * @len: number of bytes to write
1804 *
1805 * Read @len bytes to @buffer from the I/O channel.
1806 *
1807 * Returns the number of bytes written
1808 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001809int
Owen Taylor3473f882001-02-23 17:55:21 +00001810xmlIOFTPRead(void * context, char * buffer, int len) {
1811 return(xmlNanoFTPRead(context, &buffer[0], len));
1812}
1813
1814/**
1815 * xmlIOFTPClose:
1816 * @context: the I/O context
1817 *
1818 * Close an FTP I/O channel
Daniel Veillarda9b66d02002-12-11 14:23:49 +00001819 *
1820 * Returns 0
Owen Taylor3473f882001-02-23 17:55:21 +00001821 */
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00001822int
Owen Taylor3473f882001-02-23 17:55:21 +00001823xmlIOFTPClose (void * context) {
Daniel Veillardf012a642001-07-23 19:10:52 +00001824 return ( xmlNanoFTPClose(context) );
Owen Taylor3473f882001-02-23 17:55:21 +00001825}
1826#endif /* LIBXML_FTP_ENABLED */
1827
1828
1829/**
1830 * xmlRegisterInputCallbacks:
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001831 * @matchFunc: the xmlInputMatchCallback
1832 * @openFunc: the xmlInputOpenCallback
1833 * @readFunc: the xmlInputReadCallback
1834 * @closeFunc: the xmlInputCloseCallback
Owen Taylor3473f882001-02-23 17:55:21 +00001835 *
1836 * Register a new set of I/O callback for handling parser input.
1837 *
1838 * Returns the registered handler number or -1 in case of error
1839 */
1840int
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001841xmlRegisterInputCallbacks(xmlInputMatchCallback matchFunc,
1842 xmlInputOpenCallback openFunc, xmlInputReadCallback readFunc,
1843 xmlInputCloseCallback closeFunc) {
Owen Taylor3473f882001-02-23 17:55:21 +00001844 if (xmlInputCallbackNr >= MAX_INPUT_CALLBACK) {
1845 return(-1);
1846 }
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001847 xmlInputCallbackTable[xmlInputCallbackNr].matchcallback = matchFunc;
1848 xmlInputCallbackTable[xmlInputCallbackNr].opencallback = openFunc;
1849 xmlInputCallbackTable[xmlInputCallbackNr].readcallback = readFunc;
1850 xmlInputCallbackTable[xmlInputCallbackNr].closecallback = closeFunc;
Daniel Veillard9ec26532003-09-23 07:43:19 +00001851 xmlInputCallbackInitialized = 1;
Owen Taylor3473f882001-02-23 17:55:21 +00001852 return(xmlInputCallbackNr++);
1853}
1854
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001855#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00001856/**
1857 * xmlRegisterOutputCallbacks:
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001858 * @matchFunc: the xmlOutputMatchCallback
1859 * @openFunc: the xmlOutputOpenCallback
1860 * @writeFunc: the xmlOutputWriteCallback
1861 * @closeFunc: the xmlOutputCloseCallback
Owen Taylor3473f882001-02-23 17:55:21 +00001862 *
1863 * Register a new set of I/O callback for handling output.
1864 *
1865 * Returns the registered handler number or -1 in case of error
1866 */
1867int
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001868xmlRegisterOutputCallbacks(xmlOutputMatchCallback matchFunc,
1869 xmlOutputOpenCallback openFunc, xmlOutputWriteCallback writeFunc,
1870 xmlOutputCloseCallback closeFunc) {
Owen Taylor3473f882001-02-23 17:55:21 +00001871 if (xmlOutputCallbackNr >= MAX_INPUT_CALLBACK) {
1872 return(-1);
1873 }
Daniel Veillard56a4cb82001-03-24 17:00:36 +00001874 xmlOutputCallbackTable[xmlOutputCallbackNr].matchcallback = matchFunc;
1875 xmlOutputCallbackTable[xmlOutputCallbackNr].opencallback = openFunc;
1876 xmlOutputCallbackTable[xmlOutputCallbackNr].writecallback = writeFunc;
1877 xmlOutputCallbackTable[xmlOutputCallbackNr].closecallback = closeFunc;
Daniel Veillard9ec26532003-09-23 07:43:19 +00001878 xmlOutputCallbackInitialized = 1;
Owen Taylor3473f882001-02-23 17:55:21 +00001879 return(xmlOutputCallbackNr++);
1880}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001881#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00001882
1883/**
1884 * xmlRegisterDefaultInputCallbacks:
1885 *
1886 * Registers the default compiled-in I/O handlers.
1887 */
1888void
Owen Taylor3473f882001-02-23 17:55:21 +00001889xmlRegisterDefaultInputCallbacks
Owen Taylor3473f882001-02-23 17:55:21 +00001890(void) {
1891 if (xmlInputCallbackInitialized)
1892 return;
1893
1894 xmlRegisterInputCallbacks(xmlFileMatch, xmlFileOpen,
1895 xmlFileRead, xmlFileClose);
1896#ifdef HAVE_ZLIB_H
1897 xmlRegisterInputCallbacks(xmlGzfileMatch, xmlGzfileOpen,
1898 xmlGzfileRead, xmlGzfileClose);
1899#endif /* HAVE_ZLIB_H */
1900
1901#ifdef LIBXML_HTTP_ENABLED
1902 xmlRegisterInputCallbacks(xmlIOHTTPMatch, xmlIOHTTPOpen,
1903 xmlIOHTTPRead, xmlIOHTTPClose);
1904#endif /* LIBXML_HTTP_ENABLED */
1905
1906#ifdef LIBXML_FTP_ENABLED
1907 xmlRegisterInputCallbacks(xmlIOFTPMatch, xmlIOFTPOpen,
1908 xmlIOFTPRead, xmlIOFTPClose);
1909#endif /* LIBXML_FTP_ENABLED */
1910 xmlInputCallbackInitialized = 1;
1911}
1912
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001913#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00001914/**
1915 * xmlRegisterDefaultOutputCallbacks:
1916 *
1917 * Registers the default compiled-in I/O handlers.
1918 */
1919void
Owen Taylor3473f882001-02-23 17:55:21 +00001920xmlRegisterDefaultOutputCallbacks
Owen Taylor3473f882001-02-23 17:55:21 +00001921(void) {
1922 if (xmlOutputCallbackInitialized)
1923 return;
1924
1925 xmlRegisterOutputCallbacks(xmlFileMatch, xmlFileOpenW,
1926 xmlFileWrite, xmlFileClose);
Daniel Veillardf012a642001-07-23 19:10:52 +00001927
1928#ifdef LIBXML_HTTP_ENABLED
1929 xmlRegisterOutputCallbacks(xmlIOHTTPMatch, xmlIOHTTPDfltOpenW,
1930 xmlIOHTTPWrite, xmlIOHTTPClosePut);
1931#endif
1932
Owen Taylor3473f882001-02-23 17:55:21 +00001933/*********************************
1934 No way a-priori to distinguish between gzipped files from
1935 uncompressed ones except opening if existing then closing
1936 and saving with same compression ratio ... a pain.
1937
1938#ifdef HAVE_ZLIB_H
1939 xmlRegisterOutputCallbacks(xmlGzfileMatch, xmlGzfileOpen,
1940 xmlGzfileWrite, xmlGzfileClose);
1941#endif
Owen Taylor3473f882001-02-23 17:55:21 +00001942
1943 Nor FTP PUT ....
1944#ifdef LIBXML_FTP_ENABLED
1945 xmlRegisterOutputCallbacks(xmlIOFTPMatch, xmlIOFTPOpen,
1946 xmlIOFTPWrite, xmlIOFTPClose);
1947#endif
1948 **********************************/
1949 xmlOutputCallbackInitialized = 1;
1950}
1951
Daniel Veillardf012a642001-07-23 19:10:52 +00001952#ifdef LIBXML_HTTP_ENABLED
1953/**
Daniel Veillarda9b66d02002-12-11 14:23:49 +00001954 * xmlRegisterHTTPPostCallbacks:
Daniel Veillardf012a642001-07-23 19:10:52 +00001955 *
1956 * By default, libxml submits HTTP output requests using the "PUT" method.
1957 * Calling this method changes the HTTP output method to use the "POST"
1958 * method instead.
1959 *
1960 */
1961void
1962xmlRegisterHTTPPostCallbacks( void ) {
1963
1964 /* Register defaults if not done previously */
1965
1966 if ( xmlOutputCallbackInitialized == 0 )
1967 xmlRegisterDefaultOutputCallbacks( );
1968
1969 xmlRegisterOutputCallbacks(xmlIOHTTPMatch, xmlIOHTTPDfltOpenW,
1970 xmlIOHTTPWrite, xmlIOHTTPClosePost);
1971 return;
1972}
1973#endif
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00001974#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillardf012a642001-07-23 19:10:52 +00001975
Owen Taylor3473f882001-02-23 17:55:21 +00001976/**
1977 * xmlAllocParserInputBuffer:
1978 * @enc: the charset encoding if known
1979 *
1980 * Create a buffered parser input for progressive parsing
1981 *
1982 * Returns the new parser input or NULL
1983 */
1984xmlParserInputBufferPtr
1985xmlAllocParserInputBuffer(xmlCharEncoding enc) {
1986 xmlParserInputBufferPtr ret;
1987
1988 ret = (xmlParserInputBufferPtr) xmlMalloc(sizeof(xmlParserInputBuffer));
1989 if (ret == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00001990 xmlIOErrMemory("creating input buffer");
Owen Taylor3473f882001-02-23 17:55:21 +00001991 return(NULL);
1992 }
1993 memset(ret, 0, (size_t) sizeof(xmlParserInputBuffer));
Daniel Veillard6155d8a2003-08-19 15:01:28 +00001994 ret->buffer = xmlBufferCreateSize(2 * xmlDefaultBufferSize);
Owen Taylor3473f882001-02-23 17:55:21 +00001995 if (ret->buffer == NULL) {
1996 xmlFree(ret);
1997 return(NULL);
1998 }
1999 ret->buffer->alloc = XML_BUFFER_ALLOC_DOUBLEIT;
2000 ret->encoder = xmlGetCharEncodingHandler(enc);
2001 if (ret->encoder != NULL)
Daniel Veillard6155d8a2003-08-19 15:01:28 +00002002 ret->raw = xmlBufferCreateSize(2 * xmlDefaultBufferSize);
Owen Taylor3473f882001-02-23 17:55:21 +00002003 else
2004 ret->raw = NULL;
2005 ret->readcallback = NULL;
2006 ret->closecallback = NULL;
2007 ret->context = NULL;
William M. Brackc07329e2003-09-08 01:57:30 +00002008 ret->compressed = -1;
Daniel Veillard36711902004-02-11 13:25:26 +00002009 ret->rawconsumed = 0;
Owen Taylor3473f882001-02-23 17:55:21 +00002010
2011 return(ret);
2012}
2013
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002014#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002015/**
2016 * xmlAllocOutputBuffer:
2017 * @encoder: the encoding converter or NULL
2018 *
2019 * Create a buffered parser output
2020 *
2021 * Returns the new parser output or NULL
2022 */
2023xmlOutputBufferPtr
2024xmlAllocOutputBuffer(xmlCharEncodingHandlerPtr encoder) {
2025 xmlOutputBufferPtr ret;
2026
2027 ret = (xmlOutputBufferPtr) xmlMalloc(sizeof(xmlOutputBuffer));
2028 if (ret == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002029 xmlIOErrMemory("creating output buffer");
Owen Taylor3473f882001-02-23 17:55:21 +00002030 return(NULL);
2031 }
2032 memset(ret, 0, (size_t) sizeof(xmlOutputBuffer));
2033 ret->buffer = xmlBufferCreate();
2034 if (ret->buffer == NULL) {
2035 xmlFree(ret);
2036 return(NULL);
2037 }
2038 ret->buffer->alloc = XML_BUFFER_ALLOC_DOUBLEIT;
2039 ret->encoder = encoder;
2040 if (encoder != NULL) {
2041 ret->conv = xmlBufferCreateSize(4000);
2042 /*
2043 * This call is designed to initiate the encoder state
2044 */
2045 xmlCharEncOutFunc(encoder, ret->conv, NULL);
2046 } else
2047 ret->conv = NULL;
2048 ret->writecallback = NULL;
2049 ret->closecallback = NULL;
2050 ret->context = NULL;
2051 ret->written = 0;
2052
2053 return(ret);
2054}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002055#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002056
2057/**
2058 * xmlFreeParserInputBuffer:
2059 * @in: a buffered parser input
2060 *
2061 * Free up the memory used by a buffered parser input
2062 */
2063void
2064xmlFreeParserInputBuffer(xmlParserInputBufferPtr in) {
Daniel Veillard8d8bf2c2003-09-17 19:36:25 +00002065 if (in == NULL) return;
2066
Owen Taylor3473f882001-02-23 17:55:21 +00002067 if (in->raw) {
2068 xmlBufferFree(in->raw);
2069 in->raw = NULL;
2070 }
2071 if (in->encoder != NULL) {
2072 xmlCharEncCloseFunc(in->encoder);
2073 }
2074 if (in->closecallback != NULL) {
2075 in->closecallback(in->context);
2076 }
2077 if (in->buffer != NULL) {
2078 xmlBufferFree(in->buffer);
2079 in->buffer = NULL;
2080 }
2081
Owen Taylor3473f882001-02-23 17:55:21 +00002082 xmlFree(in);
2083}
2084
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002085#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002086/**
2087 * xmlOutputBufferClose:
2088 * @out: a buffered output
2089 *
2090 * flushes and close the output I/O channel
2091 * and free up all the associated resources
2092 *
2093 * Returns the number of byte written or -1 in case of error.
2094 */
2095int
Daniel Veillard828ce832003-10-08 19:19:10 +00002096xmlOutputBufferClose(xmlOutputBufferPtr out)
2097{
Owen Taylor3473f882001-02-23 17:55:21 +00002098 int written;
Daniel Veillardf012a642001-07-23 19:10:52 +00002099 int err_rc = 0;
Owen Taylor3473f882001-02-23 17:55:21 +00002100
2101 if (out == NULL)
Daniel Veillard828ce832003-10-08 19:19:10 +00002102 return (-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002103 if (out->writecallback != NULL)
Daniel Veillard828ce832003-10-08 19:19:10 +00002104 xmlOutputBufferFlush(out);
Owen Taylor3473f882001-02-23 17:55:21 +00002105 if (out->closecallback != NULL) {
Daniel Veillard828ce832003-10-08 19:19:10 +00002106 err_rc = out->closecallback(out->context);
Owen Taylor3473f882001-02-23 17:55:21 +00002107 }
2108 written = out->written;
2109 if (out->conv) {
2110 xmlBufferFree(out->conv);
Daniel Veillard828ce832003-10-08 19:19:10 +00002111 out->conv = NULL;
Owen Taylor3473f882001-02-23 17:55:21 +00002112 }
2113 if (out->encoder != NULL) {
2114 xmlCharEncCloseFunc(out->encoder);
2115 }
2116 if (out->buffer != NULL) {
2117 xmlBufferFree(out->buffer);
Daniel Veillard828ce832003-10-08 19:19:10 +00002118 out->buffer = NULL;
Owen Taylor3473f882001-02-23 17:55:21 +00002119 }
2120
Daniel Veillard828ce832003-10-08 19:19:10 +00002121 if (out->error)
2122 err_rc = -1;
Owen Taylor3473f882001-02-23 17:55:21 +00002123 xmlFree(out);
Daniel Veillard828ce832003-10-08 19:19:10 +00002124 return ((err_rc == 0) ? written : err_rc);
Owen Taylor3473f882001-02-23 17:55:21 +00002125}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002126#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002127
2128/**
2129 * xmlParserInputBufferCreateFilename:
2130 * @URI: a C string containing the URI or filename
2131 * @enc: the charset encoding if known
2132 *
2133 * Create a buffered parser input for the progressive parsing of a file
2134 * If filename is "-' then we use stdin as the input.
2135 * Automatic support for ZLIB/Compress compressed document is provided
2136 * by default if found at compile-time.
2137 * Do an encoding check if enc == XML_CHAR_ENCODING_NONE
2138 *
2139 * Returns the new parser input or NULL
2140 */
2141xmlParserInputBufferPtr
Daniel Veillard3e59fc52003-04-18 12:34:58 +00002142xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) {
Owen Taylor3473f882001-02-23 17:55:21 +00002143 xmlParserInputBufferPtr ret;
Daniel Veillard388236f2001-07-08 18:35:48 +00002144 int i = 0;
Owen Taylor3473f882001-02-23 17:55:21 +00002145 void *context = NULL;
2146
2147 if (xmlInputCallbackInitialized == 0)
2148 xmlRegisterDefaultInputCallbacks();
2149
2150 if (URI == NULL) return(NULL);
2151
2152 /*
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002153 * Try to find one of the input accept method accepting that scheme
Owen Taylor3473f882001-02-23 17:55:21 +00002154 * Go in reverse to give precedence to user defined handlers.
Daniel Veillard388236f2001-07-08 18:35:48 +00002155 */
2156 if (context == NULL) {
2157 for (i = xmlInputCallbackNr - 1;i >= 0;i--) {
2158 if ((xmlInputCallbackTable[i].matchcallback != NULL) &&
2159 (xmlInputCallbackTable[i].matchcallback(URI) != 0)) {
Igor Zlatkovic5f9fada2003-02-19 14:51:00 +00002160 context = xmlInputCallbackTable[i].opencallback(URI);
Daniel Veillard847332a2003-10-18 11:29:40 +00002161 if (context != NULL) {
Daniel Veillard388236f2001-07-08 18:35:48 +00002162 break;
Daniel Veillard847332a2003-10-18 11:29:40 +00002163 }
Daniel Veillard388236f2001-07-08 18:35:48 +00002164 }
Owen Taylor3473f882001-02-23 17:55:21 +00002165 }
2166 }
2167 if (context == NULL) {
2168 return(NULL);
2169 }
2170
2171 /*
2172 * Allocate the Input buffer front-end.
2173 */
2174 ret = xmlAllocParserInputBuffer(enc);
2175 if (ret != NULL) {
2176 ret->context = context;
2177 ret->readcallback = xmlInputCallbackTable[i].readcallback;
2178 ret->closecallback = xmlInputCallbackTable[i].closecallback;
William M. Brackc07329e2003-09-08 01:57:30 +00002179#ifdef HAVE_ZLIB_H
William M. Brackc5cbf992003-10-29 22:15:13 +00002180 if ((xmlInputCallbackTable[i].opencallback == xmlGzfileOpen) &&
2181 (strcmp(URI, "-") != 0)) {
William M. Brackc07329e2003-09-08 01:57:30 +00002182 if (((z_stream *)context)->avail_in > 4) {
2183 char *cptr, buff4[4];
Daniel Veillard07cb8222003-09-10 10:51:05 +00002184 cptr = (char *) ((z_stream *)context)->next_in;
William M. Brackc07329e2003-09-08 01:57:30 +00002185 if (gzread(context, buff4, 4) == 4) {
2186 if (strncmp(buff4, cptr, 4) == 0)
2187 ret->compressed = 0;
2188 else
2189 ret->compressed = 1;
2190 gzrewind(context);
2191 }
2192 }
2193 }
2194#endif
Owen Taylor3473f882001-02-23 17:55:21 +00002195 }
2196 return(ret);
2197}
2198
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002199#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002200/**
2201 * xmlOutputBufferCreateFilename:
2202 * @URI: a C string containing the URI or filename
2203 * @encoder: the encoding converter or NULL
2204 * @compression: the compression ration (0 none, 9 max).
2205 *
2206 * Create a buffered output for the progressive saving of a file
2207 * If filename is "-' then we use stdout as the output.
2208 * Automatic support for ZLIB/Compress compressed document is provided
2209 * by default if found at compile-time.
2210 * TODO: currently if compression is set, the library only support
2211 * writing to a local file.
2212 *
2213 * Returns the new output or NULL
2214 */
2215xmlOutputBufferPtr
2216xmlOutputBufferCreateFilename(const char *URI,
2217 xmlCharEncodingHandlerPtr encoder,
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002218 int compression ATTRIBUTE_UNUSED) {
Owen Taylor3473f882001-02-23 17:55:21 +00002219 xmlOutputBufferPtr ret;
Daniel Veillard966a31e2004-05-09 02:58:44 +00002220 xmlURIPtr puri;
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002221 int i = 0;
Owen Taylor3473f882001-02-23 17:55:21 +00002222 void *context = NULL;
Daniel Veillard966a31e2004-05-09 02:58:44 +00002223 char *unescaped = NULL;
2224 int is_file_uri = 1;
Daniel Veillardf012a642001-07-23 19:10:52 +00002225
Owen Taylor3473f882001-02-23 17:55:21 +00002226 if (xmlOutputCallbackInitialized == 0)
2227 xmlRegisterDefaultOutputCallbacks();
2228
2229 if (URI == NULL) return(NULL);
2230
Daniel Veillard966a31e2004-05-09 02:58:44 +00002231 puri = xmlParseURI(URI);
2232 if (puri != NULL) {
Daniel Veillard18a65092004-05-11 15:57:42 +00002233 if ((puri->scheme != NULL) &&
2234 (!xmlStrEqual(BAD_CAST puri->scheme, BAD_CAST "file")))
Daniel Veillard966a31e2004-05-09 02:58:44 +00002235 is_file_uri = 0;
2236 /*
2237 * try to limit the damages of the URI unescaping code.
2238 */
2239 if (puri->scheme != NULL)
2240 unescaped = xmlURIUnescapeString(URI, 0, NULL);
2241 xmlFreeURI(puri);
2242 }
Owen Taylor3473f882001-02-23 17:55:21 +00002243
2244 /*
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002245 * Try to find one of the output accept method accepting that scheme
Owen Taylor3473f882001-02-23 17:55:21 +00002246 * Go in reverse to give precedence to user defined handlers.
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002247 * try with an unescaped version of the URI
Owen Taylor3473f882001-02-23 17:55:21 +00002248 */
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002249 if (unescaped != NULL) {
2250#ifdef HAVE_ZLIB_H
Daniel Veillard966a31e2004-05-09 02:58:44 +00002251 if ((compression > 0) && (compression <= 9) && (is_file_uri == 1)) {
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002252 context = xmlGzfileOpenW(unescaped, compression);
2253 if (context != NULL) {
2254 ret = xmlAllocOutputBuffer(encoder);
2255 if (ret != NULL) {
2256 ret->context = context;
2257 ret->writecallback = xmlGzfileWrite;
2258 ret->closecallback = xmlGzfileClose;
2259 }
2260 xmlFree(unescaped);
2261 return(ret);
2262 }
2263 }
Daniel Veillardf012a642001-07-23 19:10:52 +00002264#endif
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002265 for (i = xmlOutputCallbackNr - 1;i >= 0;i--) {
2266 if ((xmlOutputCallbackTable[i].matchcallback != NULL) &&
2267 (xmlOutputCallbackTable[i].matchcallback(unescaped) != 0)) {
2268#if defined(LIBXML_HTTP_ENABLED) && defined(HAVE_ZLIB_H)
2269 /* Need to pass compression parameter into HTTP open calls */
2270 if (xmlOutputCallbackTable[i].matchcallback == xmlIOHTTPMatch)
2271 context = xmlIOHTTPOpenW(unescaped, compression);
2272 else
2273#endif
2274 context = xmlOutputCallbackTable[i].opencallback(unescaped);
2275 if (context != NULL)
2276 break;
2277 }
2278 }
2279 xmlFree(unescaped);
2280 }
Daniel Veillardf012a642001-07-23 19:10:52 +00002281
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002282 /*
2283 * If this failed try with a non-escaped URI this may be a strange
2284 * filename
2285 */
2286 if (context == NULL) {
2287#ifdef HAVE_ZLIB_H
Daniel Veillard966a31e2004-05-09 02:58:44 +00002288 if ((compression > 0) && (compression <= 9) && (is_file_uri == 1)) {
Igor Zlatkovic5f9fada2003-02-19 14:51:00 +00002289 context = xmlGzfileOpenW(URI, compression);
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002290 if (context != NULL) {
2291 ret = xmlAllocOutputBuffer(encoder);
2292 if (ret != NULL) {
2293 ret->context = context;
2294 ret->writecallback = xmlGzfileWrite;
2295 ret->closecallback = xmlGzfileClose;
2296 }
2297 return(ret);
2298 }
2299 }
2300#endif
2301 for (i = xmlOutputCallbackNr - 1;i >= 0;i--) {
2302 if ((xmlOutputCallbackTable[i].matchcallback != NULL) &&
Igor Zlatkovic5f9fada2003-02-19 14:51:00 +00002303 (xmlOutputCallbackTable[i].matchcallback(URI) != 0)) {
Daniel Veillardecb6f5b2001-08-15 08:47:42 +00002304#if defined(LIBXML_HTTP_ENABLED) && defined(HAVE_ZLIB_H)
2305 /* Need to pass compression parameter into HTTP open calls */
2306 if (xmlOutputCallbackTable[i].matchcallback == xmlIOHTTPMatch)
2307 context = xmlIOHTTPOpenW(URI, compression);
2308 else
2309#endif
2310 context = xmlOutputCallbackTable[i].opencallback(URI);
2311 if (context != NULL)
2312 break;
2313 }
Owen Taylor3473f882001-02-23 17:55:21 +00002314 }
2315 }
Daniel Veillardf012a642001-07-23 19:10:52 +00002316
Owen Taylor3473f882001-02-23 17:55:21 +00002317 if (context == NULL) {
2318 return(NULL);
2319 }
2320
2321 /*
2322 * Allocate the Output buffer front-end.
2323 */
2324 ret = xmlAllocOutputBuffer(encoder);
2325 if (ret != NULL) {
2326 ret->context = context;
2327 ret->writecallback = xmlOutputCallbackTable[i].writecallback;
2328 ret->closecallback = xmlOutputCallbackTable[i].closecallback;
2329 }
2330 return(ret);
2331}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002332#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002333
2334/**
2335 * xmlParserInputBufferCreateFile:
2336 * @file: a FILE*
2337 * @enc: the charset encoding if known
2338 *
2339 * Create a buffered parser input for the progressive parsing of a FILE *
2340 * buffered C I/O
2341 *
2342 * Returns the new parser input or NULL
2343 */
2344xmlParserInputBufferPtr
2345xmlParserInputBufferCreateFile(FILE *file, xmlCharEncoding enc) {
2346 xmlParserInputBufferPtr ret;
2347
2348 if (xmlInputCallbackInitialized == 0)
2349 xmlRegisterDefaultInputCallbacks();
2350
2351 if (file == NULL) return(NULL);
2352
2353 ret = xmlAllocParserInputBuffer(enc);
2354 if (ret != NULL) {
2355 ret->context = file;
2356 ret->readcallback = xmlFileRead;
2357 ret->closecallback = xmlFileFlush;
2358 }
2359
2360 return(ret);
2361}
2362
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002363#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002364/**
2365 * xmlOutputBufferCreateFile:
2366 * @file: a FILE*
2367 * @encoder: the encoding converter or NULL
2368 *
2369 * Create a buffered output for the progressive saving to a FILE *
2370 * buffered C I/O
2371 *
2372 * Returns the new parser output or NULL
2373 */
2374xmlOutputBufferPtr
2375xmlOutputBufferCreateFile(FILE *file, xmlCharEncodingHandlerPtr encoder) {
2376 xmlOutputBufferPtr ret;
2377
2378 if (xmlOutputCallbackInitialized == 0)
2379 xmlRegisterDefaultOutputCallbacks();
2380
2381 if (file == NULL) return(NULL);
2382
2383 ret = xmlAllocOutputBuffer(encoder);
2384 if (ret != NULL) {
2385 ret->context = file;
2386 ret->writecallback = xmlFileWrite;
2387 ret->closecallback = xmlFileFlush;
2388 }
2389
2390 return(ret);
2391}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002392#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002393
2394/**
2395 * xmlParserInputBufferCreateFd:
2396 * @fd: a file descriptor number
2397 * @enc: the charset encoding if known
2398 *
2399 * Create a buffered parser input for the progressive parsing for the input
2400 * from a file descriptor
2401 *
2402 * Returns the new parser input or NULL
2403 */
2404xmlParserInputBufferPtr
2405xmlParserInputBufferCreateFd(int fd, xmlCharEncoding enc) {
2406 xmlParserInputBufferPtr ret;
2407
2408 if (fd < 0) return(NULL);
2409
2410 ret = xmlAllocParserInputBuffer(enc);
2411 if (ret != NULL) {
Daniel Veillard8fcc4942001-07-17 20:07:33 +00002412 ret->context = (void *) (long) fd;
Owen Taylor3473f882001-02-23 17:55:21 +00002413 ret->readcallback = xmlFdRead;
2414 ret->closecallback = xmlFdClose;
2415 }
2416
2417 return(ret);
2418}
2419
2420/**
2421 * xmlParserInputBufferCreateMem:
2422 * @mem: the memory input
2423 * @size: the length of the memory block
2424 * @enc: the charset encoding if known
2425 *
2426 * Create a buffered parser input for the progressive parsing for the input
2427 * from a memory area.
2428 *
2429 * Returns the new parser input or NULL
2430 */
2431xmlParserInputBufferPtr
2432xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) {
2433 xmlParserInputBufferPtr ret;
2434
2435 if (size <= 0) return(NULL);
2436 if (mem == NULL) return(NULL);
2437
2438 ret = xmlAllocParserInputBuffer(enc);
2439 if (ret != NULL) {
2440 ret->context = (void *) mem;
2441 ret->readcallback = (xmlInputReadCallback) xmlNop;
2442 ret->closecallback = NULL;
2443 xmlBufferAdd(ret->buffer, (const xmlChar *) mem, size);
2444 }
2445
2446 return(ret);
2447}
2448
2449/**
Daniel Veillard53350552003-09-18 13:35:51 +00002450 * xmlParserInputBufferCreateStatic:
2451 * @mem: the memory input
2452 * @size: the length of the memory block
2453 * @enc: the charset encoding if known
2454 *
2455 * Create a buffered parser input for the progressive parsing for the input
2456 * from an immutable memory area. This will not copy the memory area to
2457 * the buffer, but the memory is expected to be available until the end of
2458 * the parsing, this is useful for example when using mmap'ed file.
2459 *
2460 * Returns the new parser input or NULL
2461 */
2462xmlParserInputBufferPtr
2463xmlParserInputBufferCreateStatic(const char *mem, int size,
2464 xmlCharEncoding enc) {
2465 xmlParserInputBufferPtr ret;
2466
2467 if (size <= 0) return(NULL);
2468 if (mem == NULL) return(NULL);
2469
2470 ret = (xmlParserInputBufferPtr) xmlMalloc(sizeof(xmlParserInputBuffer));
2471 if (ret == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002472 xmlIOErrMemory("creating input buffer");
Daniel Veillard53350552003-09-18 13:35:51 +00002473 return(NULL);
2474 }
2475 memset(ret, 0, (size_t) sizeof(xmlParserInputBuffer));
Daniel Veillarde72c5082003-09-19 12:44:05 +00002476 ret->buffer = xmlBufferCreateStatic((void *)mem, (size_t) size);
Daniel Veillard53350552003-09-18 13:35:51 +00002477 if (ret->buffer == NULL) {
2478 xmlFree(ret);
2479 return(NULL);
2480 }
2481 ret->encoder = xmlGetCharEncodingHandler(enc);
2482 if (ret->encoder != NULL)
2483 ret->raw = xmlBufferCreateSize(2 * xmlDefaultBufferSize);
2484 else
2485 ret->raw = NULL;
2486 ret->compressed = -1;
2487 ret->context = (void *) mem;
2488 ret->readcallback = NULL;
2489 ret->closecallback = NULL;
2490
2491 return(ret);
2492}
2493
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002494#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillard53350552003-09-18 13:35:51 +00002495/**
Owen Taylor3473f882001-02-23 17:55:21 +00002496 * xmlOutputBufferCreateFd:
2497 * @fd: a file descriptor number
2498 * @encoder: the encoding converter or NULL
2499 *
2500 * Create a buffered output for the progressive saving
2501 * to a file descriptor
2502 *
2503 * Returns the new parser output or NULL
2504 */
2505xmlOutputBufferPtr
2506xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandlerPtr encoder) {
2507 xmlOutputBufferPtr ret;
2508
2509 if (fd < 0) return(NULL);
2510
2511 ret = xmlAllocOutputBuffer(encoder);
2512 if (ret != NULL) {
Daniel Veillard8fcc4942001-07-17 20:07:33 +00002513 ret->context = (void *) (long) fd;
Owen Taylor3473f882001-02-23 17:55:21 +00002514 ret->writecallback = xmlFdWrite;
Daniel Veillard7db38712002-02-07 16:39:11 +00002515 ret->closecallback = NULL;
Owen Taylor3473f882001-02-23 17:55:21 +00002516 }
2517
2518 return(ret);
2519}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002520#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002521
2522/**
2523 * xmlParserInputBufferCreateIO:
2524 * @ioread: an I/O read function
2525 * @ioclose: an I/O close function
2526 * @ioctx: an I/O handler
2527 * @enc: the charset encoding if known
2528 *
2529 * Create a buffered parser input for the progressive parsing for the input
2530 * from an I/O handler
2531 *
2532 * Returns the new parser input or NULL
2533 */
2534xmlParserInputBufferPtr
2535xmlParserInputBufferCreateIO(xmlInputReadCallback ioread,
2536 xmlInputCloseCallback ioclose, void *ioctx, xmlCharEncoding enc) {
2537 xmlParserInputBufferPtr ret;
2538
2539 if (ioread == NULL) return(NULL);
2540
2541 ret = xmlAllocParserInputBuffer(enc);
2542 if (ret != NULL) {
2543 ret->context = (void *) ioctx;
2544 ret->readcallback = ioread;
2545 ret->closecallback = ioclose;
2546 }
2547
2548 return(ret);
2549}
2550
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002551#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002552/**
2553 * xmlOutputBufferCreateIO:
2554 * @iowrite: an I/O write function
2555 * @ioclose: an I/O close function
2556 * @ioctx: an I/O handler
Daniel Veillard9d06d302002-01-22 18:15:52 +00002557 * @encoder: the charset encoding if known
Owen Taylor3473f882001-02-23 17:55:21 +00002558 *
2559 * Create a buffered output for the progressive saving
2560 * to an I/O handler
2561 *
2562 * Returns the new parser output or NULL
2563 */
2564xmlOutputBufferPtr
2565xmlOutputBufferCreateIO(xmlOutputWriteCallback iowrite,
2566 xmlOutputCloseCallback ioclose, void *ioctx,
2567 xmlCharEncodingHandlerPtr encoder) {
2568 xmlOutputBufferPtr ret;
2569
2570 if (iowrite == NULL) return(NULL);
2571
2572 ret = xmlAllocOutputBuffer(encoder);
2573 if (ret != NULL) {
2574 ret->context = (void *) ioctx;
2575 ret->writecallback = iowrite;
2576 ret->closecallback = ioclose;
2577 }
2578
2579 return(ret);
2580}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002581#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002582
2583/**
2584 * xmlParserInputBufferPush:
2585 * @in: a buffered parser input
2586 * @len: the size in bytes of the array.
2587 * @buf: an char array
2588 *
2589 * Push the content of the arry in the input buffer
2590 * This routine handle the I18N transcoding to internal UTF-8
2591 * This is used when operating the parser in progressive (push) mode.
2592 *
2593 * Returns the number of chars read and stored in the buffer, or -1
2594 * in case of error.
2595 */
2596int
2597xmlParserInputBufferPush(xmlParserInputBufferPtr in,
2598 int len, const char *buf) {
2599 int nbchars = 0;
2600
2601 if (len < 0) return(0);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002602 if ((in == NULL) || (in->error)) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002603 if (in->encoder != NULL) {
Daniel Veillard36711902004-02-11 13:25:26 +00002604 unsigned int use;
2605
Owen Taylor3473f882001-02-23 17:55:21 +00002606 /*
2607 * Store the data in the incoming raw buffer
2608 */
2609 if (in->raw == NULL) {
2610 in->raw = xmlBufferCreate();
2611 }
2612 xmlBufferAdd(in->raw, (const xmlChar *) buf, len);
2613
2614 /*
2615 * convert as much as possible to the parser reading buffer.
2616 */
Daniel Veillard36711902004-02-11 13:25:26 +00002617 use = in->raw->use;
Owen Taylor3473f882001-02-23 17:55:21 +00002618 nbchars = xmlCharEncInFunc(in->encoder, in->buffer, in->raw);
2619 if (nbchars < 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002620 xmlIOErr(XML_IO_ENCODER, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002621 in->error = XML_IO_ENCODER;
Owen Taylor3473f882001-02-23 17:55:21 +00002622 return(-1);
2623 }
Daniel Veillard36711902004-02-11 13:25:26 +00002624 in->rawconsumed += (use - in->raw->use);
Owen Taylor3473f882001-02-23 17:55:21 +00002625 } else {
2626 nbchars = len;
2627 xmlBufferAdd(in->buffer, (xmlChar *) buf, nbchars);
2628 }
2629#ifdef DEBUG_INPUT
2630 xmlGenericError(xmlGenericErrorContext,
2631 "I/O: pushed %d chars, buffer %d/%d\n",
2632 nbchars, in->buffer->use, in->buffer->size);
2633#endif
2634 return(nbchars);
2635}
2636
2637/**
Daniel Veillardddffd2a2002-03-05 20:28:20 +00002638 * endOfInput:
2639 *
2640 * When reading from an Input channel indicated end of file or error
2641 * don't reread from it again.
2642 */
2643static int
2644endOfInput (void * context ATTRIBUTE_UNUSED,
2645 char * buffer ATTRIBUTE_UNUSED,
2646 int len ATTRIBUTE_UNUSED) {
2647 return(0);
2648}
2649
2650/**
Owen Taylor3473f882001-02-23 17:55:21 +00002651 * xmlParserInputBufferGrow:
2652 * @in: a buffered parser input
2653 * @len: indicative value of the amount of chars to read
2654 *
2655 * Grow up the content of the input buffer, the old data are preserved
2656 * This routine handle the I18N transcoding to internal UTF-8
2657 * This routine is used when operating the parser in normal (pull) mode
2658 *
Daniel Veillardcbaf3992001-12-31 16:16:02 +00002659 * TODO: one should be able to remove one extra copy by copying directly
Owen Taylor3473f882001-02-23 17:55:21 +00002660 * onto in->buffer or in->raw
2661 *
2662 * Returns the number of chars read and stored in the buffer, or -1
2663 * in case of error.
2664 */
2665int
2666xmlParserInputBufferGrow(xmlParserInputBufferPtr in, int len) {
2667 char *buffer = NULL;
2668 int res = 0;
2669 int nbchars = 0;
2670 int buffree;
Daniel Veillard9e412302002-06-10 15:59:44 +00002671 unsigned int needSize;
Owen Taylor3473f882001-02-23 17:55:21 +00002672
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002673 if ((in == NULL) || (in->error)) return(-1);
Daniel Veillard6155d8a2003-08-19 15:01:28 +00002674 if ((len <= MINLEN) && (len != 4))
Owen Taylor3473f882001-02-23 17:55:21 +00002675 len = MINLEN;
Daniel Veillard6155d8a2003-08-19 15:01:28 +00002676
Owen Taylor3473f882001-02-23 17:55:21 +00002677 buffree = in->buffer->size - in->buffer->use;
2678 if (buffree <= 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002679 xmlIOErr(XML_IO_BUFFER_FULL, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002680 in->error = XML_IO_BUFFER_FULL;
Owen Taylor3473f882001-02-23 17:55:21 +00002681 return(0);
2682 }
Owen Taylor3473f882001-02-23 17:55:21 +00002683
Daniel Veillarde5354492002-05-16 08:43:22 +00002684 needSize = in->buffer->use + len + 1;
2685 if (needSize > in->buffer->size){
2686 if (!xmlBufferResize(in->buffer, needSize)){
Daniel Veillard05d987b2003-10-08 11:54:57 +00002687 xmlIOErrMemory("growing input buffer");
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002688 in->error = XML_ERR_NO_MEMORY;
Daniel Veillarde5354492002-05-16 08:43:22 +00002689 return(0);
2690 }
Owen Taylor3473f882001-02-23 17:55:21 +00002691 }
Daniel Veillarde5354492002-05-16 08:43:22 +00002692 buffer = (char *)&in->buffer->content[in->buffer->use];
Owen Taylor3473f882001-02-23 17:55:21 +00002693
2694 /*
2695 * Call the read method for this I/O type.
2696 */
2697 if (in->readcallback != NULL) {
2698 res = in->readcallback(in->context, &buffer[0], len);
Daniel Veillardddffd2a2002-03-05 20:28:20 +00002699 if (res <= 0)
2700 in->readcallback = endOfInput;
Owen Taylor3473f882001-02-23 17:55:21 +00002701 } else {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002702 xmlIOErr(XML_IO_NO_INPUT, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002703 in->error = XML_IO_NO_INPUT;
Owen Taylor3473f882001-02-23 17:55:21 +00002704 return(-1);
2705 }
2706 if (res < 0) {
Owen Taylor3473f882001-02-23 17:55:21 +00002707 return(-1);
2708 }
2709 len = res;
2710 if (in->encoder != NULL) {
Daniel Veillard36711902004-02-11 13:25:26 +00002711 unsigned int use;
2712
Owen Taylor3473f882001-02-23 17:55:21 +00002713 /*
2714 * Store the data in the incoming raw buffer
2715 */
2716 if (in->raw == NULL) {
2717 in->raw = xmlBufferCreate();
2718 }
2719 xmlBufferAdd(in->raw, (const xmlChar *) buffer, len);
2720
2721 /*
2722 * convert as much as possible to the parser reading buffer.
2723 */
Daniel Veillard36711902004-02-11 13:25:26 +00002724 use = in->raw->use;
Owen Taylor3473f882001-02-23 17:55:21 +00002725 nbchars = xmlCharEncInFunc(in->encoder, in->buffer, in->raw);
2726 if (nbchars < 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002727 xmlIOErr(XML_IO_ENCODER, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002728 in->error = XML_IO_ENCODER;
Owen Taylor3473f882001-02-23 17:55:21 +00002729 return(-1);
2730 }
Daniel Veillard36711902004-02-11 13:25:26 +00002731 in->rawconsumed += (use - in->raw->use);
Owen Taylor3473f882001-02-23 17:55:21 +00002732 } else {
2733 nbchars = len;
Daniel Veillarde5354492002-05-16 08:43:22 +00002734 in->buffer->use += nbchars;
2735 buffer[nbchars] = 0;
Owen Taylor3473f882001-02-23 17:55:21 +00002736 }
2737#ifdef DEBUG_INPUT
2738 xmlGenericError(xmlGenericErrorContext,
2739 "I/O: read %d chars, buffer %d/%d\n",
2740 nbchars, in->buffer->use, in->buffer->size);
2741#endif
Owen Taylor3473f882001-02-23 17:55:21 +00002742 return(nbchars);
2743}
2744
2745/**
2746 * xmlParserInputBufferRead:
2747 * @in: a buffered parser input
2748 * @len: indicative value of the amount of chars to read
2749 *
2750 * Refresh the content of the input buffer, the old data are considered
2751 * consumed
2752 * This routine handle the I18N transcoding to internal UTF-8
2753 *
2754 * Returns the number of chars read and stored in the buffer, or -1
2755 * in case of error.
2756 */
2757int
2758xmlParserInputBufferRead(xmlParserInputBufferPtr in, int len) {
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002759 if ((in == NULL) || (in->error)) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002760 if (in->readcallback != NULL)
2761 return(xmlParserInputBufferGrow(in, len));
Daniel Veillard53350552003-09-18 13:35:51 +00002762 else if ((in->buffer != NULL) &&
2763 (in->buffer->alloc == XML_BUFFER_ALLOC_IMMUTABLE))
2764 return(0);
Owen Taylor3473f882001-02-23 17:55:21 +00002765 else
2766 return(-1);
2767}
2768
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002769#ifdef LIBXML_OUTPUT_ENABLED
Owen Taylor3473f882001-02-23 17:55:21 +00002770/**
2771 * xmlOutputBufferWrite:
2772 * @out: a buffered parser output
2773 * @len: the size in bytes of the array.
2774 * @buf: an char array
2775 *
2776 * Write the content of the array in the output I/O buffer
2777 * This routine handle the I18N transcoding from internal UTF-8
2778 * The buffer is lossless, i.e. will store in case of partial
2779 * or delayed writes.
2780 *
2781 * Returns the number of chars immediately written, or -1
2782 * in case of error.
2783 */
2784int
2785xmlOutputBufferWrite(xmlOutputBufferPtr out, int len, const char *buf) {
2786 int nbchars = 0; /* number of chars to output to I/O */
2787 int ret; /* return from function call */
2788 int written = 0; /* number of char written to I/O so far */
2789 int chunk; /* number of byte curreent processed from buf */
2790
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002791 if ((out == NULL) || (out->error)) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002792 if (len < 0) return(0);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002793 if (out->error) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002794
2795 do {
2796 chunk = len;
2797 if (chunk > 4 * MINLEN)
2798 chunk = 4 * MINLEN;
2799
2800 /*
2801 * first handle encoding stuff.
2802 */
2803 if (out->encoder != NULL) {
2804 /*
2805 * Store the data in the incoming raw buffer
2806 */
2807 if (out->conv == NULL) {
2808 out->conv = xmlBufferCreate();
2809 }
2810 xmlBufferAdd(out->buffer, (const xmlChar *) buf, chunk);
2811
2812 if ((out->buffer->use < MINLEN) && (chunk == len))
2813 goto done;
2814
2815 /*
2816 * convert as much as possible to the parser reading buffer.
2817 */
2818 ret = xmlCharEncOutFunc(out->encoder, out->conv, out->buffer);
Daniel Veillard809faa52003-02-10 15:43:53 +00002819 if ((ret < 0) && (ret != -3)) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002820 xmlIOErr(XML_IO_ENCODER, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002821 out->error = XML_IO_ENCODER;
Owen Taylor3473f882001-02-23 17:55:21 +00002822 return(-1);
2823 }
2824 nbchars = out->conv->use;
2825 } else {
2826 xmlBufferAdd(out->buffer, (const xmlChar *) buf, chunk);
2827 nbchars = out->buffer->use;
2828 }
2829 buf += chunk;
2830 len -= chunk;
2831
2832 if ((nbchars < MINLEN) && (len <= 0))
2833 goto done;
2834
2835 if (out->writecallback) {
2836 /*
2837 * second write the stuff to the I/O channel
2838 */
2839 if (out->encoder != NULL) {
2840 ret = out->writecallback(out->context,
2841 (const char *)out->conv->content, nbchars);
2842 if (ret >= 0)
Daniel Veillardedddff92001-05-02 10:58:52 +00002843 xmlBufferShrink(out->conv, ret);
Owen Taylor3473f882001-02-23 17:55:21 +00002844 } else {
2845 ret = out->writecallback(out->context,
2846 (const char *)out->buffer->content, nbchars);
2847 if (ret >= 0)
Daniel Veillardedddff92001-05-02 10:58:52 +00002848 xmlBufferShrink(out->buffer, ret);
Owen Taylor3473f882001-02-23 17:55:21 +00002849 }
2850 if (ret < 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002851 xmlIOErr(XML_IO_WRITE, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002852 out->error = XML_IO_WRITE;
Owen Taylor3473f882001-02-23 17:55:21 +00002853 return(ret);
2854 }
2855 out->written += ret;
2856 }
2857 written += nbchars;
2858 } while (len > 0);
2859
2860done:
2861#ifdef DEBUG_INPUT
2862 xmlGenericError(xmlGenericErrorContext,
2863 "I/O: wrote %d chars\n", written);
2864#endif
2865 return(written);
2866}
2867
2868/**
2869 * xmlOutputBufferWriteString:
2870 * @out: a buffered parser output
2871 * @str: a zero terminated C string
2872 *
2873 * Write the content of the string in the output I/O buffer
2874 * This routine handle the I18N transcoding from internal UTF-8
2875 * The buffer is lossless, i.e. will store in case of partial
2876 * or delayed writes.
2877 *
2878 * Returns the number of chars immediately written, or -1
2879 * in case of error.
2880 */
2881int
2882xmlOutputBufferWriteString(xmlOutputBufferPtr out, const char *str) {
2883 int len;
2884
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002885 if ((out == NULL) || (out->error)) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002886 if (str == NULL)
2887 return(-1);
2888 len = strlen(str);
2889
2890 if (len > 0)
2891 return(xmlOutputBufferWrite(out, len, str));
2892 return(len);
2893}
2894
2895/**
2896 * xmlOutputBufferFlush:
2897 * @out: a buffered output
2898 *
2899 * flushes the output I/O channel
2900 *
2901 * Returns the number of byte written or -1 in case of error.
2902 */
2903int
2904xmlOutputBufferFlush(xmlOutputBufferPtr out) {
2905 int nbchars = 0, ret = 0;
2906
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002907 if ((out == NULL) || (out->error)) return(-1);
Owen Taylor3473f882001-02-23 17:55:21 +00002908 /*
2909 * first handle encoding stuff.
2910 */
2911 if ((out->conv != NULL) && (out->encoder != NULL)) {
2912 /*
2913 * convert as much as possible to the parser reading buffer.
2914 */
2915 nbchars = xmlCharEncOutFunc(out->encoder, out->conv, out->buffer);
2916 if (nbchars < 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002917 xmlIOErr(XML_IO_ENCODER, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002918 out->error = XML_IO_ENCODER;
Owen Taylor3473f882001-02-23 17:55:21 +00002919 return(-1);
2920 }
2921 }
2922
2923 /*
2924 * second flush the stuff to the I/O channel
2925 */
2926 if ((out->conv != NULL) && (out->encoder != NULL) &&
2927 (out->writecallback != NULL)) {
2928 ret = out->writecallback(out->context,
2929 (const char *)out->conv->content, out->conv->use);
2930 if (ret >= 0)
2931 xmlBufferShrink(out->conv, ret);
2932 } else if (out->writecallback != NULL) {
2933 ret = out->writecallback(out->context,
2934 (const char *)out->buffer->content, out->buffer->use);
2935 if (ret >= 0)
2936 xmlBufferShrink(out->buffer, ret);
2937 }
2938 if (ret < 0) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00002939 xmlIOErr(XML_IO_FLUSH, NULL);
Daniel Veillard97bf4d02003-10-08 18:58:28 +00002940 out->error = XML_IO_FLUSH;
Owen Taylor3473f882001-02-23 17:55:21 +00002941 return(ret);
2942 }
2943 out->written += ret;
2944
2945#ifdef DEBUG_INPUT
2946 xmlGenericError(xmlGenericErrorContext,
2947 "I/O: flushed %d chars\n", ret);
2948#endif
2949 return(ret);
2950}
Daniel Veillarda9cce9c2003-09-29 13:20:24 +00002951#endif /* LIBXML_OUTPUT_ENABLED */
Owen Taylor3473f882001-02-23 17:55:21 +00002952
Daniel Veillard5e2dace2001-07-18 19:30:27 +00002953/**
Owen Taylor3473f882001-02-23 17:55:21 +00002954 * xmlParserGetDirectory:
2955 * @filename: the path to a file
2956 *
2957 * lookup the directory for that file
2958 *
2959 * Returns a new allocated string containing the directory, or NULL.
2960 */
2961char *
2962xmlParserGetDirectory(const char *filename) {
2963 char *ret = NULL;
2964 char dir[1024];
2965 char *cur;
2966 char sep = '/';
2967
Igor Zlatkovic9181cc02002-09-29 17:51:06 +00002968#ifdef _WIN32_WCE /* easy way by now ... wince does not have dirs! */
2969 return NULL;
2970#endif
2971
Owen Taylor3473f882001-02-23 17:55:21 +00002972 if (xmlInputCallbackInitialized == 0)
2973 xmlRegisterDefaultInputCallbacks();
2974
2975 if (filename == NULL) return(NULL);
Daniel Veillard3c5ed912002-01-08 10:36:16 +00002976#if defined(WIN32) && !defined(__CYGWIN__)
Owen Taylor3473f882001-02-23 17:55:21 +00002977 sep = '\\';
2978#endif
2979
2980 strncpy(dir, filename, 1023);
2981 dir[1023] = 0;
2982 cur = &dir[strlen(dir)];
2983 while (cur > dir) {
2984 if (*cur == sep) break;
2985 cur --;
2986 }
2987 if (*cur == sep) {
2988 if (cur == dir) dir[1] = 0;
2989 else *cur = 0;
2990 ret = xmlMemStrdup(dir);
2991 } else {
2992 if (getcwd(dir, 1024) != NULL) {
2993 dir[1023] = 0;
2994 ret = xmlMemStrdup(dir);
2995 }
2996 }
2997 return(ret);
2998}
2999
3000/****************************************************************
3001 * *
3002 * External entities loading *
3003 * *
3004 ****************************************************************/
3005
Daniel Veillarda840b692003-10-19 13:35:37 +00003006/**
3007 * xmlCheckHTTPInput:
3008 * @ctxt: an XML parser context
3009 * @ret: an XML parser input
3010 *
3011 * Check an input in case it was created from an HTTP stream, in that
3012 * case it will handle encoding and update of the base URL in case of
3013 * redirection. It also checks for HTTP errors in which case the input
3014 * is cleanly freed up and an appropriate error is raised in context
3015 *
3016 * Returns the input or NULL in case of HTTP error.
3017 */
3018xmlParserInputPtr
3019xmlCheckHTTPInput(xmlParserCtxtPtr ctxt, xmlParserInputPtr ret) {
3020#ifdef LIBXML_HTTP_ENABLED
3021 if ((ret != NULL) && (ret->buf != NULL) &&
3022 (ret->buf->readcallback == xmlIOHTTPRead) &&
3023 (ret->buf->context != NULL)) {
3024 const char *encoding;
3025 const char *redir;
3026 const char *mime;
3027 int code;
3028
3029 code = xmlNanoHTTPReturnCode(ret->buf->context);
3030 if (code >= 400) {
3031 /* fatal error */
3032 if (ret->filename != NULL)
Daniel Veillarde8039df2003-10-27 11:25:13 +00003033 __xmlLoaderErr(ctxt, "failed to load HTTP resource \"%s\"\n",
Daniel Veillarda840b692003-10-19 13:35:37 +00003034 (const char *) ret->filename);
3035 else
Daniel Veillarde8039df2003-10-27 11:25:13 +00003036 __xmlLoaderErr(ctxt, "failed to load HTTP resource\n", NULL);
Daniel Veillarda840b692003-10-19 13:35:37 +00003037 xmlFreeInputStream(ret);
3038 ret = NULL;
3039 } else {
3040
3041 mime = xmlNanoHTTPMimeType(ret->buf->context);
3042 if ((xmlStrstr(BAD_CAST mime, BAD_CAST "/xml")) ||
3043 (xmlStrstr(BAD_CAST mime, BAD_CAST "+xml"))) {
3044 encoding = xmlNanoHTTPEncoding(ret->buf->context);
3045 if (encoding != NULL) {
3046 xmlCharEncodingHandlerPtr handler;
3047
3048 handler = xmlFindCharEncodingHandler(encoding);
3049 if (handler != NULL) {
3050 xmlSwitchInputEncoding(ctxt, ret, handler);
3051 } else {
3052 __xmlErrEncoding(ctxt, XML_ERR_UNKNOWN_ENCODING,
3053 "Unknown encoding %s",
3054 BAD_CAST encoding, NULL);
3055 }
3056 if (ret->encoding == NULL)
3057 ret->encoding = xmlStrdup(BAD_CAST encoding);
3058 }
3059#if 0
3060 } else if (xmlStrstr(BAD_CAST mime, BAD_CAST "html")) {
3061#endif
3062 }
3063 redir = xmlNanoHTTPRedir(ret->buf->context);
3064 if (redir != NULL) {
3065 if (ret->filename != NULL)
3066 xmlFree((xmlChar *) ret->filename);
3067 if (ret->directory != NULL) {
3068 xmlFree((xmlChar *) ret->directory);
3069 ret->directory = NULL;
3070 }
3071 ret->filename =
3072 (char *) xmlStrdup((const xmlChar *) redir);
3073 }
3074 }
3075 }
3076#endif
3077 return(ret);
3078}
3079
Daniel Veillard561b7f82002-03-20 21:55:57 +00003080static int xmlSysIDExists(const char *URL) {
Daniel Veillard6990bf32001-08-23 21:17:48 +00003081#ifdef HAVE_STAT
3082 int ret;
3083 struct stat info;
3084 const char *path;
3085
3086 if (URL == NULL)
3087 return(0);
3088
Daniel Veillardf4862f02002-09-10 11:13:43 +00003089 if (!xmlStrncasecmp(BAD_CAST URL, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +00003090#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardf4862f02002-09-10 11:13:43 +00003091 path = &URL[17];
3092#else
Daniel Veillard6990bf32001-08-23 21:17:48 +00003093 path = &URL[16];
Daniel Veillardf4862f02002-09-10 11:13:43 +00003094#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00003095 else if (!xmlStrncasecmp(BAD_CAST URL, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +00003096#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillard6990bf32001-08-23 21:17:48 +00003097 path = &URL[8];
3098#else
3099 path = &URL[7];
3100#endif
3101 } else
3102 path = URL;
3103 ret = stat(path, &info);
Daniel Veillard561b7f82002-03-20 21:55:57 +00003104 if (ret == 0)
3105 return(1);
Daniel Veillard6990bf32001-08-23 21:17:48 +00003106#endif
Daniel Veillard561b7f82002-03-20 21:55:57 +00003107 return(0);
Daniel Veillard6990bf32001-08-23 21:17:48 +00003108}
Daniel Veillard6990bf32001-08-23 21:17:48 +00003109
Daniel Veillard5e2dace2001-07-18 19:30:27 +00003110/**
Owen Taylor3473f882001-02-23 17:55:21 +00003111 * xmlDefaultExternalEntityLoader:
3112 * @URL: the URL for the entity to load
3113 * @ID: the System ID for the entity to load
3114 * @ctxt: the context in which the entity is called or NULL
3115 *
3116 * By default we don't load external entitites, yet.
3117 *
3118 * Returns a new allocated xmlParserInputPtr, or NULL.
3119 */
Daniel Veillarda840b692003-10-19 13:35:37 +00003120static xmlParserInputPtr
Owen Taylor3473f882001-02-23 17:55:21 +00003121xmlDefaultExternalEntityLoader(const char *URL, const char *ID,
Daniel Veillarda840b692003-10-19 13:35:37 +00003122 xmlParserCtxtPtr ctxt)
3123{
Owen Taylor3473f882001-02-23 17:55:21 +00003124 xmlParserInputPtr ret = NULL;
Daniel Veillarde2940dd2001-08-22 00:06:49 +00003125 xmlChar *resource = NULL;
Daniel Veillarda840b692003-10-19 13:35:37 +00003126
Daniel Veillarde2940dd2001-08-22 00:06:49 +00003127#ifdef LIBXML_CATALOG_ENABLED
Daniel Veillard5d90b6c2001-08-22 14:29:45 +00003128 xmlCatalogAllow pref;
Daniel Veillarde2940dd2001-08-22 00:06:49 +00003129#endif
Owen Taylor3473f882001-02-23 17:55:21 +00003130
3131#ifdef DEBUG_EXTERNAL_ENTITIES
3132 xmlGenericError(xmlGenericErrorContext,
Daniel Veillarda840b692003-10-19 13:35:37 +00003133 "xmlDefaultExternalEntityLoader(%s, xxx)\n", URL);
Owen Taylor3473f882001-02-23 17:55:21 +00003134#endif
Daniel Veillard7d6fd212001-05-10 15:34:11 +00003135#ifdef LIBXML_CATALOG_ENABLED
Daniel Veillard61b93382003-11-03 14:28:31 +00003136 if ((ctxt != NULL) && (ctxt->options & XML_PARSE_NONET)) {
3137 int options = ctxt->options;
3138
3139 ctxt->options -= XML_PARSE_NONET;
3140 ret = xmlNoNetExternalEntityLoader(URL, ID, ctxt);
3141 ctxt->options = options;
3142 return(ret);
3143 }
3144
Daniel Veillard7d6fd212001-05-10 15:34:11 +00003145 /*
Daniel Veillarde2940dd2001-08-22 00:06:49 +00003146 * If the resource doesn't exists as a file,
Daniel Veillarddc2cee22001-08-22 16:30:37 +00003147 * try to load it from the resource pointed in the catalogs
Daniel Veillard7d6fd212001-05-10 15:34:11 +00003148 */
Daniel Veillard5d90b6c2001-08-22 14:29:45 +00003149 pref = xmlCatalogGetDefaults();
3150
Daniel Veillard561b7f82002-03-20 21:55:57 +00003151 if ((pref != XML_CATA_ALLOW_NONE) && (!xmlSysIDExists(URL))) {
Daniel Veillarda840b692003-10-19 13:35:37 +00003152 /*
3153 * Do a local lookup
3154 */
3155 if ((ctxt->catalogs != NULL) &&
3156 ((pref == XML_CATA_ALLOW_ALL) ||
3157 (pref == XML_CATA_ALLOW_DOCUMENT))) {
3158 resource = xmlCatalogLocalResolve(ctxt->catalogs,
3159 (const xmlChar *) ID,
3160 (const xmlChar *) URL);
Daniel Veillard5d90b6c2001-08-22 14:29:45 +00003161 }
Daniel Veillarda840b692003-10-19 13:35:37 +00003162 /*
3163 * Try a global lookup
3164 */
3165 if ((resource == NULL) &&
3166 ((pref == XML_CATA_ALLOW_ALL) ||
3167 (pref == XML_CATA_ALLOW_GLOBAL))) {
3168 resource = xmlCatalogResolve((const xmlChar *) ID,
3169 (const xmlChar *) URL);
3170 }
3171 if ((resource == NULL) && (URL != NULL))
3172 resource = xmlStrdup((const xmlChar *) URL);
Daniel Veillarddc2cee22001-08-22 16:30:37 +00003173
Daniel Veillarda840b692003-10-19 13:35:37 +00003174 /*
3175 * TODO: do an URI lookup on the reference
3176 */
3177 if ((resource != NULL)
3178 && (!xmlSysIDExists((const char *) resource))) {
3179 xmlChar *tmp = NULL;
Daniel Veillarddc2cee22001-08-22 16:30:37 +00003180
Daniel Veillarda840b692003-10-19 13:35:37 +00003181 if ((ctxt->catalogs != NULL) &&
3182 ((pref == XML_CATA_ALLOW_ALL) ||
3183 (pref == XML_CATA_ALLOW_DOCUMENT))) {
3184 tmp = xmlCatalogLocalResolveURI(ctxt->catalogs, resource);
3185 }
3186 if ((tmp == NULL) &&
3187 ((pref == XML_CATA_ALLOW_ALL) ||
3188 (pref == XML_CATA_ALLOW_GLOBAL))) {
3189 tmp = xmlCatalogResolveURI(resource);
3190 }
Daniel Veillarddc2cee22001-08-22 16:30:37 +00003191
Daniel Veillarda840b692003-10-19 13:35:37 +00003192 if (tmp != NULL) {
3193 xmlFree(resource);
3194 resource = tmp;
3195 }
3196 }
Daniel Veillard5d90b6c2001-08-22 14:29:45 +00003197 }
Daniel Veillard7d6fd212001-05-10 15:34:11 +00003198#endif
3199
3200 if (resource == NULL)
Daniel Veillarda840b692003-10-19 13:35:37 +00003201 resource = (xmlChar *) URL;
Daniel Veillard7d6fd212001-05-10 15:34:11 +00003202
3203 if (resource == NULL) {
Daniel Veillarda840b692003-10-19 13:35:37 +00003204 if (ID == NULL)
3205 ID = "NULL";
Daniel Veillarde8039df2003-10-27 11:25:13 +00003206 __xmlLoaderErr(ctxt, "failed to load external entity \"%s\"\n", ID);
Daniel Veillarda840b692003-10-19 13:35:37 +00003207 return (NULL);
Owen Taylor3473f882001-02-23 17:55:21 +00003208 }
Daniel Veillarda840b692003-10-19 13:35:37 +00003209 ret = xmlNewInputFromFile(ctxt, (const char *) resource);
Daniel Veillarddc2cee22001-08-22 16:30:37 +00003210 if ((resource != NULL) && (resource != (xmlChar *) URL))
Daniel Veillarda840b692003-10-19 13:35:37 +00003211 xmlFree(resource);
3212 return (ret);
Owen Taylor3473f882001-02-23 17:55:21 +00003213}
3214
3215static xmlExternalEntityLoader xmlCurrentExternalEntityLoader =
3216 xmlDefaultExternalEntityLoader;
3217
Daniel Veillard5e2dace2001-07-18 19:30:27 +00003218/**
Owen Taylor3473f882001-02-23 17:55:21 +00003219 * xmlSetExternalEntityLoader:
3220 * @f: the new entity resolver function
3221 *
3222 * Changes the defaultexternal entity resolver function for the application
3223 */
3224void
3225xmlSetExternalEntityLoader(xmlExternalEntityLoader f) {
3226 xmlCurrentExternalEntityLoader = f;
3227}
3228
Daniel Veillard5e2dace2001-07-18 19:30:27 +00003229/**
Owen Taylor3473f882001-02-23 17:55:21 +00003230 * xmlGetExternalEntityLoader:
3231 *
3232 * Get the default external entity resolver function for the application
3233 *
3234 * Returns the xmlExternalEntityLoader function pointer
3235 */
3236xmlExternalEntityLoader
3237xmlGetExternalEntityLoader(void) {
3238 return(xmlCurrentExternalEntityLoader);
3239}
3240
Daniel Veillard5e2dace2001-07-18 19:30:27 +00003241/**
Owen Taylor3473f882001-02-23 17:55:21 +00003242 * xmlLoadExternalEntity:
3243 * @URL: the URL for the entity to load
Daniel Veillard9f7b84b2001-08-23 15:31:19 +00003244 * @ID: the Public ID for the entity to load
Owen Taylor3473f882001-02-23 17:55:21 +00003245 * @ctxt: the context in which the entity is called or NULL
3246 *
3247 * Load an external entity, note that the use of this function for
3248 * unparsed entities may generate problems
Daniel Veillardcbaf3992001-12-31 16:16:02 +00003249 * TODO: a more generic External entity API must be designed
Owen Taylor3473f882001-02-23 17:55:21 +00003250 *
3251 * Returns the xmlParserInputPtr or NULL
3252 */
3253xmlParserInputPtr
3254xmlLoadExternalEntity(const char *URL, const char *ID,
3255 xmlParserCtxtPtr ctxt) {
Daniel Veillard4e9b1bc2003-06-09 10:30:33 +00003256 if ((URL != NULL) && (xmlSysIDExists(URL) == 0)) {
3257 char *canonicFilename;
3258 xmlParserInputPtr ret;
3259
3260 canonicFilename = (char *) xmlCanonicPath((const xmlChar *) URL);
3261 if (canonicFilename == NULL) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00003262 xmlIOErrMemory("building canonical path\n");
Daniel Veillard4e9b1bc2003-06-09 10:30:33 +00003263 return(NULL);
3264 }
3265
3266 ret = xmlCurrentExternalEntityLoader(canonicFilename, ID, ctxt);
3267 xmlFree(canonicFilename);
3268 return(ret);
3269 }
Owen Taylor3473f882001-02-23 17:55:21 +00003270 return(xmlCurrentExternalEntityLoader(URL, ID, ctxt));
3271}
3272
Daniel Veillard8bdb91d2001-10-31 17:52:43 +00003273/************************************************************************
3274 * *
3275 * Disabling Network access *
3276 * *
3277 ************************************************************************/
3278
3279#ifdef LIBXML_CATALOG_ENABLED
3280static int
3281xmlNoNetExists(const char *URL)
3282{
3283#ifdef HAVE_STAT
3284 int ret;
3285 struct stat info;
3286 const char *path;
3287
3288 if (URL == NULL)
3289 return (0);
3290
Daniel Veillardf4862f02002-09-10 11:13:43 +00003291 if (!xmlStrncasecmp(BAD_CAST URL, BAD_CAST "file://localhost/", 17))
Daniel Veillard1997c3e2003-07-05 20:43:43 +00003292#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillardf4862f02002-09-10 11:13:43 +00003293 path = &URL[17];
3294#else
3295 path = &URL[16];
3296#endif
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00003297 else if (!xmlStrncasecmp(BAD_CAST URL, BAD_CAST "file:///", 8)) {
Daniel Veillard1997c3e2003-07-05 20:43:43 +00003298#if defined (_WIN32) || defined (__DJGPP__) && !defined(__CYGWIN__)
Daniel Veillard8bdb91d2001-10-31 17:52:43 +00003299 path = &URL[8];
3300#else
3301 path = &URL[7];
3302#endif
3303 } else
3304 path = URL;
3305 ret = stat(path, &info);
3306 if (ret == 0)
3307 return (1);
3308#endif
3309 return (0);
3310}
3311#endif
3312
3313/**
3314 * xmlNoNetExternalEntityLoader:
3315 * @URL: the URL for the entity to load
3316 * @ID: the System ID for the entity to load
3317 * @ctxt: the context in which the entity is called or NULL
3318 *
3319 * A specific entity loader disabling network accesses, though still
3320 * allowing local catalog accesses for resolution.
3321 *
3322 * Returns a new allocated xmlParserInputPtr, or NULL.
3323 */
3324xmlParserInputPtr
3325xmlNoNetExternalEntityLoader(const char *URL, const char *ID,
3326 xmlParserCtxtPtr ctxt) {
3327 xmlParserInputPtr input = NULL;
3328 xmlChar *resource = NULL;
3329
3330#ifdef LIBXML_CATALOG_ENABLED
3331 xmlCatalogAllow pref;
3332
3333 /*
3334 * If the resource doesn't exists as a file,
3335 * try to load it from the resource pointed in the catalogs
3336 */
3337 pref = xmlCatalogGetDefaults();
3338
3339 if ((pref != XML_CATA_ALLOW_NONE) && (!xmlNoNetExists(URL))) {
3340 /*
3341 * Do a local lookup
3342 */
3343 if ((ctxt->catalogs != NULL) &&
3344 ((pref == XML_CATA_ALLOW_ALL) ||
3345 (pref == XML_CATA_ALLOW_DOCUMENT))) {
3346 resource = xmlCatalogLocalResolve(ctxt->catalogs,
3347 (const xmlChar *)ID,
3348 (const xmlChar *)URL);
3349 }
3350 /*
3351 * Try a global lookup
3352 */
3353 if ((resource == NULL) &&
3354 ((pref == XML_CATA_ALLOW_ALL) ||
3355 (pref == XML_CATA_ALLOW_GLOBAL))) {
3356 resource = xmlCatalogResolve((const xmlChar *)ID,
3357 (const xmlChar *)URL);
3358 }
3359 if ((resource == NULL) && (URL != NULL))
3360 resource = xmlStrdup((const xmlChar *) URL);
3361
3362 /*
3363 * TODO: do an URI lookup on the reference
3364 */
3365 if ((resource != NULL) && (!xmlNoNetExists((const char *)resource))) {
3366 xmlChar *tmp = NULL;
3367
3368 if ((ctxt->catalogs != NULL) &&
3369 ((pref == XML_CATA_ALLOW_ALL) ||
3370 (pref == XML_CATA_ALLOW_DOCUMENT))) {
3371 tmp = xmlCatalogLocalResolveURI(ctxt->catalogs, resource);
3372 }
3373 if ((tmp == NULL) &&
3374 ((pref == XML_CATA_ALLOW_ALL) ||
3375 (pref == XML_CATA_ALLOW_GLOBAL))) {
3376 tmp = xmlCatalogResolveURI(resource);
3377 }
3378
3379 if (tmp != NULL) {
3380 xmlFree(resource);
3381 resource = tmp;
3382 }
3383 }
3384 }
3385#endif
3386 if (resource == NULL)
3387 resource = (xmlChar *) URL;
3388
3389 if (resource != NULL) {
Aleksey Sanin5aac8b82002-05-01 18:32:28 +00003390 if ((!xmlStrncasecmp(BAD_CAST resource, BAD_CAST "ftp://", 6)) ||
3391 (!xmlStrncasecmp(BAD_CAST resource, BAD_CAST "http://", 7))) {
Daniel Veillard05d987b2003-10-08 11:54:57 +00003392 xmlIOErr(XML_IO_NETWORK_ATTEMPT, (const char *) resource);
Daniel Veillard8bdb91d2001-10-31 17:52:43 +00003393 if (resource != (xmlChar *) URL)
3394 xmlFree(resource);
3395 return(NULL);
3396 }
3397 }
3398 input = xmlDefaultExternalEntityLoader((const char *) resource, ID, ctxt);
3399 if (resource != (xmlChar *) URL)
3400 xmlFree(resource);
3401 return(input);
3402}
3403