pkg/http_server/lib/src/virtual_directory.dart - sdk.git - Git at Google

 // 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.
  *
  * The [VirtualDirectory] providing secure handling of request uris and
  * file-system links, correct mime-types and custom error pages.
  */
 abstract class VirtualDirectory {
   final String root;

   /**
    * Set or get if the [VirtualDirectory] should list the content of
    * directories.
    */
   bool allowDirectoryListing = false;

   /**
    * Set or get if the [VirtualDirectory] should follow links, that point
    * to other resources within the [root] directory.
    */
   bool followLinks = true;

   /*
    * Create a new [VirtualDirectory] for serving static file content of
    * the path [root].
    *
    * The [root] is not required to exist. If the [root] doesn't exist at time of
    * a request, a 404 is generated.
    */
   factory VirtualDirectory(String root) => new _VirtualDirectory(root);

   /**
    * 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;

   final RegExp _invalidPathRegExp = new RegExp("[\\\/\x00]");

   Function _errorCallback;
   Function _dirCallback;

   _VirtualDirectory(this.root);

   void serve(Stream<HttpRequest> requests) {
     requests.listen(serveRequest);
   }

   void serveRequest(HttpRequest request) {
     _locateResource(new Path('.'), request.uri.pathSegments.iterator..moveNext())
         .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,
                                            Iterator<String> segments) {
     path = path.canonicalize();
     if (path.segments().first == "..") return new Future.value(null);
     Path fullPath() => new Path(root).join(path);
     return FileSystemEntity.type(fullPath().toNativePath(), followLinks: false)
         .then((type) {
           switch (type) {
             case FileSystemEntityType.FILE:
               if (segments.current == null) {
                 return new File.fromPath(fullPath());
               }
               break;

             case FileSystemEntityType.DIRECTORY:
               if (segments.current == null) {
                 if (allowDirectoryListing) {
                   return new Directory.fromPath(fullPath());
                 }
               } else {
                 if (_invalidPathRegExp.hasMatch(segments.current)) break;
                 return _locateResource(path.append(segments.current),
                                        segments..moveNext());
               }
               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);
                       return _locateResource(targetPath, segments);
                     });
               }
               break;
           }
           // Return `null` on fall-through, to indicate NOT_FOUND.
           return null;
         });
   }

   void _serveFile(File file, HttpRequest request) {
     var response = request.response;
     // TODO(ajohnsen): Set up Zone support for these errors.
     file.lastModified().then((lastModified) {
       if (request.headers.ifModifiedSince != null &&
           !lastModified.isAfter(request.headers.ifModifiedSince)) {
         response.statusCode = HttpStatus.NOT_MODIFIED;
         response.close();
         return;
       }

       response.headers.set(HttpHeaders.LAST_MODIFIED, lastModified);
       response.headers.set(HttpHeaders.ACCEPT_RANGES, "bytes");

       if (request.method == 'HEAD') {
         response.close();
         return;
       }

       return file.length().then((length) {
         String range = request.headers.value("range");
         if (range != null) {
           // We only support one range, where the standard support several.
           Match matches = new RegExp(r"^bytes=(\d*)\-(\d*)$").firstMatch(range);
           // If the range header have the right format, handle it.
           if (matches != null) {
             // Serve sub-range.
             int start;
             int end;
             if (matches[1].isEmpty) {
               start = matches[2].isEmpty ?
                   length :
                   length - int.parse(matches[2]);
               end = length;
             } else {
               start = int.parse(matches[1]);
               end = matches[2].isEmpty ? length : int.parse(matches[2]) + 1;
             }

             // Override Content-Length with the actual bytes sent.
             response.headers.set(HttpHeaders.CONTENT_LENGTH, end - start);

             // Set 'Partial Content' status code.
             response.statusCode = HttpStatus.PARTIAL_CONTENT;
             response.headers.set(HttpHeaders.CONTENT_RANGE,
                                  "bytes $start-${end - 1}/$length");

             // Pipe the 'range' of the file.
             file.openRead(start, end)
                 .pipe(new _VirtualDirectoryFileStream(response, file.path))
                 .catchError((_) {});
             return;
           }
         }

         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) {
           var stat = entity.statSync();
           add(new Path(entity.path).filename,
               stat.modified.toString(),
               stat.size);
         } 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;

     var server = response.headers.value(HttpHeaders.SERVER);
     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);

   Future addStream(Stream<List<int>> stream) {
     stream.listen(
         (data) {
           if (buffer == null) {
             response.add(data);
             return;
           }
           if (buffer.length == 0) {
             if (data.length >= defaultMagicNumbersMaxLength) {
               setMimeType(data);
               response.add(data);
               buffer = null;
             } else {
               buffer.addAll(data);
             }
           } else {
             buffer.addAll(data);
             if (buffer.length >= defaultMagicNumbersMaxLength) {
               setMimeType(buffer);
               response.add(buffer);
               buffer = null;
             }
           }
         },
         onDone: () {
           if (buffer != null) {
             if (buffer.length == 0) {
               setMimeType(null);
             } else {
               setMimeType(buffer);
               response.add(buffer);
             }
           }
           response.close();
         },
         onError: response.addError);
     return response.done;
   }

   Future close() => new Future.value();

   void setMimeType(var bytes) {
     var mimeType = lookupMimeType(path, headerBytes: bytes);
     if (mimeType != null) {
       response.headers.contentType = ContentType.parse(mimeType);
     }
   }
 }
	// 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.
	*
	* The [VirtualDirectory] providing secure handling of request uris and
	* file-system links, correct mime-types and custom error pages.
	*/
	abstract class VirtualDirectory {
	final String root;

	/**
	* Set or get if the [VirtualDirectory] should list the content of
	* directories.
	*/
	bool allowDirectoryListing = false;

	/**
	* Set or get if the [VirtualDirectory] should follow links, that point
	* to other resources within the [root] directory.
	*/
	bool followLinks = true;

	/*
	* Create a new [VirtualDirectory] for serving static file content of
	* the path [root].
	*
	* The [root] is not required to exist. If the [root] doesn't exist at time of
	* a request, a 404 is generated.
	*/
	factory VirtualDirectory(String root) => new _VirtualDirectory(root);

	/**
	* 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;

	final RegExp _invalidPathRegExp = new RegExp("[\\\/\x00]");

	Function _errorCallback;
	Function _dirCallback;

	_VirtualDirectory(this.root);

	void serve(Stream<HttpRequest> requests) {
	requests.listen(serveRequest);
	}

	void serveRequest(HttpRequest request) {
	_locateResource(new Path('.'), request.uri.pathSegments.iterator..moveNext())
	.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,
	Iterator<String> segments) {
	path = path.canonicalize();
	if (path.segments().first == "..") return new Future.value(null);
	Path fullPath() => new Path(root).join(path);
	return FileSystemEntity.type(fullPath().toNativePath(), followLinks: false)
	.then((type) {
	switch (type) {
	case FileSystemEntityType.FILE:
	if (segments.current == null) {
	return new File.fromPath(fullPath());
	}
	break;

	case FileSystemEntityType.DIRECTORY:
	if (segments.current == null) {
	if (allowDirectoryListing) {
	return new Directory.fromPath(fullPath());
	}
	} else {
	if (_invalidPathRegExp.hasMatch(segments.current)) break;
	return _locateResource(path.append(segments.current),
	segments..moveNext());
	}
	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);
	return _locateResource(targetPath, segments);
	});
	}
	break;
	}
	// Return `null` on fall-through, to indicate NOT_FOUND.
	return null;
	});
	}

	void _serveFile(File file, HttpRequest request) {
	var response = request.response;
	// TODO(ajohnsen): Set up Zone support for these errors.
	file.lastModified().then((lastModified) {
	if (request.headers.ifModifiedSince != null &&
	!lastModified.isAfter(request.headers.ifModifiedSince)) {
	response.statusCode = HttpStatus.NOT_MODIFIED;
	response.close();
	return;
	}

	response.headers.set(HttpHeaders.LAST_MODIFIED, lastModified);
	response.headers.set(HttpHeaders.ACCEPT_RANGES, "bytes");

	if (request.method == 'HEAD') {
	response.close();
	return;
	}

	return file.length().then((length) {
	String range = request.headers.value("range");
	if (range != null) {
	// We only support one range, where the standard support several.
	Match matches = new RegExp(r"^bytes=(\d)\-(\d)$").firstMatch(range);
	// If the range header have the right format, handle it.
	if (matches != null) {
	// Serve sub-range.
	int start;
	int end;
	if (matches[1].isEmpty) {
	start = matches[2].isEmpty ?
	length :
	length - int.parse(matches[2]);
	end = length;
	} else {
	start = int.parse(matches[1]);
	end = matches[2].isEmpty ? length : int.parse(matches[2]) + 1;
	}

	// Override Content-Length with the actual bytes sent.
	response.headers.set(HttpHeaders.CONTENT_LENGTH, end - start);

	// Set 'Partial Content' status code.
	response.statusCode = HttpStatus.PARTIAL_CONTENT;
	response.headers.set(HttpHeaders.CONTENT_RANGE,
	"bytes $start-${end - 1}/$length");

	// Pipe the 'range' of the file.
	file.openRead(start, end)
	.pipe(new _VirtualDirectoryFileStream(response, file.path))
	.catchError((_) {});
	return;
	}
	}

	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) {
	var stat = entity.statSync();
	add(new Path(entity.path).filename,
	stat.modified.toString(),
	stat.size);
	} 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;

	var server = response.headers.value(HttpHeaders.SERVER);
	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);

	Future addStream(Stream<List<int>> stream) {
	stream.listen(
	(data) {
	if (buffer == null) {
	response.add(data);
	return;
	}
	if (buffer.length == 0) {
	if (data.length >= defaultMagicNumbersMaxLength) {
	setMimeType(data);
	response.add(data);
	buffer = null;
	} else {
	buffer.addAll(data);
	}
	} else {
	buffer.addAll(data);
	if (buffer.length >= defaultMagicNumbersMaxLength) {
	setMimeType(buffer);
	response.add(buffer);
	buffer = null;
	}
	}
	},
	onDone: () {
	if (buffer != null) {
	if (buffer.length == 0) {
	setMimeType(null);
	} else {
	setMimeType(buffer);
	response.add(buffer);
	}
	}
	response.close();
	},
	onError: response.addError);
	return response.done;
	}

	Future close() => new Future.value();

	void setMimeType(var bytes) {
	var mimeType = lookupMimeType(path, headerBytes: bytes);
	if (mimeType != null) {
	response.headers.contentType = ContentType.parse(mimeType);
	}
	}
	}