Created libssh2_sftp_readdir_ex() and updated LIBSSH2_APINO to 200706151200

ChangeLog

@@ -1,3 +1,9 @@
+2007-07-15  James Housley <jim@thehousleys.net>
+	* Add libssh2_sftp_readdir_ex(), this function if passed the
+	extra parameters will be used to store the full directory
+	entry as provided by the server.  Updated LIBSSH2_APINO to
+	200706151200 for this change.
+
 2007-07-12  James Housley <jim@thehousleys.net>
 
 	* libssh2_publickey_shutdown(), libssh2_session_free() changed

NEWS

@@ -1,5 +1,8 @@
 Version 
 ------------
+  Added libssh2_sftp_readdir_ex() and updated LIBSSH2_APINO to
+  200706151200 (James Housley)
+
   Converted all of the libssh2 code to be able to work in non-blocking
   mode.  This included some public API changes, listed below (James Housley)
     Changed function return values:

docs/libssh2_sftp_readdir.3

@@ -1,12 +1,15 @@
-.\" $Id: libssh2_sftp_readdir.3,v 1.8 2007/06/13 16:41:33 jehousley Exp $
+.\" $Id: libssh2_sftp_readdir.3,v 1.9 2007/06/15 17:22:49 jehousley Exp $
 .\"
-.TH libssh2_sftp_readdir 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
-libssh2_sftp_readdir - read directory data from an SFTP handle
+libssh2_sftp_readdir_ex - read directory data from an SFTP handle
 .SH SYNOPSIS
 #include <libssh2.h>
 #include <libssh2_sftp.h>
 
+int 
+libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, char *longentry, size_t longentry_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
 int 
 libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
 
@@ -21,6 +24,13 @@ libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_ma
 filename is longer than the space provided by buffer_maxlen it will be 
 truncated to fit.
 
+\fIlongentry\fP - is a pointer to a pre-allocated buffer of at least
+\fIlongentry_maxlen\fP bytes to read data into.
+
+\fIlongentry_maxlen\fP - is the length of longentry in bytes. If the length 
+of the full directory entry is longer than the space provided by 
+longentry_maxlen it will be truncated to fit.
+
 \fIattrs\fP - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate 
 statbuf style data into.
 

example/simple/sftpdir.c

@@ -1,5 +1,5 @@
 /*
- * $Id: sftpdir.c,v 1.5 2007/06/06 12:34:09 jehousley Exp $
+ * $Id: sftpdir.c,v 1.6 2007/06/15 17:22:49 jehousley Exp $
  *
  * Sample doing an SFTP directory listing.
  *
@@ -114,7 +114,7 @@ int main(int argc, char *argv[])
 
     if (auth_pw) {
         /* We could authenticate via password */
-		if (libssh2_userauth_password(session, username, password)) {
+        if ((i = libssh2_userauth_password(session, username, password))) {
             printf("Authentication by password failed.\n");
             goto shutdown;
         }
@@ -151,15 +151,19 @@ int main(int argc, char *argv[])
     fprintf(stderr, "libssh2_sftp_opendir() is done, now receive listing!\n");
     do {
         char mem[512];
+        char longentry[512];
         LIBSSH2_SFTP_ATTRIBUTES attrs;
 
         /* loop until we fail */
-		rc = libssh2_sftp_readdir(sftp_handle, mem, sizeof(mem),
+        rc = libssh2_sftp_readdir_ex(sftp_handle, mem, sizeof(mem),
-					  &attrs);
+                                     longentry, sizeof(longentry), &attrs);
         if(rc > 0) {
             /* rc is the length of the file name in the mem
                buffer */
 
+            if (longentry[0] != '\0') {
+                printf("%s\n", longentry);
+            } else {
                 if(attrs.flags & LIBSSH2_SFTP_ATTR_PERMISSIONS) {
                     /* this should check what permissions it
                        is and print the output accordingly */
@@ -188,6 +192,7 @@ int main(int argc, char *argv[])
 
                 printf("%s\n", mem);
             }
+        }
         else
             break;
 

include/libssh2.h

@@ -77,7 +77,7 @@ typedef long long libssh2_int64_t;
 #endif
 
 #define LIBSSH2_VERSION                             "0.15-CVS"
-#define LIBSSH2_APINO                               200706012030
+#define LIBSSH2_APINO                               200706151200
 
 /* Part of every banner, user specified or not */
 #define LIBSSH2_SSH_BANNER                          "SSH-2.0-libssh2_" LIBSSH2_VERSION

include/libssh2_sftp.h

@@ -193,8 +193,11 @@ LIBSSH2_API LIBSSH2_SFTP_HANDLE *libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const
 
 LIBSSH2_API ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen);
 
-LIBSSH2_API int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, 
+LIBSSH2_API int libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, 
-                                     size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+                                        char *longentry, size_t longentry_maxlen, 
+                                        LIBSSH2_SFTP_ATTRIBUTES *attrs);
+#define libssh2_sftp_readdir(handle, buffer, buffer_maxlen, attrs) \
+                    libssh2_sftp_readdir_ex((handle), (buffer), (buffer_maxlen), NULL, 0, (attrs))
 
 LIBSSH2_API ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);
 

src/sftp.c

@@ -995,14 +995,15 @@ LIBSSH2_API ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
 /* {{{ libssh2_sftp_readdir
  * Read from an SFTP directory handle
  */
-LIBSSH2_API int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, 
+LIBSSH2_API int libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen,
+                                        char *longentry, size_t longentry_maxlen, 
                                         LIBSSH2_SFTP_ATTRIBUTES *attrs)
 {
     LIBSSH2_SFTP    *sftp    = handle->sftp;
     LIBSSH2_CHANNEL *channel = sftp->channel;
     LIBSSH2_SESSION *session = channel->session;
     LIBSSH2_SFTP_ATTRIBUTES attrs_dummy;
-    unsigned long data_len, request_id, filename_len, num_names;
+    unsigned long data_len, request_id, filename_len, longentry_len, num_names;
     /* 13 = packet_len(4) + packet_type(1) + request_id(4) + handle_len(4) */
     ssize_t packet_len = handle->handle_len + 13;
     unsigned char *packet, *s, *data;
@@ -1031,8 +1032,25 @@ LIBSSH2_API int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
                 buffer[filename_len] = '\0';
             }
             
+            if ((longentry == NULL) || (longentry_maxlen == 0)) {
                 /* Skip longname */
                 s += 4 + libssh2_ntohu32(s);
+            } else {
+                unsigned long real_longentry_len = libssh2_ntohu32(s);
+                
+                longentry_len = real_longentry_len;
+                s += 4;
+                if (longentry_len > longentry_maxlen) {
+                    longentry_len = longentry_maxlen;
+                }
+                memcpy(longentry, s, longentry_len);
+                s += real_longentry_len;
+                
+                /* The longentry is not null terminated, make it so if possible */
+                if (longentry_len < longentry_maxlen) {
+                    longentry[longentry_len] = '\0';
+                }
+            }
             
             if (attrs) {
                 memset(attrs, 0, sizeof(LIBSSH2_SFTP_ATTRIBUTES));
@@ -1044,7 +1062,7 @@ LIBSSH2_API int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
                 LIBSSH2_FREE(session, handle->u.dir.names_packet);
             }
             
-            _libssh2_debug(session, LIBSSH2_DBG_SFTP, "libssh2_sftp_readdir() return %d", filename_len);
+            _libssh2_debug(session, LIBSSH2_DBG_SFTP, "libssh2_sftp_readdir_ex() return %d", filename_len);
             return filename_len;
         }
         
@@ -1159,7 +1177,7 @@ LIBSSH2_API int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
     sftp->readdir_state = libssh2_NB_state_idle;
     
     /* Be lazy, just use the name popping mechanism from the start of the function */
-    return libssh2_sftp_readdir(handle, buffer, buffer_maxlen, attrs);
+    return libssh2_sftp_readdir_ex(handle, buffer, buffer_maxlen, longentry, longentry_maxlen, attrs);
 }
 /* }}} */