Re-implement support for client redirects.

sdk/lib/io/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.
 
 part of dart.io;
 
 /**
  * HTTP status codes.
  */
 abstract class HttpStatus {
@@ skipping 827 matching lines @@
  *
  * The setting of all handlers is optional. If [onRequest] is not set
  * the request will be send without any additional headers and an
  * empty body. If [onResponse] is not set the response will be read
  * and discarded.
  */
 abstract class HttpClientConnection {
   // TODO(ajohnsen): Move these methods to the right place (request or response)
 
   /**
-   * Set this property to [:true:] if this connection should
-   * automatically follow redirects. The default is [:true:].
-   *
-   * Automatic redirect will only happen for "GET" and "HEAD" requests
-   * and only for the status codes [:HttpHeaders.MOVED_PERMANENTLY:]
-   * (301), [:HttpStatus.FOUND:] (302),
-   * [:HttpStatus.MOVED_TEMPORARILY:] (302, alias for
-   * [:HttpStatus.FOUND:]), [:HttpStatus.SEE_OTHER:] (303) and
-   * [:HttpStatus.TEMPORARY_REDIRECT:] (307). For
-   * [:HttpStatus.SEE_OTHER:] (303) autmatic redirect will also happen
-   * for "POST" requests with the method changed to "GET" when
-   * following the redirect.
-   *
-   * All headers added to the request will be added to the redirection
-   * request(s). However, any body send with the request will not be
-   * part of the redirection request(s).
-   */
-  bool followRedirects;
-
-  /**
-   * Set this property to the maximum number of redirects to follow
-   * when [followRedirects] is [:true:]. If this number is exceeded the
-   * [onError] callback will be called with a [RedirectLimitExceeded]
-   * exception. The default value is 5.
-   */
-  int maxRedirects;
-
-  /**
-   * Returns the series of redirects this connection has been through.
-   */
-  List<RedirectInfo> get redirects;
-
-  /**
-   * 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 [:HttpHeaders.LOCATION:] header of
-   * the current response. All body data must have been read from the
-   * current response before calling [redirect].
-   *
-   * All headers added to the request will be added to the redirection
-   * request(s). However, any body send with the request will not be
-   * part of the redirection request(s).
-   */
-  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 44 matching lines @@
    * A [HttpClientResponse] future that will complete once the response is
    * available. If an error occours before the response is available, this
    * future will complete with an error.
    */
   Future<HttpClientResponse> get response;
 
   /**
    * Close the request for input. Returns the value of [response].
    */
   Future<HttpClientResponse> close();
+
+  /**
+   * Set this property to the maximum number of redirects to follow
+   * when [followRedirects] is [:true:]. If this number is exceeded the
+   * [onError] callback will be called with a [RedirectLimitExceeded]
+   * exception. The default value is 5.
+   */
+  int maxRedirects;

[Søren Gjesse, 2013/01/09 08:43:49]

Place maxRedirects after followRedirects.

[Anders Johnsen, 2013/01/09 10:03:00]

Done.

+
+  /**
+   * Set this property to [:true:] if this request should
+   * automatically follow redirects. The default is [:true:].
+   *
+   * Automatic redirect will only happen for "GET" and "HEAD" requests
+   * and only for the status codes [:HttpHeaders.MOVED_PERMANENTLY:]
+   * (301), [:HttpStatus.FOUND:] (302),
+   * [:HttpStatus.MOVED_TEMPORARILY:] (302, alias for
+   * [:HttpStatus.FOUND:]), [:HttpStatus.SEE_OTHER:] (303) and
+   * [:HttpStatus.TEMPORARY_REDIRECT:] (307). For
+   * [:HttpStatus.SEE_OTHER:] (303) autmatic redirect will also happen
+   * for "POST" requests with the method changed to "GET" when
+   * following the redirect.
+   *
+   * All headers added to the request will be added to the redirection
+   * request(s). However, any body send with the request will not be
+   * part of the redirection request(s).
+   */
+  bool followRedirects;
 }
 
 
 /**
  * HTTP response for a client connection. The [HttpClientResponse] is a
  * [Stream] of the body content of the response. Listen to the body to handle
  * the data and be notified once the entire body is received.
 
  */
 abstract class HttpClientResponse implements Stream<List<int>> {
@@ skipping 20 matching lines @@
 
   /**
    * 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 series of redirects this connection has been through.

[Søren Gjesse, 2013/01/09 08:43:49]

Document that no redirects is the empty list and not null.

[Anders Johnsen, 2013/01/09 10:03:00]

Done.

+   */
+  List<RedirectInfo> get redirects;
+
+  /**
+   * 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 [:HttpHeaders.LOCATION:] header of
+   * the current response. All body data must have been read from the
+   * current response before calling [redirect].
+   *
+   * All headers added to the request will be added to the redirection
+   * request(s). However, any body send with the request will not be
+   * part of the redirection request(s).
+   *
+   * If [followLoops] is set to [true], redirect will follow the redirect,
+   * even if was already visited. Default value is [false].

[Søren Gjesse, 2013/01/09 08:43:49]

Maybe we need to add some additional documentation on the logic with respect to
maxRedirects when using manual redirects and that the [redirects] is updated
both for manual and automatic redirects.

[Anders Johnsen, 2013/01/09 10:03:00]

Done.

+   */
+  Future<HttpClientResponse> redirect([String method,
+                                       Uri url,
+                                       bool followLoops]);
+
+
+  /**
    * Returns the response headers.
    */
   HttpHeaders get headers;
 
   /**
    * Cookies set by the server (from the Set-Cookie header).
    */
   List<Cookie> get cookies;
 
   /**
@@ skipping 86 matching lines @@
 class RedirectLimitExceededException extends RedirectException {
   const RedirectLimitExceededException(List<RedirectInfo> redirects)
       : super("Redirect limit exceeded", redirects);
 }
 
 
 class RedirectLoopException extends RedirectException {
   const RedirectLoopException(List<RedirectInfo> redirects)
       : super("Redirect loop detected", redirects);
 }