Unreviewed build fix
[WebKit-https.git] / Source / WebCore / loader / icon / IconLoader.cpp
1 /*
2  * Copyright (C) 2006-2017 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 "CustomHeaderFields.h"
34 #include "Document.h"
35 #include "DocumentLoader.h"
36 #include "Frame.h"
37 #include "FrameLoader.h"
38 #include "FrameLoaderClient.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(DocumentLoader& documentLoader, const URL& url)
47     : m_documentLoader(documentLoader)
48     , m_url(url)
49 {
50 }
51
52 IconLoader::~IconLoader()
53 {
54     stopLoading();
55 }
56
57 void IconLoader::startLoading()
58 {
59     if (m_resource)
60         return;
61
62     auto* frame = m_documentLoader.frame();
63     if (!frame)
64         return;
65
66     ResourceRequest resourceRequest = m_url;
67     resourceRequest.setPriority(ResourceLoadPriority::Low);
68 #if !ERROR_DISABLED
69     // Copy this because we may want to access it after transferring the
70     // `resourceRequest` to the `request`. If we don't, then the LOG_ERROR
71     // below won't print a URL.
72     auto resourceRequestURL = resourceRequest.url();
73 #endif
74
75     CachedResourceRequest request(WTFMove(resourceRequest), ResourceLoaderOptions(
76         SendCallbackPolicy::SendCallbacks,
77         ContentSniffingPolicy::SniffContent,
78         DataBufferingPolicy::BufferData,
79         StoredCredentialsPolicy::DoNotUse,
80         ClientCredentialPolicy::CannotAskClientForCredentials,
81         FetchOptions::Credentials::Omit,
82         SecurityCheckPolicy::DoSecurityCheck,
83         FetchOptions::Mode::NoCors,
84         CertificateInfoPolicy::DoNotIncludeCertificateInfo,
85         ContentSecurityPolicyImposition::DoPolicyCheck,
86         DefersLoadingPolicy::AllowDefersLoading,
87         CachingPolicy::AllowCaching));
88
89     request.setInitiator(cachedResourceRequestInitiators().icon);
90
91     auto cachedResource = frame->document()->cachedResourceLoader().requestIcon(WTFMove(request));
92     m_resource = cachedResource.value_or(nullptr);
93     if (m_resource)
94         m_resource->addClient(*this);
95     else
96         LOG_ERROR("Failed to start load for icon at url %s (error: %s)", resourceRequestURL.string().ascii().data(), cachedResource.error().localizedDescription().utf8().data());
97 }
98
99 void IconLoader::stopLoading()
100 {
101     if (m_resource) {
102         m_resource->removeClient(*this);
103         m_resource = nullptr;
104     }
105 }
106
107 void IconLoader::notifyFinished(CachedResource& resource)
108 {
109     ASSERT_UNUSED(resource, &resource == m_resource);
110
111     // If we got a status code indicating an invalid response, then lets
112     // ignore the data and not try to decode the error page as an icon.
113     auto* data = m_resource->resourceBuffer();
114     int status = m_resource->response().httpStatusCode();
115     if (status && (status < 200 || status > 299))
116         data = nullptr;
117
118     static const char pdfMagicNumber[] = "%PDF";
119     static unsigned pdfMagicNumberLength = sizeof(pdfMagicNumber) - 1;
120     if (data && data->size() >= pdfMagicNumberLength && !memcmp(data->data(), pdfMagicNumber, pdfMagicNumberLength)) {
121         LOG(IconDatabase, "IconLoader::finishLoading() - Ignoring icon at %s because it appears to be a PDF", m_resource->url().string().ascii().data());
122         data = nullptr;
123     }
124
125     LOG(IconDatabase, "IconLoader::finishLoading() - Committing iconURL %s to database", m_resource->url().string().ascii().data());
126
127     // DocumentLoader::finishedLoadingIcon destroys this IconLoader as it finishes. This will automatically
128     // trigger IconLoader::stopLoading() during destruction, so we should just return here.
129     m_documentLoader.finishedLoadingIcon(*this, data);
130 }
131
132 }