Allow mmap encoded data replacement for WOFF fonts.
[WebKit-https.git] / Source / WebCore / loader / cache / CachedFont.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Torch Mobile, Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "CachedFont.h"
29
30 #include "CachedFontClient.h"
31 #include "CachedResourceClientWalker.h"
32 #include "CachedResourceLoader.h"
33 #include "FontCustomPlatformData.h"
34 #include "FontPlatformData.h"
35 #include "MemoryCache.h"
36 #include "ResourceBuffer.h"
37 #include "SharedBuffer.h"
38 #include "TextResourceDecoder.h"
39 #include "WOFFFileFormat.h"
40 #include <wtf/Vector.h>
41
42 #if ENABLE(SVG_FONTS)
43 #include "NodeList.h"
44 #include "SVGDocument.h"
45 #include "SVGElement.h"
46 #include "SVGFontElement.h"
47 #include "SVGGElement.h"
48 #include "SVGNames.h"
49 #endif
50
51 namespace WebCore {
52
53 CachedFont::CachedFont(const ResourceRequest& resourceRequest)
54     : CachedResource(resourceRequest, FontResource)
55     , m_loadInitiated(false)
56     , m_hasCreatedFontDataWrappingResource(false)
57 {
58 }
59
60 CachedFont::~CachedFont()
61 {
62 }
63
64 void CachedFont::load(CachedResourceLoader*, const ResourceLoaderOptions& options)
65 {
66     // Don't load the file yet.  Wait for an access before triggering the load.
67     setLoading(true);
68     m_options = options;
69 }
70
71 void CachedFont::didAddClient(CachedResourceClient* c)
72 {
73     ASSERT(c->resourceClientType() == CachedFontClient::expectedType());
74     if (!isLoading())
75         static_cast<CachedFontClient*>(c)->fontLoaded(this);
76 }
77
78 void CachedFont::finishLoading(ResourceBuffer* data)
79 {
80     m_data = data;
81     setEncodedSize(m_data.get() ? m_data->size() : 0);
82     setLoading(false);
83     checkNotify();
84 }
85
86 void CachedFont::beginLoadIfNeeded(CachedResourceLoader* dl)
87 {
88     if (!m_loadInitiated) {
89         m_loadInitiated = true;
90         CachedResource::load(dl, m_options);
91     }
92 }
93
94 bool CachedFont::ensureCustomFontData()
95 {
96     if (!m_fontData && !errorOccurred() && !isLoading() && m_data) {
97         SharedBuffer* buffer = m_data.get()->sharedBuffer();
98         ASSERT(buffer);
99
100         RefPtr<SharedBuffer> sfntBuffer;
101
102         bool fontIsWOFF = isWOFF(buffer);
103         if (fontIsWOFF) {
104             Vector<char> sfnt;
105             if (convertWOFFToSfnt(buffer, sfnt)) {
106                 sfntBuffer = SharedBuffer::adoptVector(sfnt);
107                 buffer = sfntBuffer.get();
108             } else
109                 buffer = nullptr;
110         }
111
112         m_fontData = buffer ? createFontCustomPlatformData(*buffer) : nullptr;
113         if (m_fontData)
114             m_hasCreatedFontDataWrappingResource = !fontIsWOFF;
115         else
116             setStatus(DecodeError);
117     }
118     return m_fontData.get();
119 }
120
121 FontPlatformData CachedFont::platformDataFromCustomData(float size, bool bold, bool italic, FontOrientation orientation, FontWidthVariant widthVariant, FontRenderingMode renderingMode)
122 {
123 #if ENABLE(SVG_FONTS)
124     if (m_externalSVGDocument)
125         return FontPlatformData(size, bold, italic);
126 #endif
127     ASSERT(m_fontData);
128     return m_fontData->fontPlatformData(static_cast<int>(size), bold, italic, orientation, widthVariant, renderingMode);
129 }
130
131 #if ENABLE(SVG_FONTS)
132 bool CachedFont::ensureSVGFontData()
133 {
134     if (!m_externalSVGDocument && !errorOccurred() && !isLoading() && m_data) {
135         m_externalSVGDocument = SVGDocument::create(0, URL());
136
137         RefPtr<TextResourceDecoder> decoder = TextResourceDecoder::create("application/xml");
138         String svgSource = decoder->decode(m_data->data(), m_data->size());
139         svgSource.append(decoder->flush());
140         
141         m_externalSVGDocument->setContent(svgSource);
142         
143         if (decoder->sawError())
144             m_externalSVGDocument = 0;
145     }
146
147     return m_externalSVGDocument;
148 }
149
150 SVGFontElement* CachedFont::getSVGFontById(const String& fontName) const
151 {
152     RefPtr<NodeList> list = m_externalSVGDocument->getElementsByTagNameNS(SVGNames::fontTag.namespaceURI(), SVGNames::fontTag.localName());
153     if (!list)
154         return 0;
155
156     unsigned listLength = list->length();
157     if (!listLength)
158         return 0;
159
160 #ifndef NDEBUG
161     for (unsigned i = 0; i < listLength; ++i) {
162         ASSERT(list->item(i));
163         ASSERT(isSVGFontElement(list->item(i)));
164     }
165 #endif
166
167     if (fontName.isEmpty())
168         return toSVGFontElement(list->item(0));
169
170     for (unsigned i = 0; i < listLength; ++i) {
171         SVGFontElement* element = toSVGFontElement(list->item(i));
172         if (element->getIdAttribute() == fontName)
173             return element;
174     }
175
176     return 0;
177 }
178 #endif
179
180 void CachedFont::allClientsRemoved()
181 {
182     m_fontData = nullptr;
183 }
184
185 void CachedFont::checkNotify()
186 {
187     if (isLoading())
188         return;
189     
190     CachedResourceClientWalker<CachedFontClient> w(m_clients);
191     while (CachedFontClient* c = w.next())
192          c->fontLoaded(this);
193 }
194
195 bool CachedFont::mayTryReplaceEncodedData() const
196 {
197     // If a FontCustomPlatformData has ever been constructed to wrap the internal resource buffer then it still might be in use somewhere.
198     // That platform font object might directly reference the encoded data buffer behind this CachedFont,
199     // so replacing it is unsafe.
200
201     return !m_hasCreatedFontDataWrappingResource;
202 }
203
204 }