[WK2] WebBackForwardListItems' pageState is not kept up-to-date
[WebKit-https.git] / Source / WebCore / loader / HistoryController.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
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 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 #include "config.h"
32 #include "HistoryController.h"
33
34 #include "BackForwardController.h"
35 #include "CachedPage.h"
36 #include "Document.h"
37 #include "DocumentLoader.h"
38 #include "FrameLoader.h"
39 #include "FrameLoaderClient.h"
40 #include "FrameLoaderStateMachine.h"
41 #include "FrameTree.h"
42 #include "FrameView.h"
43 #include "HistoryItem.h"
44 #include "LinkHash.h"
45 #include "Logging.h"
46 #include "MainFrame.h"
47 #include "Page.h"
48 #include "PageCache.h"
49 #include "PageGroup.h"
50 #include "ScrollingCoordinator.h"
51 #include "VisitedLinkStore.h"
52 #include <wtf/text/CString.h>
53
54 namespace WebCore {
55
56 static inline void addVisitedLink(Page& page, const URL& url)
57 {
58     page.visitedLinkStore().addVisitedLink(page, visitedLinkHash(url.string()));
59 }
60
61 HistoryController::HistoryController(Frame& frame)
62     : m_frame(frame)
63     , m_frameLoadComplete(true)
64     , m_defersLoading(false)
65 {
66 }
67
68 HistoryController::~HistoryController()
69 {
70 }
71
72 void HistoryController::saveScrollPositionAndViewStateToItem(HistoryItem* item)
73 {
74     FrameView* frameView = m_frame.view();
75     if (!item || !frameView)
76         return;
77
78     if (m_frame.document()->inPageCache())
79         item->setScrollPoint(frameView->cachedScrollPosition());
80     else
81         item->setScrollPoint(frameView->scrollPosition());
82 #if PLATFORM(IOS)
83     item->setExposedContentRect(frameView->exposedContentRect());
84     item->setUnobscuredContentRect(frameView->unobscuredContentRect());
85 #endif
86
87     Page* page = m_frame.page();
88     if (page && m_frame.isMainFrame())
89         item->setPageScaleFactor(page->pageScaleFactor() / page->viewScaleFactor());
90
91     // FIXME: It would be great to work out a way to put this code in WebCore instead of calling through to the client.
92     m_frame.loader().client().saveViewStateToItem(item);
93
94     // Notify clients that the HistoryItem has changed.
95     item->notifyChanged();
96 }
97
98 void HistoryController::clearScrollPositionAndViewState()
99 {
100     if (!m_currentItem)
101         return;
102
103     m_currentItem->clearScrollPoint();
104     m_currentItem->setPageScaleFactor(0);
105 }
106
107 /*
108  There is a race condition between the layout and load completion that affects restoring the scroll position.
109  We try to restore the scroll position at both the first layout and upon load completion.
110  
111  1) If first layout happens before the load completes, we want to restore the scroll position then so that the
112  first time we draw the page is already scrolled to the right place, instead of starting at the top and later
113  jumping down.  It is possible that the old scroll position is past the part of the doc laid out so far, in
114  which case the restore silent fails and we will fix it in when we try to restore on doc completion.
115  2) If the layout happens after the load completes, the attempt to restore at load completion time silently
116  fails.  We then successfully restore it when the layout happens.
117 */
118 void HistoryController::restoreScrollPositionAndViewState()
119 {
120     if (!m_frame.loader().stateMachine().committedFirstRealDocumentLoad())
121         return;
122
123     ASSERT(m_currentItem);
124     
125     // FIXME: As the ASSERT attests, it seems we should always have a currentItem here.
126     // One counterexample is <rdar://problem/4917290>
127     // For now, to cover this issue in release builds, there is no technical harm to returning
128     // early and from a user standpoint - as in the above radar - the previous page load failed 
129     // so there *is* no scroll or view state to restore!
130     if (!m_currentItem)
131         return;
132
133     FrameView* view = m_frame.view();
134
135     // FIXME: There is some scrolling related work that needs to happen whenever a page goes into the
136     // page cache and similar work that needs to occur when it comes out. This is where we do the work
137     // that needs to happen when we exit, and the work that needs to happen when we enter is in
138     // Document::setIsInPageCache(bool). It would be nice if there was more symmetry in these spots.
139     // https://bugs.webkit.org/show_bug.cgi?id=98698
140     if (view) {
141         Page* page = m_frame.page();
142         if (page && m_frame.isMainFrame()) {
143             if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator())
144                 scrollingCoordinator->frameViewRootLayerDidChange(*view);
145         }
146     }
147
148     // FIXME: It would be great to work out a way to put this code in WebCore instead of calling
149     // through to the client.
150     m_frame.loader().client().restoreViewState();
151
152 #if !PLATFORM(IOS) && !PLATFORM(EFL)
153     // Don't restore scroll point on iOS as FrameLoaderClient::restoreViewState() does that.
154     if (view && !view->wasScrolledByUser()) {
155         Page* page = m_frame.page();
156         if (page && m_frame.isMainFrame() && m_currentItem->pageScaleFactor())
157             page->setPageScaleFactor(m_currentItem->pageScaleFactor() * page->viewScaleFactor(), m_currentItem->scrollPoint());
158         else
159             view->setScrollPosition(m_currentItem->scrollPoint());
160     }
161 #endif
162 }
163
164 void HistoryController::updateBackForwardListForFragmentScroll()
165 {
166     updateBackForwardListClippedAtTarget(false);
167 }
168
169 void HistoryController::saveDocumentState()
170 {
171     // FIXME: Reading this bit of FrameLoader state here is unfortunate.  I need to study
172     // this more to see if we can remove this dependency.
173     if (m_frame.loader().stateMachine().creatingInitialEmptyDocument())
174         return;
175
176     // For a standard page load, we will have a previous item set, which will be used to
177     // store the form state.  However, in some cases we will have no previous item, and
178     // the current item is the right place to save the state.  One example is when we
179     // detach a bunch of frames because we are navigating from a site with frames to
180     // another site.  Another is when saving the frame state of a frame that is not the
181     // target of the current navigation (if we even decide to save with that granularity).
182
183     // Because of previousItem's "masking" of currentItem for this purpose, it's important
184     // that we keep track of the end of a page transition with m_frameLoadComplete.  We
185     // leverage the checkLoadComplete recursion to achieve this goal.
186
187     HistoryItem* item = m_frameLoadComplete ? m_currentItem.get() : m_previousItem.get();
188     if (!item)
189         return;
190
191     ASSERT(m_frame.document());
192     Document& document = *m_frame.document();
193     if (item->isCurrentDocument(document) && document.hasLivingRenderTree()) {
194         LOG(Loading, "WebCoreLoading %s: saving form state to %p", m_frame.tree().uniqueName().string().utf8().data(), item);
195         item->setDocumentState(document.formElementsState());
196     }
197 }
198
199 // Walk the frame tree, telling all frames to save their form state into their current
200 // history item.
201 void HistoryController::saveDocumentAndScrollState()
202 {
203     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame)) {
204         frame->loader().history().saveDocumentState();
205         frame->loader().history().saveScrollPositionAndViewStateToItem(frame->loader().history().currentItem());
206     }
207 }
208
209 void HistoryController::restoreDocumentState()
210 {
211     switch (m_frame.loader().loadType()) {
212     case FrameLoadType::Reload:
213     case FrameLoadType::ReloadFromOrigin:
214     case FrameLoadType::Same:
215     case FrameLoadType::Replace:
216         // Not restoring the document state.
217         return;
218     case FrameLoadType::Back:
219     case FrameLoadType::Forward:
220     case FrameLoadType::IndexedBackForward:
221     case FrameLoadType::RedirectWithLockedBackForwardList:
222     case FrameLoadType::Standard:
223         break;
224     }
225     
226     if (!m_currentItem)
227         return;
228     if (m_frame.loader().requestedHistoryItem() != m_currentItem.get())
229         return;
230     if (m_frame.loader().documentLoader()->isClientRedirect())
231         return;
232
233     LOG(Loading, "WebCoreLoading %s: restoring form state from %p", m_frame.tree().uniqueName().string().utf8().data(), m_currentItem.get());
234     m_frame.document()->setStateForNewFormElements(m_currentItem->documentState());
235 }
236
237 void HistoryController::invalidateCurrentItemCachedPage()
238 {
239     if (!currentItem())
240         return;
241
242     // When we are pre-commit, the currentItem is where any page cache data resides.
243     std::unique_ptr<CachedPage> cachedPage = PageCache::singleton().take(*currentItem(), m_frame.page());
244     if (!cachedPage)
245         return;
246
247     // FIXME: This is a grotesque hack to fix <rdar://problem/4059059> Crash in RenderFlow::detach
248     // Somehow the PageState object is not properly updated, and is holding onto a stale document.
249     // Both Xcode and FileMaker see this crash, Safari does not.
250     
251     ASSERT(cachedPage->document() == m_frame.document());
252     if (cachedPage->document() == m_frame.document()) {
253         cachedPage->document()->setInPageCache(false);
254         cachedPage->clear();
255     }
256 }
257
258 bool HistoryController::shouldStopLoadingForHistoryItem(HistoryItem& targetItem) const
259 {
260     if (!m_currentItem)
261         return false;
262
263     // Don't abort the current load if we're navigating within the current document.
264     if (m_currentItem->shouldDoSameDocumentNavigationTo(targetItem))
265         return false;
266
267     return true;
268 }
269
270 // Main funnel for navigating to a previous location (back/forward, non-search snap-back)
271 // This includes recursion to handle loading into framesets properly
272 void HistoryController::goToItem(HistoryItem& targetItem, FrameLoadType type)
273 {
274     ASSERT(!m_frame.tree().parent());
275     
276     // shouldGoToHistoryItem is a private delegate method. This is needed to fix:
277     // <rdar://problem/3951283> can view pages from the back/forward cache that should be disallowed by Parental Controls
278     // Ultimately, history item navigations should go through the policy delegate. That's covered in:
279     // <rdar://problem/3979539> back/forward cache navigations should consult policy delegate
280     Page* page = m_frame.page();
281     if (!page)
282         return;
283     if (!m_frame.loader().client().shouldGoToHistoryItem(&targetItem))
284         return;
285     if (m_defersLoading) {
286         m_deferredItem = &targetItem;
287         m_deferredFrameLoadType = type;
288         return;
289     }
290
291     // Set the BF cursor before commit, which lets the user quickly click back/forward again.
292     // - plus, it only makes sense for the top level of the operation through the frame tree,
293     // as opposed to happening for some/one of the page commits that might happen soon
294     RefPtr<HistoryItem> currentItem = page->backForward().currentItem();
295     page->backForward().setCurrentItem(&targetItem);
296     m_frame.loader().client().updateGlobalHistoryItemForPage();
297
298     // First set the provisional item of any frames that are not actually navigating.
299     // This must be done before trying to navigate the desired frame, because some
300     // navigations can commit immediately (such as about:blank).  We must be sure that
301     // all frames have provisional items set before the commit.
302     recursiveSetProvisionalItem(targetItem, currentItem.get());
303
304     // Now that all other frames have provisional items, do the actual navigation.
305     recursiveGoToItem(targetItem, currentItem.get(), type);
306 }
307
308 void HistoryController::setDefersLoading(bool defer)
309 {
310     m_defersLoading = defer;
311     if (!defer && m_deferredItem) {
312         goToItem(*m_deferredItem, m_deferredFrameLoadType);
313         m_deferredItem = nullptr;
314     }
315 }
316
317 void HistoryController::updateForBackForwardNavigation()
318 {
319 #if !LOG_DISABLED
320     if (m_frame.loader().documentLoader())
321         LOG(History, "WebCoreHistory: Updating History for back/forward navigation in frame %s", m_frame.loader().documentLoader()->title().string().utf8().data());
322 #endif
323
324     // Must grab the current scroll position before disturbing it
325     if (!m_frameLoadComplete)
326         saveScrollPositionAndViewStateToItem(m_previousItem.get());
327
328     // When traversing history, we may end up redirecting to a different URL
329     // this time (e.g., due to cookies).  See http://webkit.org/b/49654.
330     updateCurrentItem();
331 }
332
333 void HistoryController::updateForReload()
334 {
335 #if !LOG_DISABLED
336     if (m_frame.loader().documentLoader())
337         LOG(History, "WebCoreHistory: Updating History for reload in frame %s", m_frame.loader().documentLoader()->title().string().utf8().data());
338 #endif
339
340     if (m_currentItem) {
341         PageCache::singleton().remove(*m_currentItem);
342     
343         if (m_frame.loader().loadType() == FrameLoadType::Reload || m_frame.loader().loadType() == FrameLoadType::ReloadFromOrigin)
344             saveScrollPositionAndViewStateToItem(m_currentItem.get());
345     }
346
347     // When reloading the page, we may end up redirecting to a different URL
348     // this time (e.g., due to cookies).  See http://webkit.org/b/4072.
349     updateCurrentItem();
350 }
351
352 // There are 3 things you might think of as "history", all of which are handled by these functions.
353 //
354 //     1) Back/forward: The m_currentItem is part of this mechanism.
355 //     2) Global history: Handled by the client.
356 //     3) Visited links: Handled by the PageGroup.
357
358 void HistoryController::updateForStandardLoad(HistoryUpdateType updateType)
359 {
360     LOG(History, "WebCoreHistory: Updating History for Standard Load in frame %s", m_frame.loader().documentLoader()->url().string().ascii().data());
361
362     FrameLoader& frameLoader = m_frame.loader();
363
364     bool needPrivacy = m_frame.page()->usesEphemeralSession();
365     const URL& historyURL = frameLoader.documentLoader()->urlForHistory();
366
367     if (!frameLoader.documentLoader()->isClientRedirect()) {
368         if (!historyURL.isEmpty()) {
369             if (updateType != UpdateAllExceptBackForwardList)
370                 updateBackForwardListClippedAtTarget(true);
371             if (!needPrivacy) {
372                 frameLoader.client().updateGlobalHistory();
373                 frameLoader.documentLoader()->setDidCreateGlobalHistoryEntry(true);
374                 if (frameLoader.documentLoader()->unreachableURL().isEmpty())
375                     frameLoader.client().updateGlobalHistoryRedirectLinks();
376             }
377
378             m_frame.loader().client().updateGlobalHistoryItemForPage();
379         }
380     } else {
381         // The client redirect replaces the current history item.
382         updateCurrentItem();
383     }
384
385     if (!historyURL.isEmpty() && !needPrivacy) {
386         if (Page* page = m_frame.page())
387             addVisitedLink(*page, historyURL);
388
389         if (!frameLoader.documentLoader()->didCreateGlobalHistoryEntry() && frameLoader.documentLoader()->unreachableURL().isEmpty() && !m_frame.document()->url().isEmpty())
390             frameLoader.client().updateGlobalHistoryRedirectLinks();
391     }
392 }
393
394 void HistoryController::updateForRedirectWithLockedBackForwardList()
395 {
396 #if !LOG_DISABLED
397     if (m_frame.loader().documentLoader())
398         LOG(History, "WebCoreHistory: Updating History for redirect load in frame %s", m_frame.loader().documentLoader()->title().string().utf8().data());
399 #endif
400     
401     bool needPrivacy = m_frame.page()->usesEphemeralSession();
402     const URL& historyURL = m_frame.loader().documentLoader()->urlForHistory();
403
404     if (m_frame.loader().documentLoader()->isClientRedirect()) {
405         if (!m_currentItem && !m_frame.tree().parent()) {
406             if (!historyURL.isEmpty()) {
407                 updateBackForwardListClippedAtTarget(true);
408                 if (!needPrivacy) {
409                     m_frame.loader().client().updateGlobalHistory();
410                     m_frame.loader().documentLoader()->setDidCreateGlobalHistoryEntry(true);
411                     if (m_frame.loader().documentLoader()->unreachableURL().isEmpty())
412                         m_frame.loader().client().updateGlobalHistoryRedirectLinks();
413                 }
414
415                 m_frame.loader().client().updateGlobalHistoryItemForPage();
416             }
417         }
418         // The client redirect replaces the current history item.
419         updateCurrentItem();
420     } else {
421         Frame* parentFrame = m_frame.tree().parent();
422         if (parentFrame && parentFrame->loader().history().currentItem())
423             parentFrame->loader().history().currentItem()->setChildItem(createItem());
424     }
425
426     if (!historyURL.isEmpty() && !needPrivacy) {
427         if (Page* page = m_frame.page())
428             addVisitedLink(*page, historyURL);
429
430         if (!m_frame.loader().documentLoader()->didCreateGlobalHistoryEntry() && m_frame.loader().documentLoader()->unreachableURL().isEmpty() && !m_frame.document()->url().isEmpty())
431             m_frame.loader().client().updateGlobalHistoryRedirectLinks();
432     }
433 }
434
435 void HistoryController::updateForClientRedirect()
436 {
437 #if !LOG_DISABLED
438     if (m_frame.loader().documentLoader())
439         LOG(History, "WebCoreHistory: Updating History for client redirect in frame %s", m_frame.loader().documentLoader()->title().string().utf8().data());
440 #endif
441
442     // Clear out form data so we don't try to restore it into the incoming page.  Must happen after
443     // webcore has closed the URL and saved away the form state.
444     if (m_currentItem) {
445         m_currentItem->clearDocumentState();
446         m_currentItem->clearScrollPoint();
447     }
448
449     bool needPrivacy = m_frame.page()->usesEphemeralSession();
450     const URL& historyURL = m_frame.loader().documentLoader()->urlForHistory();
451
452     if (!historyURL.isEmpty() && !needPrivacy) {
453         if (Page* page = m_frame.page())
454             addVisitedLink(*page, historyURL);
455     }
456 }
457
458 void HistoryController::updateForCommit()
459 {
460     FrameLoader& frameLoader = m_frame.loader();
461 #if !LOG_DISABLED
462     if (frameLoader.documentLoader())
463         LOG(History, "WebCoreHistory: Updating History for commit in frame %s", frameLoader.documentLoader()->title().string().utf8().data());
464 #endif
465     FrameLoadType type = frameLoader.loadType();
466     if (isBackForwardLoadType(type)
467         || isReplaceLoadTypeWithProvisionalItem(type)
468         || (isReloadTypeWithProvisionalItem(type) && !frameLoader.provisionalDocumentLoader()->unreachableURL().isEmpty())) {
469         // Once committed, we want to use current item for saving DocState, and
470         // the provisional item for restoring state.
471         // Note previousItem must be set before we close the URL, which will
472         // happen when the data source is made non-provisional below
473         ASSERT(m_provisionalItem);
474         setCurrentItem(*m_provisionalItem);
475         m_provisionalItem = nullptr;
476
477         // Tell all other frames in the tree to commit their provisional items and
478         // restore their scroll position.  We'll avoid this frame (which has already
479         // committed) and its children (which will be replaced).
480         m_frame.mainFrame().loader().history().recursiveUpdateForCommit();
481     }
482 }
483
484 bool HistoryController::isReplaceLoadTypeWithProvisionalItem(FrameLoadType type)
485 {
486     // Going back to an error page in a subframe can trigger a FrameLoadType::Replace
487     // while m_provisionalItem is set, so we need to commit it.
488     return type == FrameLoadType::Replace && m_provisionalItem;
489 }
490
491 bool HistoryController::isReloadTypeWithProvisionalItem(FrameLoadType type)
492 {
493     return (type == FrameLoadType::Reload || type == FrameLoadType::ReloadFromOrigin) && m_provisionalItem;
494 }
495
496 void HistoryController::recursiveUpdateForCommit()
497 {
498     // The frame that navigated will now have a null provisional item.
499     // Ignore it and its children.
500     if (!m_provisionalItem)
501         return;
502
503     // For each frame that already had the content the item requested (based on
504     // (a matching URL and frame tree snapshot), just restore the scroll position.
505     // Save form state (works from currentItem, since m_frameLoadComplete is true)
506     if (m_currentItem && itemsAreClones(*m_currentItem, m_provisionalItem.get())) {
507         ASSERT(m_frameLoadComplete);
508         saveDocumentState();
509         saveScrollPositionAndViewStateToItem(m_currentItem.get());
510
511         if (FrameView* view = m_frame.view())
512             view->setWasScrolledByUser(false);
513
514         // Now commit the provisional item
515         setCurrentItem(*m_provisionalItem);
516         m_provisionalItem = nullptr;
517
518         // Restore form state (works from currentItem)
519         restoreDocumentState();
520
521         // Restore the scroll position (we choose to do this rather than going back to the anchor point)
522         restoreScrollPositionAndViewState();
523     }
524
525     // Iterate over the rest of the tree
526     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
527         child->loader().history().recursiveUpdateForCommit();
528 }
529
530 void HistoryController::updateForSameDocumentNavigation()
531 {
532     if (m_frame.document()->url().isEmpty())
533         return;
534
535     if (m_frame.page()->usesEphemeralSession())
536         return;
537
538     Page* page = m_frame.page();
539     if (!page)
540         return;
541
542     addVisitedLink(*page, m_frame.document()->url());
543     m_frame.mainFrame().loader().history().recursiveUpdateForSameDocumentNavigation();
544
545     if (m_currentItem) {
546         m_currentItem->setURL(m_frame.document()->url());
547         m_frame.loader().client().updateGlobalHistory();
548     }
549 }
550
551 void HistoryController::recursiveUpdateForSameDocumentNavigation()
552 {
553     // The frame that navigated will now have a null provisional item.
554     // Ignore it and its children.
555     if (!m_provisionalItem)
556         return;
557
558     // The provisional item may represent a different pending navigation.
559     // Don't commit it if it isn't a same document navigation.
560     if (m_currentItem && !m_currentItem->shouldDoSameDocumentNavigationTo(*m_provisionalItem))
561         return;
562
563     // Commit the provisional item.
564     setCurrentItem(*m_provisionalItem);
565     m_provisionalItem = nullptr;
566
567     // Iterate over the rest of the tree.
568     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
569         child->loader().history().recursiveUpdateForSameDocumentNavigation();
570 }
571
572 void HistoryController::updateForFrameLoadCompleted()
573 {
574     // Even if already complete, we might have set a previous item on a frame that
575     // didn't do any data loading on the past transaction. Make sure to track that
576     // the load is complete so that we use the current item instead.
577     m_frameLoadComplete = true;
578 }
579
580 void HistoryController::setCurrentItem(HistoryItem& item)
581 {
582     m_frameLoadComplete = false;
583     m_previousItem = m_currentItem;
584     m_currentItem = &item;
585 }
586
587 void HistoryController::setCurrentItemTitle(const StringWithDirection& title)
588 {
589     if (m_currentItem)
590         // FIXME: make use of title.direction() as well.
591         m_currentItem->setTitle(title.string());
592 }
593
594 bool HistoryController::currentItemShouldBeReplaced() const
595 {
596     // From the HTML5 spec for location.assign():
597     //  "If the browsing context's session history contains only one Document,
598     //   and that was the about:blank Document created when the browsing context
599     //   was created, then the navigation must be done with replacement enabled."
600     return m_currentItem && !m_previousItem && equalIgnoringCase(m_currentItem->urlString(), blankURL());
601 }
602
603 void HistoryController::clearPreviousItem()
604 {
605     m_previousItem = nullptr;
606     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
607         child->loader().history().clearPreviousItem();
608 }
609
610 void HistoryController::setProvisionalItem(HistoryItem* item)
611 {
612     m_provisionalItem = item;
613 }
614
615 void HistoryController::initializeItem(HistoryItem& item)
616 {
617     DocumentLoader* documentLoader = m_frame.loader().documentLoader();
618     ASSERT(documentLoader);
619
620     URL unreachableURL = documentLoader->unreachableURL();
621
622     URL url;
623     URL originalURL;
624
625     if (!unreachableURL.isEmpty()) {
626         url = unreachableURL;
627         originalURL = unreachableURL;
628     } else {
629         url = documentLoader->url();
630         originalURL = documentLoader->originalURL();
631     }
632
633     // Frames that have never successfully loaded any content
634     // may have no URL at all. Currently our history code can't
635     // deal with such things, so we nip that in the bud here.
636     // Later we may want to learn to live with nil for URL.
637     // See bug 3368236 and related bugs for more information.
638     if (url.isEmpty()) 
639         url = blankURL();
640     if (originalURL.isEmpty())
641         originalURL = blankURL();
642     
643     Frame* parentFrame = m_frame.tree().parent();
644     String parent = parentFrame ? parentFrame->tree().uniqueName() : "";
645     StringWithDirection title = documentLoader->title();
646
647     item.setURL(url);
648     item.setTarget(m_frame.tree().uniqueName());
649     item.setParent(parent);
650     // FIXME: should store title directionality in history as well.
651     item.setTitle(title.string());
652     item.setOriginalURLString(originalURL.string());
653
654     if (!unreachableURL.isEmpty() || documentLoader->response().httpStatusCode() >= 400)
655         item.setLastVisitWasFailure(true);
656
657     // Save form state if this is a POST
658     item.setFormInfoFromRequest(documentLoader->request());
659 }
660
661 Ref<HistoryItem> HistoryController::createItem()
662 {
663     Ref<HistoryItem> item = HistoryItem::create();
664     initializeItem(item);
665     
666     // Set the item for which we will save document state
667     setCurrentItem(item);
668     
669     return item;
670 }
671
672 Ref<HistoryItem> HistoryController::createItemTree(Frame& targetFrame, bool clipAtTarget)
673 {
674     Ref<HistoryItem> bfItem = createItem();
675     if (!m_frameLoadComplete)
676         saveScrollPositionAndViewStateToItem(m_previousItem.get());
677
678     if (!clipAtTarget || &m_frame != &targetFrame) {
679         // save frame state for items that aren't loading (khtml doesn't save those)
680         saveDocumentState();
681
682         // clipAtTarget is false for navigations within the same document, so
683         // we should copy the documentSequenceNumber over to the newly create
684         // item.  Non-target items are just clones, and they should therefore
685         // preserve the same itemSequenceNumber.
686         if (m_previousItem) {
687             if (&m_frame != &targetFrame)
688                 bfItem->setItemSequenceNumber(m_previousItem->itemSequenceNumber());
689             bfItem->setDocumentSequenceNumber(m_previousItem->documentSequenceNumber());
690         }
691
692         for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling()) {
693             FrameLoader& childLoader = child->loader();
694             bool hasChildLoaded = childLoader.frameHasLoaded();
695
696             // If the child is a frame corresponding to an <object> element that never loaded,
697             // we don't want to create a history item, because that causes fallback content
698             // to be ignored on reload.
699             
700             if (!(!hasChildLoaded && childLoader.isHostedByObjectElement()))
701                 bfItem->addChildItem(childLoader.history().createItemTree(targetFrame, clipAtTarget));
702         }
703     }
704     // FIXME: Eliminate the isTargetItem flag in favor of itemSequenceNumber.
705     if (&m_frame == &targetFrame)
706         bfItem->setIsTargetItem(true);
707     return bfItem;
708 }
709
710 // The general idea here is to traverse the frame tree and the item tree in parallel,
711 // tracking whether each frame already has the content the item requests.  If there is
712 // a match, we set the provisional item and recurse.  Otherwise we will reload that
713 // frame and all its kids in recursiveGoToItem.
714 void HistoryController::recursiveSetProvisionalItem(HistoryItem& item, HistoryItem* fromItem)
715 {
716     if (!itemsAreClones(item, fromItem))
717         return;
718
719     // Set provisional item, which will be committed in recursiveUpdateForCommit.
720     m_provisionalItem = &item;
721
722     for (auto& childItem : item.children()) {
723         const String& childFrameName = childItem->target();
724
725         HistoryItem* fromChildItem = fromItem->childItemWithTarget(childFrameName);
726         ASSERT(fromChildItem);
727         Frame* childFrame = m_frame.tree().child(childFrameName);
728         ASSERT(childFrame);
729
730         childFrame->loader().history().recursiveSetProvisionalItem(const_cast<HistoryItem&>(childItem.get()), fromChildItem);
731     }
732 }
733
734 // We now traverse the frame tree and item tree a second time, loading frames that
735 // do have the content the item requests.
736 void HistoryController::recursiveGoToItem(HistoryItem& item, HistoryItem* fromItem, FrameLoadType type)
737 {
738     if (!itemsAreClones(item, fromItem)) {
739         m_frame.loader().loadItem(item, type);
740         return;
741     }
742
743     // Just iterate over the rest, looking for frames to navigate.
744     for (auto& childItem : item.children()) {
745         const String& childFrameName = childItem->target();
746
747         HistoryItem* fromChildItem = fromItem->childItemWithTarget(childFrameName);
748         ASSERT(fromChildItem);
749         Frame* childFrame = m_frame.tree().child(childFrameName);
750         ASSERT(childFrame);
751         childFrame->loader().history().recursiveGoToItem(const_cast<HistoryItem&>(childItem.get()), fromChildItem, type);
752     }
753 }
754
755 bool HistoryController::itemsAreClones(HistoryItem& item1, HistoryItem* item2) const
756 {
757     // If the item we're going to is a clone of the item we're at, then we do
758     // not need to load it again.  The current frame tree and the frame tree
759     // snapshot in the item have to match.
760     // Note: Some clients treat a navigation to the current history item as
761     // a reload.  Thus, if item1 and item2 are the same, we need to create a
762     // new document and should not consider them clones.
763     // (See http://webkit.org/b/35532 for details.)
764     return item2
765         && &item1 != item2
766         && item1.itemSequenceNumber() == item2->itemSequenceNumber()
767         && currentFramesMatchItem(&item1)
768         && item2->hasSameFrames(item1);
769 }
770
771 // Helper method that determines whether the current frame tree matches given history item's.
772 bool HistoryController::currentFramesMatchItem(HistoryItem* item) const
773 {
774     if ((!m_frame.tree().uniqueName().isEmpty() || !item->target().isEmpty()) && m_frame.tree().uniqueName() != item->target())
775         return false;
776         
777     const HistoryItemVector& childItems = item->children();
778     if (childItems.size() != m_frame.tree().childCount())
779         return false;
780     
781     unsigned size = childItems.size();
782     for (unsigned i = 0; i < size; ++i) {
783         if (!m_frame.tree().child(childItems[i]->target()))
784             return false;
785     }
786     
787     return true;
788 }
789
790 void HistoryController::updateBackForwardListClippedAtTarget(bool doClip)
791 {
792     // In the case of saving state about a page with frames, we store a tree of items that mirrors the frame tree.  
793     // The item that was the target of the user's navigation is designated as the "targetItem".  
794     // When this function is called with doClip=true we're able to create the whole tree except for the target's children, 
795     // which will be loaded in the future. That part of the tree will be filled out as the child loads are committed.
796
797     Page* page = m_frame.page();
798     if (!page)
799         return;
800
801     if (m_frame.loader().documentLoader()->urlForHistory().isEmpty())
802         return;
803
804     FrameLoader& frameLoader = m_frame.mainFrame().loader();
805
806     Ref<HistoryItem> topItem = frameLoader.history().createItemTree(m_frame, doClip);
807     LOG(BackForward, "WebCoreBackForward - Adding backforward item %p for frame %s", topItem.ptr(), m_frame.loader().documentLoader()->url().string().ascii().data());
808     page->backForward().addItem(WTF::move(topItem));
809 }
810
811 void HistoryController::updateCurrentItem()
812 {
813     if (!m_currentItem)
814         return;
815
816     DocumentLoader* documentLoader = m_frame.loader().documentLoader();
817
818     if (!documentLoader->unreachableURL().isEmpty())
819         return;
820
821     if (m_currentItem->url() != documentLoader->url()) {
822         // We ended up on a completely different URL this time, so the HistoryItem
823         // needs to be re-initialized.  Preserve the isTargetItem flag as it is a
824         // property of how this HistoryItem was originally created and is not
825         // dependent on the document.
826         bool isTargetItem = m_currentItem->isTargetItem();
827         m_currentItem->reset();
828         initializeItem(*m_currentItem);
829         m_currentItem->setIsTargetItem(isTargetItem);
830     } else {
831         // Even if the final URL didn't change, the form data may have changed.
832         m_currentItem->setFormInfoFromRequest(documentLoader->request());
833     }
834 }
835
836 void HistoryController::pushState(PassRefPtr<SerializedScriptValue> stateObject, const String& title, const String& urlString)
837 {
838     if (!m_currentItem)
839         return;
840
841     Page* page = m_frame.page();
842     ASSERT(page);
843
844     // Get a HistoryItem tree for the current frame tree.
845     Ref<HistoryItem> topItem = m_frame.mainFrame().loader().history().createItemTree(m_frame, false);
846     
847     // Override data in the current item (created by createItemTree) to reflect
848     // the pushState() arguments.
849     m_currentItem->setTitle(title);
850     m_currentItem->setStateObject(stateObject);
851     m_currentItem->setURLString(urlString);
852
853     page->backForward().addItem(WTF::move(topItem));
854
855     if (m_frame.page()->usesEphemeralSession())
856         return;
857
858     addVisitedLink(*page, URL(ParsedURLString, urlString));
859     m_frame.loader().client().updateGlobalHistory();
860 }
861
862 void HistoryController::replaceState(PassRefPtr<SerializedScriptValue> stateObject, const String& title, const String& urlString)
863 {
864     if (!m_currentItem)
865         return;
866
867     if (!urlString.isEmpty())
868         m_currentItem->setURLString(urlString);
869     m_currentItem->setTitle(title);
870     m_currentItem->setStateObject(stateObject);
871     m_currentItem->setFormData(0);
872     m_currentItem->setFormContentType(String());
873
874     if (m_frame.page()->usesEphemeralSession())
875         return;
876
877     ASSERT(m_frame.page());
878     addVisitedLink(*m_frame.page(), URL(ParsedURLString, urlString));
879     m_frame.loader().client().updateGlobalHistory();
880 }
881
882 void HistoryController::replaceCurrentItem(HistoryItem* item)
883 {
884     if (!item)
885         return;
886
887     m_previousItem = nullptr;
888     if (m_provisionalItem)
889         m_provisionalItem = item;
890     else
891         m_currentItem = item;
892 }
893
894 } // namespace WebCore