1/*
2 * Copyright (C) 2006, 2007, 2008, 2009, 2011 Apple Inc. All rights reserved.
3 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4 * Copyright (C) Research In Motion Limited 2009. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16 *     its contributors may be used to endorse or promote products derived
17 *     from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef SubframeLoader_h
32#define SubframeLoader_h
33
34#include "FrameLoaderTypes.h"
35#include <wtf/Forward.h>
36#include <wtf/HashMap.h>
37#include <wtf/Noncopyable.h>
38#include <wtf/Vector.h>
39#include <wtf/text/WTFString.h>
40
41namespace WebCore {
42
43class Document;
44class Frame;
45class FrameLoaderClient;
46class HTMLAppletElement;
47class HTMLFrameOwnerElement;
48class HTMLPlugInImageElement;
49class IntSize;
50class KURL;
51#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
52class Node;
53#endif
54class Widget;
55
56// This is a slight misnomer. It handles the higher level logic of loading both subframes and plugins.
57class SubframeLoader {
58    WTF_MAKE_NONCOPYABLE(SubframeLoader);
59public:
60    explicit SubframeLoader(Frame*);
61
62    void clear();
63
64    bool requestFrame(HTMLFrameOwnerElement*, const String& url, const AtomicString& frameName, bool lockHistory = true, bool lockBackForwardList = true);
65    bool requestObject(HTMLPlugInImageElement*, const String& url, const AtomicString& frameName,
66        const String& serviceType, const Vector<String>& paramNames, const Vector<String>& paramValues);
67
68#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
69    // FIXME: This should take Element* instead of Node*, or better yet the
70    // specific type of Element which this code depends on.
71    PassRefPtr<Widget> loadMediaPlayerProxyPlugin(Node*, const KURL&, const Vector<String>& paramNames, const Vector<String>& paramValues);
72#endif
73
74    PassRefPtr<Widget> createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const Vector<String>& paramNames, const Vector<String>& paramValues);
75
76    bool allowPlugins(ReasonForCallingAllowPlugins);
77
78    bool containsPlugins() const { return m_containsPlugins; }
79
80    bool resourceWillUsePlugin(const String& url, const String& mimeType, bool shouldPreferPlugInsForImages);
81
82private:
83    bool requestPlugin(HTMLPlugInImageElement*, const KURL&, const String& serviceType, const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback);
84    Frame* loadOrRedirectSubframe(HTMLFrameOwnerElement*, const KURL&, const AtomicString& frameName, bool lockHistory, bool lockBackForwardList);
85    Frame* loadSubframe(HTMLFrameOwnerElement*, const KURL&, const String& name, const String& referrer);
86    bool loadPlugin(HTMLPlugInImageElement*, const KURL&, const String& mimeType,
87        const Vector<String>& paramNames, const Vector<String>& paramValues, bool useFallback);
88
89    bool shouldUsePlugin(const KURL&, const String& mimeType, bool shouldPreferPlugInsForImages, bool hasFallback, bool& useFallback);
90    bool pluginIsLoadable(HTMLPlugInImageElement*, const KURL&, const String& mimeType);
91
92    Document* document() const;
93
94    bool m_containsPlugins;
95    Frame* m_frame;
96
97    KURL completeURL(const String&) const;
98};
99
100} // namespace WebCore
101
102#endif // SubframeLoader_h
103