<rdar://problem/8960434> and https://bugs.webkit.org/show_bug.cgi?id=53957
[WebKit.git] / Source / WebKit2 / UIProcess / cf / WebBackForwardListCF.cpp
1 /*
2  * Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
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 "WebBackForwardList.h"
28 #include "Logging.h"
29 #include <wtf/RetainPtr.h>
30 #include <CoreFoundation/CoreFoundation.h>
31
32 using namespace WebCore;
33
34 namespace WebKit {
35
36 static uint64_t generateWebBackForwardItemID()
37 {
38     // These IDs exist in the UIProcess for items created by the UIProcess.
39     // The IDs generated here need to never collide with the IDs created in WebBackForwardListProxy in the WebProcess.
40     // We accomplish this by starting from 2, and only ever using even ids.
41     static uint64_t uniqueHistoryItemID = 0;
42     uniqueHistoryItemID += 2;
43     return uniqueHistoryItemID;
44 }
45
46 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryCurrentIndexKey, (CFSTR("SessionHistoryCurrentIndex")));
47 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryEntriesKey, (CFSTR("SessionHistoryEntries")));
48 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryEntryTitleKey, (CFSTR("SessionHistoryEntryTitle")));
49 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryEntryURLKey, (CFSTR("SessionHistoryEntryURL")));
50 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryEntryOriginalURLKey, (CFSTR("SessionHistoryEntryOriginalURL")));
51 DEFINE_STATIC_GETTER(CFStringRef, SessionHistoryEntryDataKey, (CFSTR("SessionHistoryEntryData")));
52
53 CFDictionaryRef WebBackForwardList::createCFDictionaryRepresentation(WebPageProxy::WebPageProxySessionStateFilterCallback filter, void* context) const
54 {
55     ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
56
57     RetainPtr<CFNumberRef> currentIndex(AdoptCF, CFNumberCreate(0, kCFNumberIntType, &m_current));    
58     RetainPtr<CFMutableArrayRef> entries(AdoptCF, CFArrayCreateMutable(0, m_entries.size(), &kCFTypeArrayCallBacks));
59     
60     const void* keys[2] = { SessionHistoryCurrentIndexKey(), SessionHistoryEntriesKey() };
61     const void* values[2] = { currentIndex.get(), entries.get() };
62
63     RetainPtr<CFDictionaryRef> dictionary(AdoptCF, CFDictionaryCreate(0, keys, values, 2, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
64
65     for (size_t i = 0; i < m_entries.size(); ++i) {
66         RefPtr<WebURL> webURL = WebURL::create(m_entries[i]->url());
67         if (filter && !filter(toAPI(m_page), WKPageGetSessionHistoryURLValueType(), toURLRef(m_entries[i]->originalURL().impl()), context))
68             continue;
69         
70         RetainPtr<CFStringRef> url(AdoptCF, m_entries[i]->url().createCFString());
71         RetainPtr<CFStringRef> title(AdoptCF, m_entries[i]->title().createCFString());
72         RetainPtr<CFStringRef> originalURL(AdoptCF, m_entries[i]->originalURL().createCFString());
73         RetainPtr<CFDataRef> entryData(AdoptCF, CFDataCreate(kCFAllocatorDefault, m_entries[i]->backForwardData().data(), m_entries[i]->backForwardData().size()));
74         
75         const void* keys[4] = { SessionHistoryEntryURLKey(), SessionHistoryEntryTitleKey(), SessionHistoryEntryOriginalURLKey(), SessionHistoryEntryDataKey() };
76         const void* values[4] = { url.get(), title.get(), originalURL.get(), entryData.get() };
77
78         RetainPtr<CFDictionaryRef> entryDictionary(AdoptCF, CFDictionaryCreate(0, keys, values, 4, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
79         CFArrayAppendValue(entries.get(), entryDictionary.get());
80     }
81     
82     return dictionary.leakRef();
83 }
84
85 bool WebBackForwardList::restoreFromCFDictionaryRepresentation(CFDictionaryRef dictionary)
86 {
87     CFNumberRef cfIndex = (CFNumberRef)CFDictionaryGetValue(dictionary, SessionHistoryCurrentIndexKey());
88     if (!cfIndex || CFGetTypeID(cfIndex) != CFNumberGetTypeID()) {
89         LOG(SessionState, "WebBackForwardList dictionary representation does not have a valid current index");
90         return false;
91     }
92
93     CFIndex currentIndex;
94     if (!CFNumberGetValue(cfIndex, kCFNumberCFIndexType, &currentIndex)) {
95         LOG(SessionState, "WebBackForwardList dictionary representation does not have a valid integer current index");
96         return false;
97     }
98
99     CFArrayRef cfEntries = (CFArrayRef)CFDictionaryGetValue(dictionary, SessionHistoryEntriesKey());
100     if (!cfEntries || CFGetTypeID(cfEntries) != CFArrayGetTypeID()) {
101         LOG(SessionState, "WebBackForwardList dictionary representation does not have a valid list of entries");
102         return false;
103     }
104
105     CFIndex size = CFArrayGetCount(cfEntries);
106     if (currentIndex != NoCurrentItemIndex && currentIndex >= size) {
107         LOG(SessionState, "WebBackForwardList dictionary representation contains an invalid current index (%ld) for the number of entries (%ld)", currentIndex, size);
108         return false;
109     }
110
111     if (currentIndex == NoCurrentItemIndex && size) {
112         LOG(SessionState, "WebBackForwardList dictionary representation says there is no current item index, but there is a list of %ld entries - this is bogus", size);
113         return false;
114     }
115     
116     BackForwardListItemVector newEntries;
117     newEntries.reserveCapacity(size);
118     for (CFIndex i = 0; i < size; ++i) {
119         CFDictionaryRef entryDictionary = (CFDictionaryRef)CFArrayGetValueAtIndex(cfEntries, i);
120         if (!entryDictionary || CFGetTypeID(entryDictionary) != CFDictionaryGetTypeID()) {
121             LOG(SessionState, "WebBackForwardList entry array does not have a valid entry at index %i", (int)i);
122             return false;
123         }
124         
125         CFStringRef entryURL = (CFStringRef)CFDictionaryGetValue(entryDictionary, SessionHistoryEntryURLKey());
126         if (!entryURL || CFGetTypeID(entryURL) != CFStringGetTypeID()) {
127             LOG(SessionState, "WebBackForwardList entry at index %i does not have a valid URL", (int)i);
128             return false;
129         }
130
131         CFStringRef entryTitle = (CFStringRef)CFDictionaryGetValue(entryDictionary, SessionHistoryEntryTitleKey());
132         if (!entryTitle || CFGetTypeID(entryTitle) != CFStringGetTypeID()) {
133             LOG(SessionState, "WebBackForwardList entry at index %i does not have a valid title", (int)i);
134             return false;
135         }
136
137         CFStringRef originalURL = (CFStringRef)CFDictionaryGetValue(entryDictionary, SessionHistoryEntryOriginalURLKey());
138         if (!originalURL || CFGetTypeID(originalURL) != CFStringGetTypeID()) {
139             LOG(SessionState, "WebBackForwardList entry at index %i does not have a valid original URL", (int)i);
140             return false;
141         }
142
143         CFDataRef backForwardData = (CFDataRef)CFDictionaryGetValue(entryDictionary, SessionHistoryEntryDataKey());
144         if (!backForwardData || CFGetTypeID(backForwardData) != CFDataGetTypeID()) {
145             LOG(SessionState, "WebBackForwardList entry at index %i does not have back/forward data", (int)i);
146             return false;
147         }
148         
149         newEntries.append(WebBackForwardListItem::create(originalURL, entryURL, entryTitle, CFDataGetBytePtr(backForwardData), CFDataGetLength(backForwardData), generateWebBackForwardItemID()));
150     }
151     
152     m_current = currentIndex;
153     m_entries = newEntries;
154
155     return true;
156 }
157
158 } // namespace WebKit