-/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-stream.c : abstract class for a stream */
/*
* USA
*/
+
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
return camel_stream_type;
}
+
/**
* camel_stream_read:
* @stream: a CamelStream.
- * @buffer: buffer where bytes pulled from the stream are stored.
+ * @buffer: output buffer
* @n: max number of bytes to read.
*
- * Read at most @n bytes from the @stream object and stores them
- * in the buffer pointed at by @buffer.
+ * Attempts to read up to @len bytes from @stream into @buf.
*
- * Return value: number of bytes actually read, or -1 on error and
- * set errno.
+ * Returns the number of bytes actually read, or -1 on error and set
+ * errno.
**/
ssize_t
camel_stream_read (CamelStream *stream, char *buffer, size_t n)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
g_return_val_if_fail (n == 0 || buffer, -1);
-
+
return CS_CLASS (stream)->read (stream, buffer, n);
}
+
/**
* camel_stream_write:
* @stream: a CamelStream object.
* @buffer: buffer to write.
* @n: number of bytes to write
*
- * Write @n bytes from the buffer pointed at by @buffer into @stream.
+ * Attempts to write up to @n bytes of @buffer into @stream.
*
- * Return value: the number of bytes actually written to the stream,
- * or -1 on error.
+ * Returns the number of bytes written to the stream, or -1 on error
+ * along with setting errno.
**/
ssize_t
camel_stream_write (CamelStream *stream, const char *buffer, size_t n)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
g_return_val_if_fail (n == 0 || buffer, -1);
-
+
return CS_CLASS (stream)->write (stream, buffer, n);
}
+
/**
* camel_stream_flush:
- * @stream: a CamelStream object
+ * @stream: stream
*
- * Flushes the contents of the stream to its backing store. Only meaningful
- * on writable streams.
+ * Flushes any buffered data to the stream's backing store. Only
+ * meaningful for writable streams.
*
- * Return value: -1 on error.
+ * Returns 0 on success or -1 on fail along with setting errno.
**/
int
camel_stream_flush (CamelStream *stream)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
-
+
return CS_CLASS (stream)->flush (stream);
}
+
/**
* camel_stream_close:
* @stream:
*
- * Close a stream.
+ * Closes the stream.
*
- * Return value: -1 on error.
+ * Returns 0 on success or -1 on error.
**/
int
camel_stream_close (CamelStream *stream)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
-
+
return CS_CLASS (stream)->close (stream);
}
+
/**
* camel_stream_eos:
* @stream: a CamelStream object
*
- * Test if there are bytes left to read on the @stream object.
+ * Tests if there are bytes left to read on the @stream object.
*
- * Return value: %TRUE if all the contents on the stream has been read, or
- * %FALSE if information is still available.
+ * Returns %TRUE on EOS or %FALSE otherwise.
**/
gboolean
camel_stream_eos (CamelStream *stream)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), TRUE);
-
+
return CS_CLASS (stream)->eos (stream);
}
+
/**
- * camel_stream_reset: reset a stream
+ * camel_stream_reset:
* @stream: the stream object
*
- * Reset a stream. That is, put it in a state where it can be read
+ * Resets the stream. That is, put it in a state where it can be read
* from the beginning again. Not all streams in Camel are seekable,
* but they must all be resettable.
*
- * Return value: -1 on error.
+ * Returns 0 on success or -1 on error along with setting errno.
**/
int
camel_stream_reset (CamelStream *stream)
{
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
-
+
return CS_CLASS (stream)->reset (stream);
}
*
* Writes the string to the stream.
*
- * Return value: the number of characters output, -1 on error.
+ * Returns the number of characters written or -1 on error.
**/
ssize_t
camel_stream_write_string (CamelStream *stream, const char *string)
return camel_stream_write (stream, string, strlen (string));
}
+
/**
* camel_stream_printf:
* @stream: a stream object
* @fmt: a printf-style format string
*
- * This printfs the given data to @stream.
+ * Write formatted output to a stream.
*
- * Return value: the number of characters output, -1 on error.
+ * Returns the number of characters written or -1 on error.
**/
ssize_t
camel_stream_printf (CamelStream *stream, const char *fmt, ... )
va_list args;
char *string;
ssize_t ret;
-
+
g_return_val_if_fail (CAMEL_IS_STREAM (stream), -1);
-
+
va_start (args, fmt);
string = g_strdup_vprintf (fmt, args);
va_end (args);
-
+
if (!string)
return -1;
-
+
ret = camel_stream_write (stream, string, strlen (string));
g_free (string);
return ret;
}
+
/**
* camel_stream_write_to_stream:
* @stream: Source CamelStream.
* @output_stream: Destination CamelStream.
*
- * Write all of a stream (until eos) into another stream, in a blocking
- * fashion.
+ * Write all of a stream (until eos) into another stream, in a
+ * blocking fashion.
*
- * Return value: Returns -1 on error, or the number of bytes succesfully
+ * Returns -1 on error, or the number of bytes succesfully
* copied across streams.
**/
ssize_t
store->command = 0;
/* Read the greeting, if any. FIXME: deal with PREAUTH */
- if (camel_imap_store_recv_line (store, &buf, ex) < 0) {
+ if (camel_imap_store_readline (store, &buf, ex) < 0) {
if (store->istream) {
camel_object_unref (CAMEL_OBJECT (store->istream));
store->istream = NULL;
/* FIXME: please god, when will the hurting stop? Thus function is so
fucking broken it's not even funny. */
-int
-camel_imap_store_recv_line (CamelImapStore *store, char **dest, CamelException *ex)
+ssize_t
+camel_imap_store_readline (CamelImapStore *store, char **dest, CamelException *ex)
{
CamelStreamBuffer *stream;
- char *buf;
+ char linebuf[1024];
+ GByteArray *ba;
+ ssize_t nread;
g_return_val_if_fail (CAMEL_IS_IMAP_STORE (store), -1);
g_return_val_if_fail (dest, -1);
g_strerror (errno));
return -1;
}
+
stream = CAMEL_STREAM_BUFFER (store->istream);
- buf = camel_stream_buffer_read_line (stream);
+ ba = g_byte_array_new ();
+ while ((nread = camel_stream_buffer_gets (stream, linebuf, sizeof (linebuf))) > 0) {
+ g_byte_array_append (ba, linebuf, nread);
+ if (linebuf[nread - 1] == '\n')
+ break;
+ }
- if (buf == NULL) {
+ if (nread <= 0) {
if (errno == EINTR)
camel_exception_set (ex, CAMEL_EXCEPTION_USER_CANCEL, _("Operation cancelled"));
else
return -1;
}
- *dest = buf;
-
#if d(!)0
- if (camel_verbose_debug)
- fprintf (stderr, "received: %s\n", *dest);
+ if (camel_verbose_debug) {
+ fprintf (stderr, "received: ");
+ fwrite (*dest, 1, nread, stderr);
+ }
#endif
- return strlen (*dest);
+ /* camel-imap-command.c:imap_read_untagged expects the CRLFs
+ to be stripped off and be nul-terminated *sigh* */
+ nread = ba->len - 1;
+ ba->data[nread] = '\0';
+ if (ba->data[nread - 1] == '\r') {
+ ba->data[nread - 1] = '\0';
+ nread--;
+ }
+
+ *dest = ba->data;
+ g_byte_array_free (ba, FALSE);
+
+ return nread;
}