Re-landing:
[WebKit-https.git] / Source / WebCore / loader / icon / IconLoader.cpp
1 /*
2  * Copyright (C) 2006 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  * 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 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 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 "CachedRawResource.h"
30 #include "CachedResourceLoader.h"
31 #include "CachedResourceRequest.h"
32 #include "CachedResourceRequestInitiators.h"
33 #include "Document.h"
34 #include "Frame.h"
35 #include "FrameLoader.h"
36 #include "FrameLoaderClient.h"
37 #include "IconController.h"
38 #include "IconDatabase.h"
39 #include "Logging.h"
40 #include "ResourceRequest.h"
41 #include "SharedBuffer.h"
42 #include <wtf/text/CString.h>
43
44 namespace WebCore {
45
46 IconLoader::IconLoader(Frame& frame)
47     : m_frame(&frame)
48     , m_url(frame.loader().icon().url())
49 {
50 }
51
52 IconLoader::IconLoader(DocumentLoader& documentLoader, const URL& url)
53     : m_documentLoader(&documentLoader)
54     , m_url(url)
55 {
56 }
57
58 IconLoader::~IconLoader()
59 {
60     stopLoading();
61 }
62
63 void IconLoader::startLoading()
64 {
65     ASSERT(m_frame || m_documentLoader);
66
67     if (m_resource)
68         return;
69
70     if (m_frame && !m_frame->document())
71         return;
72
73
74     if (m_documentLoader && !m_documentLoader->frame())
75         return;
76
77     ResourceRequest resourceRequest = m_documentLoader ? m_url :  m_frame->loader().icon().url();
78     resourceRequest.setPriority(ResourceLoadPriority::Low);
79
80     // ContentSecurityPolicyImposition::DoPolicyCheck is a placeholder value. It does not affect the request since Content Security Policy does not apply to raw resources.
81     CachedResourceRequest request(WTFMove(resourceRequest), ResourceLoaderOptions(SendCallbacks, SniffContent, BufferData, DoNotAllowStoredCredentials, ClientCredentialPolicy::CannotAskClientForCredentials, FetchOptions::Credentials::Omit, DoSecurityCheck, FetchOptions::Mode::NoCors, DoNotIncludeCertificateInfo, ContentSecurityPolicyImposition::DoPolicyCheck, DefersLoadingPolicy::AllowDefersLoading, CachingPolicy::AllowCaching));
82
83     request.setInitiator(cachedResourceRequestInitiators().icon);
84
85     auto* frame = m_frame ? m_frame : m_documentLoader->frame();
86     m_resource = frame->document()->cachedResourceLoader().requestRawResource(WTFMove(request));
87     if (m_resource)
88         m_resource->addClient(*this);
89     else
90         LOG_ERROR("Failed to start load for icon at url %s", resourceRequest.url().string().ascii().data());
91 }
92
93 void IconLoader::stopLoading()
94 {
95     if (m_resource) {
96         m_resource->removeClient(*this);
97         m_resource = nullptr;
98     }
99 }
100
101 void IconLoader::notifyFinished(CachedResource& resource)
102 {
103     ASSERT_UNUSED(resource, &resource == m_resource);
104
105     // If we got a status code indicating an invalid response, then lets
106     // ignore the data and not try to decode the error page as an icon.
107     auto* data = m_resource->resourceBuffer();
108     int status = m_resource->response().httpStatusCode();
109     if (status && (status < 200 || status > 299))
110         data = nullptr;
111
112     static const char pdfMagicNumber[] = "%PDF";
113     static unsigned pdfMagicNumberLength = sizeof(pdfMagicNumber) - 1;
114     if (data && data->size() >= pdfMagicNumberLength && !memcmp(data->data(), pdfMagicNumber, pdfMagicNumberLength)) {
115         LOG(IconDatabase, "IconLoader::finishLoading() - Ignoring icon at %s because it appears to be a PDF", m_resource->url().string().ascii().data());
116         data = nullptr;
117     }
118
119     LOG(IconDatabase, "IconLoader::finishLoading() - Committing iconURL %s to database", m_resource->url().string().ascii().data());
120
121     if (m_frame) {
122         m_frame->loader().icon().commitToDatabase(m_resource->url());
123
124         // Setting the icon data only after committing to the database ensures that the data is
125         // kept in memory (so it does not have to be read from the database asynchronously), since
126         // there is a page URL referencing it.
127         iconDatabase().setIconDataForIconURL(data, m_resource->url().string());
128         m_frame->loader().client().dispatchDidReceiveIcon();
129
130     } else
131         m_documentLoader->finishedLoadingIcon(*this, data);
132
133     stopLoading();
134 }
135
136 }