Add directory-listing to VirtualDirectory.

pkg/http_server/lib/src/virtual_directory.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of http_server;
 
 /**
  * A [VirtualDirectory] can serve files and directory-listing from a root path,
  * to [HttpRequest]s.
  *
@@ skipping 28 matching lines @@
    * Serve a [Stream] of [HttpRequest]s, in this [VirtualDirectory].
    */
   void serve(Stream<HttpRequest> requests);
 
   /**
    * Serve a single [HttpRequest], in this [VirtualDirectory].
    */
   void serveRequest(HttpRequest request);
 
   /**
+   * Set the [callback] to override the default directory listing. The
+   * [callback] will be called with the [Directory] to be listed and the
+   * [HttpRequest].
+   */
+  void setDirectoryHandler(void callback(Directory dir, HttpRequest request));
+
+  /**
    * Set the [callback] to override the error page handler. When [callback] is
    * invoked, the `statusCode` property of the response is set.
    */
   void setErrorPageHandler(void callback(HttpRequest request));
 }
 
 class _VirtualDirectory implements VirtualDirectory {
   final String root;
 
   bool allowDirectoryListing = false;
   bool followLinks = true;
 
   Function _errorCallback;
+  Function _dirCallback;
 
   _VirtualDirectory(this.root);
 
   void serve(Stream<HttpRequest> requests) {
     requests.listen(serveRequest);
   }
 
   void serveRequest(HttpRequest request) {
     var path = new Path(request.uri.path).canonicalize();
 
     if (!path.isAbsolute) {
       return _serveErrorPage(HttpStatus.NOT_FOUND, request);
     }
 
     _locateResource(new Path('.'), path.segments())
         .then((entity) {
           if (entity == null) {
             _serveErrorPage(HttpStatus.NOT_FOUND, request);
             return;
           }
           if (entity is File) {
             _serveFile(entity, request);
+          } else if (entity is Directory) {
+            _serveDirectory(entity, request);
           } else {
             _serveErrorPage(HttpStatus.NOT_FOUND, request);
           }
         });
   }
 
+  void setDirectoryHandler(void callback(Directory dir, HttpRequest request)) {
+    _dirCallback = callback;
+  }
+
   void setErrorPageHandler(void callback(HttpRequest request)) {
     _errorCallback = callback;
   }
 
   Future<FileSystemEntity> _locateResource(Path path,
                                            Iterable<String> segments) {
     Path fullPath() => new Path(root).join(path);
     return FileSystemEntity.type(fullPath().toNativePath(), followLinks: false)
         .then((type) {
           switch (type) {
@@ skipping 12 matching lines @@
               }
               break;
 
             case FileSystemEntityType.LINK:
               if (followLinks) {
                 return new Link.fromPath(fullPath()).target()
                     .then((target) {
                       var targetPath = new Path(target).canonicalize();
                       if (targetPath.isAbsolute) return null;
                       targetPath = path.directoryPath.join(targetPath)
                           .canonicalize();

[Bill Hesse, 2013/06/28 12:42:26]

Nit: Break line at = ?

[Anders Johnsen, 2013/06/28 12:49:36]

Done.

                       if (targetPath.segments().isEmpty ||
                           targetPath.segments().first == '..') return null;
+                      if (segments.isEmpty) {
+                        return _locateResource(targetPath, []);
+                      }
                       return _locateResource(targetPath.append(segments.first),
                                              segments.skip(1));
                     });
               }
               break;
           }
           // Return `null` on fall-through, to indicate NOT_FOUND.
           return null;
         });
   }
@@ skipping 55 matching lines @@
 
         file.openRead()
             .pipe(new _VirtualDirectoryFileStream(response, file.path))
             .catchError((_) {});
       });
     }).catchError((_) {
       response.close();
     });
   }
 
+  void _serveDirectory(Directory dir, HttpRequest request) {
+    if (_dirCallback != null) {
+      _dirCallback(dir, request);
+      return;
+    }
+    var response = request.response;
+    dir.stat().then((stats) {
+      if (request.headers.ifModifiedSince != null &&
+          !stats.modified.isAfter(request.headers.ifModifiedSince)) {
+        response.statusCode = HttpStatus.NOT_MODIFIED;
+        response.close();
+        return;
+      }
+
+      response.headers.set(HttpHeaders.LAST_MODIFIED, stats.modified);
+      var path = request.uri.path;
+      var header =
+'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>Index of $path</title>
+</head>
+<body>
+<h1>Index of $path</h1>
+<table>
+  <tr>
+    <td>Name</td>
+    <td>Last modified</td>
+    <td>Size</td>
+  </tr>
+''';
+      var server = response.headers.value(HttpHeaders.SERVER);
+      if (server == null) server = "";
+      var footer =
+'''</table>
+$server
+</body>
+</html>
+''';
+
+      response.write(header);
+
+      void add(String name, String modified, var size) {
+        if (size == null) size = "-";
+        if (modified == null) modified = "";
+        var p = new Path(path).append(name).canonicalize().toString();
+        var entry =
+'''  <tr>
+    <td><a href="$p">$name</a></td>
+    <td>$modified</td>
+    <td style="text-align: right">$size</td>
+  </tr>''';
+        response.write(entry);
+      }
+
+      if (path != '/') {
+        add('../', null, null);
+      }
+
+      dir.list(followLinks: true).listen((entity) {
+        // TODO(ajohnsen): Consider async dir listing.
+        if (entity is File) {
+          add(new Path(entity.path).filename,
+              entity.statSync().modified.toString(),
+              entity.lengthSync());

[Bill Hesse, 2013/06/28 12:42:26]

length is part of stat, so you should just call statSync once.

[Anders Johnsen, 2013/06/28 12:49:36]

Done.

+        } else if (entity is Directory) {
+          add(new Path(entity.path).filename + '/',
+              entity.statSync().modified.toString(),
+              null);
+        }
+      }, onError: (e) {
+      }, onDone: () {
+        response.write(footer);
+        response.close();
+      });
+    }, onError: (e) => response.close());
+  }
+
   void _serveErrorPage(int error, HttpRequest request) {
     var response = request.response;
     response.statusCode = error;
     if (_errorCallback != null) {
       _errorCallback(request);
       return;
     }
     // Default error page.
     var path = request.uri.path;
     var reason = response.reasonPhrase;
-    response.write(
-        '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"\n');
-    response.writeln(
-        '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">');
-    response.writeln('<html xmlns="http://www.w3.org/1999/xhtml">');
-    response.writeln('<head>');
-    response.writeln('<title>$reason: $path</title>');
-    response.writeln('</head>');
-    response.writeln('<body>');
-    response.writeln('<h1>Error $error at \'$path\': $reason</h1>');
+
     var server = response.headers.value(HttpHeaders.SERVER);
-    if (server != null) {
-      response.writeln(server);
-    }
-    response.writeln('</body>');
-    response.writeln('</html>');
+    if (server == null) server = "";
+    var page =
+'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>$reason: $path</title>
+</head>
+<body>
+<h1>Error $error at \'$path\': $reason</h1>
+$server
+</body>
+</html>''';
+    response.write(page);
     response.close();
   }
 }
 
 class _VirtualDirectoryFileStream extends StreamConsumer<List<int>> {
   final HttpResponse response;
   final String path;
   var buffer = [];
 
   _VirtualDirectoryFileStream(HttpResponse this.response, String this.path);
@@ skipping 39 matching lines @@
 
   Future close() => new Future.value();
 
   void setMimeType(var bytes) {
     var mimeType = lookupMimeType(path, headerBytes: bytes);
     if (mimeType != null) {
       response.headers.contentType = ContentType.parse(mimeType);
     }
   }
 }