Reviewed by Darin, Geoff.
[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
39 using namespace std;
40
41 namespace WebCore {
42
43 const size_t defaultBufferSize = 4096; // bigger than most icons
44
45 IconLoader::IconLoader(Frame* frame)
46     : m_frame(frame)
47     , m_loadIsInProgress(false)
48 {
49 }
50
51 auto_ptr<IconLoader> IconLoader::create(Frame* frame)
52 {
53     return auto_ptr<IconLoader>(new IconLoader(frame));
54 }
55
56 IconLoader::~IconLoader()
57 {
58 }
59
60 void IconLoader::startLoading()
61 {    
62     if (m_handle)
63         return;
64
65     // FIXME: http://bugs.webkit.org/show_bug.cgi?id=10902
66     // Once ResourceHandle will load without a DocLoader, we can remove this check.
67     // A frame may be documentless - one example is a frame containing only a PDF.
68     if (!m_frame->document()) {
69         LOG(IconDatabase, "Documentless-frame - icon won't be loaded");
70         return;
71     }
72
73     // Set flag so we can detect the case where the load completes before
74     // ResourceHandle::create returns.
75     m_loadIsInProgress = true;
76     m_buffer.reserveCapacity(defaultBufferSize);
77
78     RefPtr<ResourceHandle> loader = ResourceHandle::create(m_frame->loader()->iconURL(),
79         this, m_frame->document()->docLoader());
80     if (!loader)
81         LOG_ERROR("Failed to start load for icon at url %s", m_frame->loader()->iconURL().url().ascii());
82
83     // Store the handle so we can cancel the load if stopLoading is called later.
84     // But only do it if the load hasn't already completed.
85     if (m_loadIsInProgress)
86         m_handle = loader.release();
87 }
88
89 void IconLoader::stopLoading()
90 {
91     m_handle = 0;
92     clearLoadingState();
93 }
94
95 void IconLoader::didReceiveResponse(ResourceHandle* handle, const ResourceResponse& response)
96 {
97     // If we got a status code indicating an invalid response, then lets
98     // ignore the data and not try to decode the error page as an icon.
99     int status = response.httpStatusCode();
100     if (status && (status < 200 || status > 299)) {
101         KURL iconURL = handle->url();
102         m_handle = 0;
103         finishLoading(iconURL);
104     }
105 }
106
107 void IconLoader::didReceiveData(ResourceHandle*, const char* data, int size)
108 {
109     ASSERT(data || size == 0);
110     ASSERT(size >= 0);
111     m_buffer.append(data, size);
112 }
113
114 void IconLoader::didFailWithError(ResourceHandle* handle, const ResourceError&)
115 {
116     ASSERT(m_loadIsInProgress);
117     m_buffer.clear();
118     finishLoading(handle->url());
119 }
120
121 void IconLoader::didFinishLoading(ResourceHandle* handle)
122 {
123     // If the icon load resulted in an error-response earlier, the ResourceHandle was killed and icon data commited via finishLoading().
124     // In that case this didFinishLoading callback is pointless and we bail.  Otherwise, finishLoading() as expected
125     if (m_loadIsInProgress) {
126         ASSERT(handle == m_handle);
127         finishLoading(handle->url());
128     }
129 }
130
131 void IconLoader::finishLoading(const KURL& iconURL)
132 {
133     IconDatabase::sharedIconDatabase()->setIconDataForIconURL(m_buffer.data(), m_buffer.size(), iconURL.url());
134     m_frame->loader()->commitIconURLToIconDatabase(iconURL);
135     m_frame->loader()->client()->dispatchDidReceiveIcon();
136     clearLoadingState();
137 }
138
139 void IconLoader::clearLoadingState()
140 {
141     m_handle = 0;
142     m_buffer.clear();
143     m_loadIsInProgress = false;
144 }
145
146 }