chrome/test/data/pdf/navigator_test.js

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

function MockNavigatorDelegate() {
  this.navigateInCurrentTabCalled = false;
  this.navigateInNewTabCalled = false;
  this.navigateInNewWindowCalled = false;
  this.url = undefined;
}

MockNavigatorDelegate.prototype = {
  navigateInCurrentTab: function(url) {
    this.navigateInCurrentTabCalled = true;
    this.url = url || '<called, but no url set>';
  },
  navigateInNewTab: function(url) {
    this.navigateInNewTabCalled = true;
    this.url = url || '<called, but no url set>';

  },
  navigateInNewWindow: function(url) {
    this.navigateInNewWindowCalled = true;
    this.url = url || '<called, but no url set>';
  },
  reset: function() {
    this.navigateInCurrentTabCalled = false;
    this.navigateInNewTabCalled = false;
    this.navigateInNewWindowCalled = false;
    this.url = undefined;
  }
}

/**
 * Given a |navigator|, navigate to |url| in the current tab, a new tab, or
 * a new window depending on the value of |disposition|. Use
 * |viewportChangedCallback| and |navigatorDelegate| to check the callbacks,
 * and that the navigation to |expectedResultUrl| happened.
 */
function doNavigationUrlTest(
    navigator,
    url,
    disposition,
    expectedResultUrl,
    viewportChangedCallback,
    navigatorDelegate) {
  viewportChangedCallback.reset();
  navigatorDelegate.reset();
  navigator.navigate(url, disposition);
  chrome.test.assertFalse(viewportChangedCallback.wasCalled);
  chrome.test.assertEq(expectedResultUrl, navigatorDelegate.url);
  if (expectedResultUrl === undefined) {
    return;
  }
  switch (disposition) {
    case Navigator.WindowOpenDisposition.CURRENT_TAB:
      chrome.test.assertTrue(navigatorDelegate.navigateInCurrentTabCalled);
      break;
    case Navigator.WindowOpenDisposition.NEW_BACKGROUND_TAB:
      chrome.test.assertTrue(navigatorDelegate.navigateInNewTabCalled);
      break;
    case Navigator.WindowOpenDisposition.NEW_WINDOW:
      chrome.test.assertTrue(navigatorDelegate.navigateInNewWindowCalled);
      break;
    default:
      break;
  }
}

/**
 * Helper function to run doNavigationUrlTest() for the current tab, a new
 * tab, and a new window.
 */
function doNavigationUrlTests(originalUrl, url, expectedResultUrl) {
  var mockWindow = new MockWindow(100, 100);
  var mockSizer = new MockSizer();
  var mockViewportChangedCallback = new MockViewportChangedCallback();
  var viewport = new Viewport(mockWindow, mockSizer,
                              mockViewportChangedCallback.callback,
                              function() {}, function() {}, 0, 1, 0);

  var paramsParser = new OpenPDFParamsParser(function(name) {
    paramsParser.onNamedDestinationReceived(-1);
  });

  var navigatorDelegate = new MockNavigatorDelegate();
  var navigator = new Navigator(originalUrl, viewport, paramsParser,
                                navigatorDelegate);

  doNavigationUrlTest(navigator, url,
      Navigator.WindowOpenDisposition.CURRENT_TAB, expectedResultUrl,
      mockViewportChangedCallback, navigatorDelegate);
  doNavigationUrlTest(navigator, url,
      Navigator.WindowOpenDisposition.NEW_BACKGROUND_TAB, expectedResultUrl,
      mockViewportChangedCallback, navigatorDelegate);
  doNavigationUrlTest(navigator, url,
      Navigator.WindowOpenDisposition.NEW_WINDOW, expectedResultUrl,
      mockViewportChangedCallback, navigatorDelegate);
}

var tests = [
  /**
   * Test navigation within the page, opening a url in the same tab and
   * opening a url in a new tab.
   */
  function testNavigate() {
    var mockWindow = new MockWindow(100, 100);
    var mockSizer = new MockSizer();
    var mockCallback = new MockViewportChangedCallback();
    var viewport = new Viewport(mockWindow, mockSizer, mockCallback.callback,
                                function() {}, function() {}, 0, 1, 0);

    var paramsParser = new OpenPDFParamsParser(function(name) {
      if (name == 'US')
        paramsParser.onNamedDestinationReceived(0);
      else if (name == 'UY')
        paramsParser.onNamedDestinationReceived(2);
      else
        paramsParser.onNamedDestinationReceived(-1);
    });
    var url = "http://xyz.pdf";

    var navigatorDelegate = new MockNavigatorDelegate();
    var navigator = new Navigator(url, viewport, paramsParser,
                                  navigatorDelegate);

    var documentDimensions = new MockDocumentDimensions();
    documentDimensions.addPage(100, 100);
    documentDimensions.addPage(200, 200);
    documentDimensions.addPage(100, 400);
    viewport.setDocumentDimensions(documentDimensions);
    viewport.setZoom(1);

    mockCallback.reset();
    // This should move viewport to page 0.
    navigator.navigate(url + "#US",
        Navigator.WindowOpenDisposition.CURRENT_TAB);
    chrome.test.assertTrue(mockCallback.wasCalled);
    chrome.test.assertEq(0, viewport.position.x);
    chrome.test.assertEq(0, viewport.position.y);

    mockCallback.reset();
    navigatorDelegate.reset();
    // This should open "http://xyz.pdf#US" in a new tab. So current tab
    // viewport should not update and viewport position should remain same.
    navigator.navigate(url + "#US",
        Navigator.WindowOpenDisposition.NEW_BACKGROUND_TAB);
    chrome.test.assertFalse(mockCallback.wasCalled);
    chrome.test.assertTrue(navigatorDelegate.navigateInNewTabCalled);
    chrome.test.assertEq(0, viewport.position.x);
    chrome.test.assertEq(0, viewport.position.y);

    mockCallback.reset();
    // This should move viewport to page 2.
    navigator.navigate(url + "#UY",
        Navigator.WindowOpenDisposition.CURRENT_TAB);
    chrome.test.assertTrue(mockCallback.wasCalled);
    chrome.test.assertEq(0, viewport.position.x);
    chrome.test.assertEq(300, viewport.position.y);

    mockCallback.reset();
    navigatorDelegate.reset();
    // #ABC is not a named destination in the page so viewport should not
    // update and viewport position should remain same. As this link will open
    // in the same tab.
    navigator.navigate(url + "#ABC",
        Navigator.WindowOpenDisposition.CURRENT_TAB);
    chrome.test.assertFalse(mockCallback.wasCalled);
    chrome.test.assertTrue(navigatorDelegate.navigateInCurrentTabCalled);
    chrome.test.assertEq(0, viewport.position.x);
    chrome.test.assertEq(300, viewport.position.y);

    chrome.test.succeed();
  },
  /**
   * Test opening a url in the same tab, in a new tab, and in a new window for
   * a http:// url as the current location. The destination url may not have
   * a valid scheme, so the navigator must determine the url by following
   * similar heuristics as Adobe Acrobat Reader.
   */
  function testNavigateForLinksWithoutScheme() {
    var url = "http://www.example.com/subdir/xyz.pdf";

    // Sanity check.
    doNavigationUrlTests(
        url,
        'https://www.foo.com/bar.pdf',
        'https://www.foo.com/bar.pdf');

    // Open relative links.
    doNavigationUrlTests(
        url,
        'foo/bar.pdf',
        'http://www.example.com/subdir/foo/bar.pdf');
    doNavigationUrlTests(
        url,
        'foo.com/bar.pdf',
        'http://www.example.com/subdir/foo.com/bar.pdf');
    // The expected result is not normalized here.
    doNavigationUrlTests(
        url,
        '../www.foo.com/bar.pdf',
        'http://www.example.com/subdir/../www.foo.com/bar.pdf');

    // Open an absolute link.
    doNavigationUrlTests(
        url,
        '/foodotcom/bar.pdf',
        'http://www.example.com/foodotcom/bar.pdf');

    // Open a http url without a scheme.
    doNavigationUrlTests(
        url,
        'www.foo.com/bar.pdf',
        'http://www.foo.com/bar.pdf');

    // Test three dots.
    doNavigationUrlTests(
        url,
        '.../bar.pdf',
        'http://www.example.com/subdir/.../bar.pdf');

    // Test forward slashes.
    doNavigationUrlTests(
        url,
        '..\\bar.pdf',
        'http://www.example.com/subdir/..\\bar.pdf');
    doNavigationUrlTests(
        url,
        '.\\bar.pdf',
        'http://www.example.com/subdir/.\\bar.pdf');
    doNavigationUrlTests(
        url,
        '\\bar.pdf',
        'http://www.example.com/subdir/\\bar.pdf');

    // Regression test for https://crbug.com/569040
    doNavigationUrlTests(
        url,
        'http://something.else/foo#page=5',
        'http://something.else/foo#page=5');

    chrome.test.succeed();
  },
  /**
   * Test opening a url in the same tab, in a new tab, and in a new window with
   * a file:/// url as the current location.
   */
  function testNavigateFromLocalFile() {
    var url = "file:///some/path/to/myfile.pdf";

    // Open an absolute link.
    doNavigationUrlTests(
        url,
        '/foodotcom/bar.pdf',
        'file:///foodotcom/bar.pdf');

    chrome.test.succeed();
  },

  function testNavigateInvalidUrls() {
    var url = 'https://example.com/some-web-document.pdf';

    // From non-file: to file:
    doNavigationUrlTests(
        url,
        'file:///bar.pdf',
        undefined);

    doNavigationUrlTests(
        url,
        'chrome://version',
        undefined);

    doNavigationUrlTests(
        url,
        'javascript:// this is not a document.pdf',
        undefined);

    doNavigationUrlTests(
        url,
        'this-is-not-a-valid-scheme://path.pdf',
        undefined);

    doNavigationUrlTests(
        url,
        '',
        undefined);

    chrome.test.succeed();
  }
];

var scriptingAPI = new PDFScriptingAPI(window, window);
scriptingAPI.setLoadCallback(function() {
  chrome.test.runTests(tests);
});