[GTK] The plugins metadata cache doesn't work if the user cache directory doesn't...
[WebKit-https.git] / Source / WebKit2 / UIProcess / Plugins / gtk / PluginInfoCache.cpp
1 /*
2  * Copyright (C) 2014 Igalia S.L.
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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "PluginInfoCache.h"
28
29 #if ENABLE(NETSCAPE_PLUGIN_API)
30
31 #include "NetscapePluginModule.h"
32 #include <WebCore/FileSystem.h>
33 #include <wtf/text/CString.h>
34
35 namespace WebKit {
36
37 static const unsigned gSchemaVersion = 2;
38
39 PluginInfoCache& PluginInfoCache::shared()
40 {
41     static NeverDestroyed<PluginInfoCache> pluginInfoCache;
42     return pluginInfoCache;
43 }
44
45 PluginInfoCache::PluginInfoCache()
46     : m_cacheFile(g_key_file_new())
47 {
48     GUniquePtr<char> cacheDirectory(g_build_filename(g_get_user_cache_dir(), "webkitgtk", nullptr));
49     if (WebCore::makeAllDirectories(cacheDirectory.get())) {
50         m_cachePath.reset(g_build_filename(cacheDirectory.get(), "plugins", nullptr));
51         g_key_file_load_from_file(m_cacheFile.get(), m_cachePath.get(), G_KEY_FILE_NONE, nullptr);
52     }
53
54     if (g_key_file_has_group(m_cacheFile.get(), "schema")) {
55         unsigned schemaVersion = static_cast<unsigned>(g_key_file_get_integer(m_cacheFile.get(), "schema", "version", nullptr));
56         if (schemaVersion == gSchemaVersion)
57             return;
58
59         // Cache file using an old schema, create a new empty file.
60         m_cacheFile.reset(g_key_file_new());
61     }
62
63     g_key_file_set_integer(m_cacheFile.get(), "schema", "version", static_cast<unsigned>(gSchemaVersion));
64 }
65
66 PluginInfoCache::~PluginInfoCache()
67 {
68     if (m_saveToFileIdle.isScheduled()) {
69         m_saveToFileIdle.cancel();
70         saveToFile();
71     }
72 }
73
74 void PluginInfoCache::saveToFile()
75 {
76     std::lock_guard<std::mutex> lock(m_mutex);
77
78     gsize dataLength;
79     GUniquePtr<char> data(g_key_file_to_data(m_cacheFile.get(), &dataLength, nullptr));
80     if (!data)
81         return;
82
83     g_file_set_contents(m_cachePath.get(), data.get(), dataLength, nullptr);
84 }
85
86 bool PluginInfoCache::getPluginInfo(const String& pluginPath, PluginModuleInfo& plugin)
87 {
88     CString pluginGroup = pluginPath.utf8();
89     if (!g_key_file_has_group(m_cacheFile.get(), pluginGroup.data()))
90         return false;
91
92     time_t lastModified;
93     if (!WebCore::getFileModificationTime(pluginPath, lastModified))
94         return false;
95     time_t cachedLastModified = static_cast<time_t>(g_key_file_get_uint64(m_cacheFile.get(), pluginGroup.data(), "mtime", nullptr));
96     if (lastModified != cachedLastModified)
97         return false;
98
99     plugin.path = pluginPath;
100     plugin.info.file = WebCore::pathGetFileName(pluginPath);
101
102     GUniquePtr<char> stringValue(g_key_file_get_string(m_cacheFile.get(), pluginGroup.data(), "name", nullptr));
103     plugin.info.name = String::fromUTF8(stringValue.get());
104
105     stringValue.reset(g_key_file_get_string(m_cacheFile.get(), pluginGroup.data(), "description", nullptr));
106     plugin.info.desc = String::fromUTF8(stringValue.get());
107
108 #if PLUGIN_ARCHITECTURE(X11)
109     stringValue.reset(g_key_file_get_string(m_cacheFile.get(), pluginGroup.data(), "mime-description", nullptr));
110     NetscapePluginModule::parseMIMEDescription(String::fromUTF8(stringValue.get()), plugin.info.mimes);
111 #endif
112
113     plugin.requiresGtk2 = g_key_file_get_boolean(m_cacheFile.get(), pluginGroup.data(), "requires-gtk2", nullptr);
114
115     return true;
116 }
117
118 void PluginInfoCache::updatePluginInfo(const String& pluginPath, const PluginModuleInfo& plugin)
119 {
120     time_t lastModified;
121     if (!WebCore::getFileModificationTime(pluginPath, lastModified))
122         return;
123
124     CString pluginGroup = pluginPath.utf8();
125     g_key_file_set_uint64(m_cacheFile.get(), pluginGroup.data(), "mtime", static_cast<guint64>(lastModified));
126     g_key_file_set_string(m_cacheFile.get(), pluginGroup.data(), "name", plugin.info.name.utf8().data());
127     g_key_file_set_string(m_cacheFile.get(), pluginGroup.data(), "description", plugin.info.desc.utf8().data());
128
129 #if PLUGIN_ARCHITECTURE(X11)
130     String mimeDescription = NetscapePluginModule::buildMIMEDescription(plugin.info.mimes);
131     g_key_file_set_string(m_cacheFile.get(), pluginGroup.data(), "mime-description", mimeDescription.utf8().data());
132 #endif
133
134     g_key_file_set_boolean(m_cacheFile.get(), pluginGroup.data(), "requires-gtk2", plugin.requiresGtk2);
135
136     if (m_cachePath) {
137         // Save the cache file in an idle to make sure it happens in the main thread and
138         // it's done only once when this is called multiple times in a very short time.
139         std::lock_guard<std::mutex> lock(m_mutex);
140         if (m_saveToFileIdle.isScheduled())
141             return;
142
143         m_saveToFileIdle.schedule("[WebKit] PluginInfoCache::saveToFile", std::bind(&PluginInfoCache::saveToFile, this), G_PRIORITY_DEFAULT_IDLE);
144     }
145 }
146
147 } // namespace WebKit
148
149 #endif // ENABLE(NETSCAPE_PLUGIN_API)