src/third_party/WebKit/Source/core/fetch/FontResource.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 "core/fetch/FontResource.h"
  29
  30 #include "core/dom/TagCollection.h"
  31 #include "core/fetch/ResourceClientWalker.h"
  32 #include "core/html/parser/TextResourceDecoder.h"
  33 #include "platform/SharedBuffer.h"
  34 #include "platform/fonts/FontCustomPlatformData.h"
  35 #include "platform/fonts/FontPlatformData.h"
  36 #include "public/platform/Platform.h"
  37 #include "wtf/CurrentTime.h"
  38
  39 #if ENABLE(SVG_FONTS)
  40 #include "core/SVGNames.h"
  41 #include "core/dom/XMLDocument.h"
  42 #include "core/html/HTMLCollection.h"
  43 #include "core/svg/SVGFontElement.h"
  44 #endif
  45
  46 namespace blink {
  47
  48 static const double fontLoadWaitLimitSec = 3.0;
  49
  50 enum FontPackageFormat {
  51     PackageFormatUnknown,
  52     PackageFormatSFNT,
  53     PackageFormatWOFF,
  54     PackageFormatWOFF2,
  55     PackageFormatSVG,
  56     PackageFormatEnumMax
  57 };
  58
  59 static FontPackageFormat packageFormatOf(SharedBuffer* buffer)
  60 {
  61     if (buffer->size() < 4)
  62         return PackageFormatUnknown;
  63
  64     const char* data = buffer->data();
  65     if (data[0] == 'w' && data[1] == 'O' && data[2] == 'F' && data[3] == 'F')
  66         return PackageFormatWOFF;
  67     if (data[0] == 'w' && data[1] == 'O' && data[2] == 'F' && data[3] == '2')
  68         return PackageFormatWOFF2;
  69     return PackageFormatSFNT;
  70 }
  71
  72 static void recordPackageFormatHistogram(FontPackageFormat format)
  73 {
  74     blink::Platform::current()->histogramEnumeration("WebFont.PackageFormat", format, PackageFormatEnumMax);
  75 }
  76
  77 FontResource::FontResource(const ResourceRequest& resourceRequest)
  78     : Resource(resourceRequest, Font)
  79     , m_state(Unloaded)
  80     , m_exceedsFontLoadWaitLimit(false)
  81     , m_corsFailed(false)
  82     , m_fontLoadWaitLimitTimer(this, &FontResource::fontLoadWaitLimitCallback)
  83 {
  84 }
  85
  86 FontResource::~FontResource()
  87 {
  88 }
  89
  90 void FontResource::trace(Visitor* visitor)
  91 {
  92 #if ENABLE(SVG_FONTS)
  93     visitor->trace(m_externalSVGDocument);
  94 #endif
  95     Resource::trace(visitor);
  96 }
  97
  98 void FontResource::didScheduleLoad()
  99 {
 100     if (m_state == Unloaded)
 101         m_state = LoadScheduled;
 102 }
 103
 104 void FontResource::didUnscheduleLoad()
 105 {
 106     if (m_state == LoadScheduled)
 107         m_state = Unloaded;
 108 }
 109
 110 void FontResource::load(ResourceFetcher*, const ResourceLoaderOptions& options)
 111 {
 112     // Don't load the file yet. Wait for an access before triggering the load.
 113     setLoading(true);
 114     m_options = options;
 115 }
 116
 117 void FontResource::didAddClient(ResourceClient* c)
 118 {
 119     ASSERT(c->resourceClientType() == FontResourceClient::expectedType());
 120     Resource::didAddClient(c);
 121     if (!isLoading())
 122         static_cast<FontResourceClient*>(c)->fontLoaded(this);
 123 }
 124
 125 void FontResource::beginLoadIfNeeded(ResourceFetcher* dl)
 126 {
 127     if (m_state != LoadInitiated) {
 128         m_state = LoadInitiated;
 129         Resource::load(dl, m_options);
 130         m_fontLoadWaitLimitTimer.startOneShot(fontLoadWaitLimitSec, FROM_HERE);
 131
 132         ResourceClientWalker<FontResourceClient> walker(m_clients);
 133         while (FontResourceClient* client = walker.next())
 134             client->didStartFontLoad(this);
 135     }
 136 }
 137
 138 bool FontResource::ensureCustomFontData()
 139 {
 140     if (!m_fontData && !errorOccurred() && !isLoading()) {
 141         if (m_data)
 142             m_fontData = FontCustomPlatformData::create(m_data.get());
 143
 144         if (m_fontData) {
 145             recordPackageFormatHistogram(packageFormatOf(m_data.get()));
 146         } else {
 147             setStatus(DecodeError);
 148             recordPackageFormatHistogram(PackageFormatUnknown);
 149         }
 150     }
 151     return m_fontData;
 152 }
 153
 154 FontPlatformData FontResource::platformDataFromCustomData(float size, bool bold, bool italic, FontOrientation orientation, FontWidthVariant widthVariant)
 155 {
 156 #if ENABLE(SVG_FONTS)
 157     if (m_externalSVGDocument)
 158         return FontPlatformData(size, bold, italic);
 159 #endif
 160     ASSERT(m_fontData);
 161     return m_fontData->fontPlatformData(size, bold, italic, orientation, widthVariant);
 162 }
 163
 164 #if ENABLE(SVG_FONTS)
 165 bool FontResource::ensureSVGFontData()
 166 {
 167     if (!m_externalSVGDocument && !errorOccurred() && !isLoading()) {
 168         if (m_data) {
 169             m_externalSVGDocument = XMLDocument::createSVG();
 170
 171             OwnPtr<TextResourceDecoder> decoder = TextResourceDecoder::create("application/xml");
 172             String svgSource = decoder->decode(m_data->data(), m_data->size());
 173             svgSource = svgSource + decoder->flush();
 174
 175             m_externalSVGDocument->setContent(svgSource);
 176
 177             if (decoder->sawError())
 178                 m_externalSVGDocument = nullptr;
 179         }
 180         if (m_externalSVGDocument) {
 181             recordPackageFormatHistogram(PackageFormatSVG);
 182         } else {
 183             setStatus(DecodeError);
 184             recordPackageFormatHistogram(PackageFormatUnknown);
 185         }
 186     }
 187
 188     return m_externalSVGDocument;
 189 }
 190
 191 SVGFontElement* FontResource::getSVGFontById(const String& fontName) const
 192 {
 193     RefPtrWillBeRawPtr<TagCollection> collection = m_externalSVGDocument->getElementsByTagNameNS(SVGNames::fontTag.namespaceURI(), SVGNames::fontTag.localName());
 194     if (!collection)
 195         return 0;
 196
 197     unsigned collectionLength = collection->length();
 198     if (!collectionLength)
 199         return 0;
 200
 201 #if ENABLE(ASSERT)
 202     for (unsigned i = 0; i < collectionLength; ++i) {
 203         ASSERT(collection->item(i));
 204         ASSERT(isSVGFontElement(collection->item(i)));
 205     }
 206 #endif
 207
 208     if (fontName.isEmpty())
 209         return toSVGFontElement(collection->item(0));
 210
 211     for (unsigned i = 0; i < collectionLength; ++i) {
 212         SVGFontElement* element = toSVGFontElement(collection->item(i));
 213         if (element->getIdAttribute() == fontName)
 214             return element;
 215     }
 216
 217     return 0;
 218 }
 219 #endif
 220
 221 bool FontResource::isSafeToUnlock() const
 222 {
 223     return m_data->hasOneRef();
 224 }
 225
 226 void FontResource::fontLoadWaitLimitCallback(Timer<FontResource>*)
 227 {
 228     if (!isLoading())
 229         return;
 230     m_exceedsFontLoadWaitLimit = true;
 231     ResourceClientWalker<FontResourceClient> walker(m_clients);
 232     while (FontResourceClient* client = walker.next())
 233         client->fontLoadWaitLimitExceeded(this);
 234 }
 235
 236 void FontResource::allClientsRemoved()
 237 {
 238     m_fontData.clear();
 239     Resource::allClientsRemoved();
 240 }
 241
 242 void FontResource::checkNotify()
 243 {
 244     m_fontLoadWaitLimitTimer.stop();
 245     ResourceClientWalker<FontResourceClient> w(m_clients);
 246     while (FontResourceClient* c = w.next())
 247         c->fontLoaded(this);
 248 }
 249
 250 }