Home | History | Annotate | Download | only in glue
      1 // Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 //
      5 // A delegate class of WebURLLoaderImpl that handles multipart/x-mixed-replace
      6 // data.  We special case multipart/x-mixed-replace because WebCore expects a
      7 // separate didReceiveResponse for each new message part.
      8 //
      9 // Most of the logic and edge case handling are based on the Mozilla's
     10 // implementation in netwerk/streamconv/converters/nsMultiMixedConv.cpp.
     11 // This seems like a derivative work, so here's the original license:
     12 
     13 /* ***** BEGIN LICENSE BLOCK *****
     14  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
     15  *
     16  * The contents of this file are subject to the Mozilla Public License Version
     17  * 1.1 (the "License"); you may not use this file except in compliance with
     18  * the License. You may obtain a copy of the License at
     19  * http://www.mozilla.org/MPL/
     20  *
     21  * Software distributed under the License is distributed on an "AS IS" basis,
     22  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
     23  * for the specific language governing rights and limitations under the
     24  * License.
     25  *
     26  * The Original Code is mozilla.org code.
     27  *
     28  * The Initial Developer of the Original Code is
     29  * Netscape Communications Corporation.
     30  * Portions created by the Initial Developer are Copyright (C) 1998
     31  * the Initial Developer. All Rights Reserved.
     32  *
     33  * Contributor(s):
     34  *
     35  * Alternatively, the contents of this file may be used under the terms of
     36  * either the GNU General Public License Version 2 or later (the "GPL"), or
     37  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
     38  * in which case the provisions of the GPL or the LGPL are applicable instead
     39  * of those above. If you wish to allow use of your version of this file only
     40  * under the terms of either the GPL or the LGPL, and not to allow others to
     41  * use your version of this file under the terms of the MPL, indicate your
     42  * decision by deleting the provisions above and replace them with the notice
     43  * and other provisions required by the GPL or the LGPL. If you do not delete
     44  * the provisions above, a recipient may use your version of this file under
     45  * the terms of any one of the MPL, the GPL or the LGPL.
     46  *
     47  * ***** END LICENSE BLOCK ***** */
     48 
     49 #ifndef WEBKIT_GLUE_MULTIPART_RESPONSE_DELEGATE_H_
     50 #define WEBKIT_GLUE_MULTIPART_RESPONSE_DELEGATE_H_
     51 
     52 #include <string>
     53 
     54 #include "base/basictypes.h"
     55 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLResponse.h"
     56 
     57 namespace WebKit {
     58 class WebURLLoader;
     59 class WebURLLoaderClient;
     60 }
     61 
     62 namespace webkit_glue {
     63 
     64 // Used by unit tests to access private members.
     65 class MultipartResponseDelegateTester;
     66 
     67 class MultipartResponseDelegate {
     68  public:
     69   MultipartResponseDelegate(WebKit::WebURLLoaderClient* client,
     70                             WebKit::WebURLLoader* loader,
     71                             const WebKit::WebURLResponse& response,
     72                             const std::string& boundary);
     73 
     74   // Passed through from ResourceHandleInternal
     75   void OnReceivedData(const char* data, int data_len, int encoded_data_length);
     76   void OnCompletedRequest();
     77 
     78   // The request has been canceled, so stop making calls to the client.
     79   void Cancel() {
     80     client_ = NULL;
     81     loader_ = NULL;
     82   }
     83 
     84   // Returns the multi part boundary string from the Content-type header
     85   // in the response.
     86   // Returns true on success.
     87   static bool ReadMultipartBoundary(const WebKit::WebURLResponse& response,
     88                                     std::string* multipart_boundary);
     89 
     90   // Returns the lower and higher content ranges from an individual multipart
     91   // in a multipart response.
     92   // Returns true on success.
     93   static bool ReadContentRanges(const WebKit::WebURLResponse& response,
     94                                 int* content_range_lower_bound,
     95                                 int* content_range_upper_bound,
     96                                 int* content_range_instance_size);
     97 
     98  private:
     99   friend class MultipartResponseDelegateTester;  // For unittests.
    100 
    101   // Pointers to the client and associated loader so we can make callbacks as
    102   // we parse pieces of data.
    103   WebKit::WebURLLoaderClient* client_;
    104   WebKit::WebURLLoader* loader_;
    105 
    106   // The original resource response for this request.  We use this as a
    107   // starting point for each parts response.
    108   WebKit::WebURLResponse original_response_;
    109 
    110   // Checks to see if data[pos] character is a line break; handles crlf, lflf,
    111   // lf, or cr. Returns the number of characters to skip over (0, 1 or 2).
    112   int PushOverLine(const std::string& data, size_t pos);
    113 
    114   // Tries to parse http headers from the start of data_.  Returns true if it
    115   // succeeds and sends a didReceiveResponse to m_client.  Returns false if
    116   // the header is incomplete (in which case we just wait for more data).
    117   bool ParseHeaders();
    118 
    119   // Find the next boundary in data_.  Returns std::string::npos if there's no
    120   // full token.
    121   size_t FindBoundary();
    122 
    123   // Transferred data size accumulated between client callbacks.
    124   int encoded_data_length_;
    125 
    126   // A temporary buffer to hold data between reads for multipart data that
    127   // gets split in the middle of a header.
    128   std::string data_;
    129 
    130   // Multipart boundary token
    131   std::string boundary_;
    132 
    133   // true until we get our first on received data call
    134   bool first_received_data_;
    135 
    136   // true if we're truncated in the middle of a header
    137   bool processing_headers_;
    138 
    139   // true when we're done sending information.  At that point, we stop
    140   // processing AddData requests.
    141   bool stop_sending_;
    142 
    143   // true after we've sent our first response to the WebURLLoaderClient.
    144   bool has_sent_first_response_;
    145 
    146   DISALLOW_COPY_AND_ASSIGN(MultipartResponseDelegate);
    147 };
    148 
    149 }  // namespace webkit_glue
    150 
    151 #endif
    152