Home | History | Annotate | Download | only in plugins 
      1 /*
      2  * Copyright (C) 2006, 2007 Apple Inc.  All rights reserved.
      3  * Copyright (C) 2008 Collabora, Ltd.  All rights reserved.
      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 #ifndef PluginPackage_H
     28 #define PluginPackage_H
     29 
     30 #include "FileSystem.h"
     31 #include "PlatformString.h"
     32 #include "PluginQuirkSet.h"
     33 #include "StringHash.h"
     34 #include "Timer.h"
     35 #include "npruntime_internal.h"
     36 #include <wtf/HashMap.h>
     37 #include <wtf/RefCounted.h>
     38 
     39 #if OS(SYMBIAN)
     40 class QPluginLoader;
     41 class NPInterface;
     42 #endif
     43 
     44 namespace WebCore {
     45     typedef HashMap<String, String> MIMEToDescriptionsMap;
     46     typedef HashMap<String, Vector<String> > MIMEToExtensionsMap;
     47 
     48     class PluginPackage : public RefCounted<PluginPackage> {
     49     public:
     50         ~PluginPackage();
     51         static PassRefPtr<PluginPackage> createPackage(const String& path, const time_t& lastModified);
     52 
     53         const String& name() const { return m_name; }
     54         const String& description() const { return m_description; }
     55         const String& path() const { return m_path; }
     56         const String& fileName() const { return m_fileName; }
     57         const String& parentDirectory() const { return m_parentDirectory; }
     58         time_t lastModified() const { return m_lastModified; }
     59 
     60         const MIMEToDescriptionsMap& mimeToDescriptions() const { return m_mimeToDescriptions; }
     61         const MIMEToExtensionsMap& mimeToExtensions() const { return m_mimeToExtensions; }
     62 
     63         unsigned hash() const;
     64         static bool equal(const PluginPackage& a, const PluginPackage& b);
     65 
     66         bool load();
     67         void unload();
     68         void unloadWithoutShutdown();
     69 
     70         bool isEnabled() const { return m_isEnabled; }
     71         void setEnabled(bool);
     72 
     73         const NPPluginFuncs* pluginFuncs() const { return &m_pluginFuncs; }
     74         int compareFileVersion(const PlatformModuleVersion&) const;
     75         int compare(const PluginPackage&) const;
     76         PluginQuirkSet quirks() const { return m_quirks; }
     77         const PlatformModuleVersion& version() const { return m_moduleVersion; }
     78 #if OS(SYMBIAN)
     79         NPInterface* npInterface() const { return m_npInterface; }
     80 #endif // OS(SYMBIAN)
     81 
     82     private:
     83         PluginPackage(const String& path, const time_t& lastModified);
     84 
     85 #if OS(SYMBIAN)
     86         NPInterface* m_npInterface;
     87         QPluginLoader* m_pluginLoader;
     88 #endif // OS(SYMBIAN)
     89         bool fetchInfo();
     90         bool isPluginBlacklisted();
     91         void determineQuirks(const String& mimeType);
     92 
     93         void determineModuleVersionFromDescription();
     94         void initializeBrowserFuncs();
     95 
     96         bool m_isEnabled;
     97         bool m_isLoaded;
     98         int m_loadCount;
     99 
    100         String m_description;
    101         String m_path;
    102         String m_fileName;
    103         String m_name;
    104         String m_parentDirectory;
    105 
    106         PlatformModuleVersion m_moduleVersion;
    107 
    108         MIMEToDescriptionsMap m_mimeToDescriptions;
    109         MIMEToExtensionsMap m_mimeToExtensions;
    110 
    111         PlatformModule m_module;
    112         time_t m_lastModified;
    113 
    114         NPP_ShutdownProcPtr m_NPP_Shutdown;
    115         NPPluginFuncs m_pluginFuncs;
    116         NPNetscapeFuncs m_browserFuncs;
    117 
    118         void freeLibrarySoon();
    119         void freeLibraryTimerFired(Timer<PluginPackage>*);
    120         Timer<PluginPackage> m_freeLibraryTimer;
    121 
    122         PluginQuirkSet m_quirks;
    123     };
    124 
    125     struct PluginPackageHash {
    126         static unsigned hash(const uintptr_t key) { return reinterpret_cast<PluginPackage*>(key)->hash(); }
    127         static unsigned hash(const RefPtr<PluginPackage>& key) { return key->hash(); }
    128 
    129         static bool equal(const uintptr_t a, const uintptr_t b) { return equal(reinterpret_cast<PluginPackage*>(a), reinterpret_cast<PluginPackage*>(b)); }
    130         static bool equal(const RefPtr<PluginPackage>& a, const RefPtr<PluginPackage>& b) { return PluginPackage::equal(*a.get(), *b.get()); }
    131         static const bool safeToCompareToEmptyOrDeleted = false;
    132     };
    133 
    134 } // namespace WebCore
    135 
    136 #endif
    137