2d333f42ca5d9c464cc51f9c6166b738d18d7b26
[WebKit-https.git] / WebCore / loader / icon / IconLoader.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25  
26 #include "config.h"
27 #include "IconLoader.h"
28
29 #include "Document.h"
30 #include "Frame.h"
31 #include "FrameLoader.h"
32 #include "FrameLoaderClient.h"
33 #include "IconDatabase.h"
34 #include "Logging.h"
35 #include "ResourceHandle.h"
36 #include "ResourceResponse.h"
37 #include "ResourceRequest.h"
38 #include "SubresourceLoader.h"
39
40 using namespace std;
41
42 namespace WebCore {
43
44 IconLoader::IconLoader(Frame* frame)
45     : m_frame(frame)
46     , m_loadIsInProgress(false)
47 {
48 }
49
50 auto_ptr<IconLoader> IconLoader::create(Frame* frame)
51 {
52     return auto_ptr<IconLoader>(new IconLoader(frame));
53 }
54
55 IconLoader::~IconLoader()
56 {
57 }
58
59 void IconLoader::startLoading()
60 {    
61     if (m_resourceLoader)
62         return;
63
64     // FIXME: http://bugs.webkit.org/show_bug.cgi?id=10902
65     // Once ResourceHandle will load without a DocLoader, we can remove this check.
66     // A frame may be documentless - one example is a frame containing only a PDF.
67     if (!m_frame->document()) {
68         LOG(IconDatabase, "Documentless-frame - icon won't be loaded");
69         return;
70     }
71
72     // Set flag so we can detect the case where the load completes before
73     // SubresourceLoader::create returns.
74     m_loadIsInProgress = true;
75
76     RefPtr<SubresourceLoader> loader = SubresourceLoader::create(m_frame, this, m_frame->loader()->iconURL());
77     if (!loader)
78         LOG_ERROR("Failed to start load for icon at url %s", m_frame->loader()->iconURL().string().ascii().data());
79
80     // Store the handle so we can cancel the load if stopLoading is called later.
81     // But only do it if the load hasn't already completed.
82     if (m_loadIsInProgress)
83         m_resourceLoader = loader.release();
84 }
85
86 void IconLoader::stopLoading()
87 {
88     clearLoadingState();
89 }
90
91 void IconLoader::didReceiveResponse(SubresourceLoader* resourceLoader, const ResourceResponse& response)
92 {
93     // If we got a status code indicating an invalid response, then lets
94     // ignore the data and not try to decode the error page as an icon.
95     int status = response.httpStatusCode();
96     LOG(IconDatabase, "IconLoader::didReceiveResponse() - Loader %p, response %i", resourceLoader, status);
97
98     if (status && (status < 200 || status > 299)) {
99         ResourceHandle* handle = resourceLoader->handle();
100         finishLoading(handle ? handle->request().url() : KURL(), 0);
101     }
102 }
103
104 void IconLoader::didReceiveData(SubresourceLoader* loader, const char*, int size)
105 {
106     LOG(IconDatabase, "IconLoader::didReceiveData() - Loader %p, number of bytes %i", loader, size);
107 }
108
109 void IconLoader::didFail(SubresourceLoader* resourceLoader, const ResourceError&)
110 {
111     LOG(IconDatabase, "IconLoader::didFail() - Loader %p", resourceLoader);
112     
113     // Until <rdar://problem/5463392> is resolved and we can properly cancel SubresourceLoaders when they get an error response,
114     // we need to be prepared to receive this call even after we've "finished loading" once.
115     // After it is resolved, we can restore an assertion that the load is in progress if ::didFail() is called
116     
117     if (m_loadIsInProgress) {
118         ASSERT(resourceLoader == m_resourceLoader);
119         ResourceHandle* handle = resourceLoader->handle();
120         finishLoading(handle ? handle->request().url() : KURL(), 0);
121     }
122 }
123
124 void IconLoader::didFinishLoading(SubresourceLoader* resourceLoader)
125 {
126     LOG(IconDatabase, "IconLoader::didFinishLoading() - Loader %p", resourceLoader);
127
128     // Until <rdar://problem/5463392> is resolved and we can properly cancel SubresourceLoaders when they get an error response,
129     // we need to be prepared to receive this call even after we've "finished loading" once.
130     // After it is resolved, we can restore an assertion that the load is in progress if ::didFail() is called
131     
132     if (m_loadIsInProgress) {
133         ASSERT(resourceLoader == m_resourceLoader);
134         ResourceHandle* handle = resourceLoader->handle();
135         finishLoading(handle ? handle->request().url() : KURL(), m_resourceLoader->resourceData());
136     }
137 }
138
139 void IconLoader::finishLoading(const KURL& iconURL, PassRefPtr<SharedBuffer> data)
140 {
141     // When an icon load results in a 404 we commit it to the database here and clear the loading state.  
142     // But the SubresourceLoader continues pulling in data in the background for the 404 page if the server sends one.  
143     // Once that data finishes loading or if the load is cancelled while that data is being read, finishLoading ends up being called a second time.
144     // We need to change SubresourceLoader to have a mode where it will stop itself after receiving a 404 so this won't happen -
145     // in the meantime, we'll only commit this data to the IconDatabase if it's the first time ::finishLoading() is called
146     // <rdar://problem/5463392> tracks that enhancement
147     
148     if (!iconURL.isEmpty() && m_loadIsInProgress) {
149         iconDatabase()->setIconDataForIconURL(data, iconURL.string());
150         LOG(IconDatabase, "IconLoader::finishLoading() - Committing iconURL %s to database", iconURL.string().ascii().data());
151         m_frame->loader()->commitIconURLToIconDatabase(iconURL);
152         m_frame->loader()->client()->dispatchDidReceiveIcon();
153     }
154
155     clearLoadingState();
156 }
157
158 void IconLoader::clearLoadingState()
159 {
160     m_resourceLoader = 0;
161     m_loadIsInProgress = false;
162 }
163
164 }