Support for cookies in the HTTP library

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 259 matching lines @@
   void removeAll(String name);
 
   /**
    * Enumerate the headers applying the function [f] to each
    * header. The header name passed in [name] will be all lower
    * case.
    */
   void forEach(void f(String name, List<String> values));
 
   /**
+   * Disable folding for the header named [name] when sending the HTTP
+   * header. By default, multiple header values are folded into a
+   * single header line by separating the values with commas. The
+   * Set-Cookie header has folding disabled by default.
+   */
+  void noFolding(String name);
+
+  /**
    * Gets and sets the date. The value of this property will
    * reflect the "Date" header
    */
   Date date;
 
   /**
    * Gets and sets the expiry date. The value of this property will
    * reflect the "Expires" header
    */
   Date expires;
@@ skipping 71 matching lines @@
    * Gets the map of parameters.
    */
   Map<String, String> get parameters();
 
   /**
    * Returns the formatted string representation in the form:
    *
    *     value; parameter1=value1; parameter2=value2
    */
   String toString();
-
 }
 
 
 /**
  * Representation of a content type.
  */
 interface ContentType extends HeaderValue default _ContentType {
   /**
    * Creates a new content type object setting the primary type and
    * sub type. If either is not passed their values will be the empty
@@ skipping 30 matching lines @@
   String subType;
 
   /**
    * Gets and sets the character set.
    */
   String charset;
 }
 
 
 /**
+ * Representation of a cookie. For cookies received by the server as
+ * Cookie header values only [:name:] and [:value:] fields will be
+ * set. When building a cookie for the Set-Cookie header in the server
+ * and when receiving cookies in the client as Set-Cookie headers all
+ * fields can be used.
+ */
+interface Cookie default _Cookie {
+  /**
+   * Creates a new cookie optionally setting the name and value.
+   */
+  Cookie([String name, String value]);
+
+  /**
+   * Creates a new cookie by parsing a header value from a Set-Cookie
+   * header.
+   */
+  Cookie.fromSetCookieValue(String value);
+
+  /**
+   * Gets and sets the name.
+   */
+  String name;
+
+  /**
+   * Gets and sets the value.
+   */
+  String value;
+
+  /**
+   * Gets and sets the expiry date.
+   */
+  Date expires;
+
+  /**
+   * Gets and sets the max age. A value of [:0:] means delete cookie
+   * now.
+   */
+  int maxAge;
+
+  /**
+   * Gets and sets the domain.
+   */
+  String domain;
+
+  /**
+   * Gets and sets the path.
+   */
+  String path;
+
+  /**
+   * Gets and sets whether this cookie is secure.
+   */
+  bool secure;
+
+  /**
+   * Gets and sets whether this cookie is HTTP only.
+   */
+  bool httpOnly;
+
+  /**
+   * Returns the formatted string representation of the cookie. The
+   * string representation can be used for for setting the Cookie or
+   * Set-Cookie headers
+   */
+  String toString();
+}
+
+
+/**
  * Http request delivered to the HTTP server callback.
  */
 interface HttpRequest default _HttpRequest {
   /**
    * 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();
 
   /**
@@ skipping 25 matching lines @@
    * Returns the parsed query string.
    */
   Map<String, String> get queryParameters();
 
   /**
    * Returns the request headers.
    */
   HttpHeaders get headers();
 
   /**
+   * Returns the cookies in the request (from the Cookie header).
+   */
+  List<Cookie> get cookies();
+
+  /**
    * Returns the input stream for the request. This is used to read
    * the request data.
    */
   InputStream get inputStream();
 
   /**
    * Returns the HTTP protocol version used in the request. This will
    * be "1.0" or "1.1".
    */
   String get protocolVersion();
@@ skipping 30 matching lines @@
    * request.
    */
   bool persistentConnection;
 
   /**
    * Returns the response headers.
    */
   HttpHeaders get headers();
 
   /**
+   * Cookies to set in the client (in the Set-Cookie header).
+   */
+  List<Cookie> get cookies();
+
+  /**
    * Returns the output stream for the response. This is used to write
    * the response data. When all response data has been written close
    * the stream to indicate the end of the response.
    *
    * When this is accessed for the first time the response header is
    * send. Calling any methods that will change the header after
    * having retrieved the output stream will throw an exception.
    */
   OutputStream get outputStream();
 
@@ skipping 150 matching lines @@
    * which is also the default.
    */
   int contentLength;
 
   /**
    * Returns the request headers.
    */
   HttpHeaders get headers();
 
   /**
+   * Cookies to present to the server (in the Cookie header).
+   */
+  List<Cookie> get cookies();
+
+  /**
    * Returns the output stream for the request. This is used to write
    * the request data. When all request data has been written close
    * the stream to indicate the end of the request.
    *
    * When this is accessed for the first time the request header is
    * send. Calling any methods that will change the header after
    * having retrieved the output stream will throw an exception.
    */
   OutputStream get outputStream();
 }
@@ skipping 26 matching lines @@
    * [:HttpStatus.TEMPORARY_REDIRECT:].
    */
   bool get isRedirect();
 
   /**
    * Returns the response headers.
    */
   HttpHeaders get headers();
 
   /**
+   * Cookies set by the server (from the Set-Cookie header).
+   */
+  List<Cookie> get cookies();
+
+  /**
    * Returns the input stream for the response. This is used to read
    * the response data.
    */
   InputStream get inputStream();
 }
 
 
 /**
  * Redirect information.
  */
@@ skipping 45 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);
 }