3603b0fb1ddcdf71ee92fad7712ff55e92aa134c
[WebKit-https.git] / Source / WebKit / mac / WebView / WebResourceLoadDelegate.h
1 /*
2  * Copyright (C) 2003, 2004, 2005 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 @class WebView;
30 @class WebDataSource;
31 @class NSURLAuthenticationChallenge;
32 @class NSURLResponse;
33 @class NSURLRequest;
34
35 /*!
36     @category  WebResourceLoadDelegate
37     @discussion Implementors of this protocol will receive messages indicating
38     that a resource is about to be loaded, data has been received for a resource,
39     an error has been received for a resource, and completion of a resource load.
40     Implementors are also given the opportunity to mutate requests before they are sent.
41     The various progress methods of this protocol all receive an identifier as the
42     parameter.  This identifier can be used to track messages associated with a single
43     resource.  For example, a single resource may generate multiple 
44     resource:willSendRequest:redirectResponse:fromDataSource: messages as it's URL is redirected.
45 */
46 @protocol WebResourceLoadDelegate <NSObject>
47
48 @optional
49 @end
50
51 @interface NSObject (WebResourceLoadDelegate)
52
53 /*!
54     @method webView:identifierForInitialRequest:fromDataSource:
55     @param webView The WebView sending the message.
56     @param request The request about to be sent.
57     @param dataSource The datasource that initiated the load.
58     @discussion An implementor of WebResourceLoadDelegate should provide an identifier
59     that can be used to track the load of a single resource.  This identifier will be
60     passed as the first argument for all of the other WebResourceLoadDelegate methods.  The
61     identifier is useful to track changes to a resources request, which will be
62     provided by one or more calls to resource:willSendRequest:redirectResponse:fromDataSource:.
63     @result An identifier that will be passed back to the implementor for each callback.
64     The identifier will be retained.
65 */
66 - (id)webView:(WebView *)sender identifierForInitialRequest:(NSURLRequest *)request fromDataSource:(WebDataSource *)dataSource;
67
68 /*!
69     @method webView:resource:willSendRequest:redirectResponse:fromDataSource:
70     @discussion This message is sent before a load is initiated.  The request may be modified
71     as necessary by the receiver.
72     @param webView The WebView sending the message.
73     @param identifier An identifier that can be used to track the progress of a resource load across
74     multiple call backs.
75     @param request The request about to be sent.
76     @param redirectResponse If the request is being made in response to a redirect we received,
77     the response that conveyed that redirect.
78     @param dataSource The dataSource that initiated the load.
79     @result Returns the request, which may be mutated by the implementor, although typically
80     will be request.
81 */
82 - (NSURLRequest *)webView:(WebView *)sender resource:(id)identifier willSendRequest:(NSURLRequest *)request redirectResponse:(NSURLResponse *)redirectResponse fromDataSource:(WebDataSource *)dataSource;
83
84 /*!
85     @method webView:resource:didReceiveAuthenticationChallenge:fromDataSource:
86     @abstract Start authentication for the resource, providing a challenge
87     @discussion Call useCredential::, continueWithoutCredential or
88     cancel on the challenge when done.
89     @param challenge The NSURLAuthenticationChallenge to start authentication for
90     @discussion If you do not implement this delegate method, WebKit will handle authentication
91     automatically by prompting with a sheet on the window that the WebView is associated with.
92 */
93 - (void)webView:(WebView *)sender resource:(id)identifier didReceiveAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
94
95 /*!
96     @method webView:resource:didCancelAuthenticationChallenge:fromDataSource:
97     @abstract Cancel authentication for a given request
98     @param challenge The NSURLAuthenticationChallenge for which to cancel authentication
99 */
100 - (void)webView:(WebView *)sender resource:(id)identifier didCancelAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
101
102 /*!
103     @method webView:resource:didReceiveResponse:fromDataSource:
104     @abstract This message is sent after a response has been received for this load.
105     @param webView The WebView sending the message.
106     @param identifier An identifier that can be used to track the progress of a resource load across
107     multiple call backs.
108     @param response The response for the request.
109     @param dataSource The dataSource that initiated the load.
110     @discussion In some rare cases, multiple responses may be received for a single load.
111     This occurs with multipart/x-mixed-replace, or "server push". In this case, the client
112     should assume that each new response resets progress so far for the resource back to 0,
113     and should check the new response for the expected content length.
114 */
115 - (void)webView:(WebView *)sender resource:(id)identifier didReceiveResponse:(NSURLResponse *)response fromDataSource:(WebDataSource *)dataSource;
116
117 /*!
118     @method webView:resource:didReceiveContentLength:fromDataSource:
119     @discussion Multiple of these messages may be sent as data arrives.
120     @param webView The WebView sending the message.
121     @param identifier An identifier that can be used to track the progress of a resource load across
122     multiple call backs.
123     @param length The amount of new data received.  This is not the total amount, just the new amount received.
124     @param dataSource The dataSource that initiated the load.
125 */
126 - (void)webView:(WebView *)sender resource:(id)identifier didReceiveContentLength:(NSInteger)length fromDataSource:(WebDataSource *)dataSource;
127
128 /*!
129     @method webView:resource:didFinishLoadingFromDataSource:
130     @discussion This message is sent after a load has successfully completed.
131     @param webView The WebView sending the message.
132     @param identifier An identifier that can be used to track the progress of a resource load across
133     multiple call backs.
134     @param dataSource The dataSource that initiated the load.
135 */
136 - (void)webView:(WebView *)sender resource:(id)identifier didFinishLoadingFromDataSource:(WebDataSource *)dataSource;
137
138 /*!
139     @method webView:resource:didFailLoadingWithError:fromDataSource:
140     @discussion This message is sent after a load has failed to load due to an error.
141     @param webView The WebView sending the message.
142     @param identifier An identifier that can be used to track the progress of a resource load across
143     multiple call backs.
144     @param error The error associated with this load.
145     @param dataSource The dataSource that initiated the load.
146 */
147 - (void)webView:(WebView *)sender resource:(id)identifier didFailLoadingWithError:(NSError *)error fromDataSource:(WebDataSource *)dataSource;
148
149 /*!
150     @method webView:plugInFailedWithError:dataSource:
151     @discussion Called when a plug-in is not found, fails to load or is not available for some reason.
152     @param webView The WebView sending the message.
153     @param error The plug-in error. In the userInfo dictionary of the error, the object for the
154     NSErrorFailingURLKey key is a URL string of the SRC attribute, the object for the WebKitErrorPlugInNameKey
155     key is a string of the plug-in's name, the object for the WebKitErrorPlugInPageURLStringKey key is a URL string
156     of the PLUGINSPAGE attribute and the object for the WebKitErrorMIMETypeKey key is a string of the TYPE attribute.
157     Some, none or all of the mentioned attributes can be present in the userInfo. The error returns nil for userInfo
158     when none are present.
159     @param dataSource The dataSource that contains the plug-in.
160 */
161 - (void)webView:(WebView *)sender plugInFailedWithError:(NSError *)error dataSource:(WebDataSource *)dataSource;
162
163 @end