Add redirect support to the HTTP client

runtime/bin/http.dart

 // Copyright (c) 2012, 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.
 
 /**
  * HTTP status codes.
  */
 interface HttpStatus {
   static final int CONTINUE = 100;
   static final int SWITCHING_PROTOCOLS = 101;
@@ skipping 488 matching lines @@
    */
   void set onResponse(void callback(HttpClientResponse response));
 
   /**
    * Sets the handler that gets called if an error occurs while
    * connecting or processing the HTTP request.
    */
   void set onError(void callback(e));
 
   /**
+   * Set this property to [:true:] if this connection should
+   * automatically follow redirects. The default is [:false:].

[Anders Johnsen, 2012/05/08 12:58:16]

I can see wget does this by default. Why would we not?

[Søren Gjesse, 2012/05/08 13:32:16]

Well we can - changed the default to true.

+   */
+  bool followRedirect;
+
+  /**
+   * Set this property to the maximum number of redirects to follow
+   * when [followRedirect] is [:true:]. If this number is exceeded the
+   * [onError] callback will be called with an [RedirectLimitExceeded]

[Mads Ager (google), 2012/05/08 12:48:53]

an -> a?

[Søren Gjesse, 2012/05/08 13:32:16]

Done.

+   * exception. The default value is 5.
+   */
+  int maxRedirects;
+
+  /**
+   * Returns the series of redirects this connection has been through.
+   */
+  List<RedirectInfo> get redirects();

[Anders Johnsen, 2012/05/08 12:58:16]

Really cool!

[Søren Gjesse, 2012/05/08 13:32:16]

Thanks.

+
+  /**
+   * Redirect this connection to a new URL. The default value for
+   * [method] is the method for the current request. The default value
+   * for [url] is the value of the [:HttpStatus.LOCATION:] header of
+   * the current response. All body data nost have been read from the

[Mads Ager (google), 2012/05/08 12:48:53]

nost -> must

[Anders Johnsen, 2012/05/08 12:58:16]

nost->most.

[Søren Gjesse, 2012/05/08 13:32:16]

Done.

[Søren Gjesse, 2012/05/08 13:32:16]

most -> must :-)

+   * current response before calling [redirect].
+   */
+  void redirect([String method, Uri url]);
+
+  /**
    * Detach the underlying socket from the HTTP client. When the
    * socket is detached the HTTP client will no longer perform any
    * operations on it.
    *
    * This is normally used when a HTTP upgrade is negotiated and the
    * communication should continue with a different protocol.
    */
   DetachedSocket detachSocket();
 }
 
@@ skipping 41 matching lines @@
    */
   String get reasonPhrase();
 
   /**
    * Returns the content length of the request body. If the size of
    * the request body is not known in advance this -1.
    */
   int get contentLength();
 
   /**
+   * Returns whether the status code is one of the normal redirect
+   * codes [:HttpStatus.MOVED_PERMANENTLY:], [:HttpStatus.FOUND:],
+   * [:HttpStatus.MOVED_TEMPORARILY:], [:HttpStatus.SEE_OTHER:] and
+   * [:HttpStatus.TEMPORARY_REDIRECT:].
+   */
+  bool get isRedirect();
+
+  /**
    * Returns the response headers.
    */
   HttpHeaders get headers();
 
   /**
    * Returns the input stream for the response. This is used to read
    * the response data.
    */
   InputStream get inputStream();
 }
 
 
 /**
+ * Redirect information.
+ */
+interface RedirectInfo {
+  /**
+   * Returns the status code used for the redirect.
+   */
+  int get statusCode();
+
+  /**
+   * Returns the method used for the redirect.
+   */
+  String get method();
+
+  /**
+   * Returns the location for the redirect.
+   */
+  Uri get location();
+}
+
+
+/**
  * When detaching a socket from either the [:HttpServer:] or the
  * [:HttpClient:] due to a HTTP connection upgrade there might be
  * unparsed data already read from the socket. This unparsed data
  * together with the detached socket is returned in an instance of
  * this class.
  */
 interface DetachedSocket default _DetachedSocket {
   Socket get socket();
   List<int> get unparsedData();
 }
 
 
 class HttpException implements Exception {
   const HttpException([String this.message = ""]);
   String toString() => "HttpException: $message";
   final String message;
 }
+
+
+class RedirectException extends HttpException {
+  const RedirectException(String message,
+                          List<RedirectInfo> this.redirects) : super(message);
+  final List<RedirectInfo> redirects;
+}
+
+
+class RedirectLimitExceeded extends RedirectException {
+  const RedirectLimitExceeded(List<RedirectInfo> redirects)
+      : super("Redirect limit exceeded", redirects);
+}
+
+
+class RedirectLoop extends RedirectException {
+  const RedirectLoop(List<RedirectInfo> redirects)
+      : super("Redirect loop detected", redirects);
+}