org.openqa.selenium.server.browserlaunchers.HTABrowserLauncher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-server
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 3.9.1
/*
Copyright 2006-2012 Selenium committers
Copyright 2006-2012 Software Freedom Conservancy

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package org.openqa.selenium.server.browserlaunchers;

import org.openqa.selenium.Capabilities;
import org.openqa.selenium.browserlaunchers.BrowserLauncher;
import org.openqa.selenium.browserlaunchers.LauncherUtils;
import org.openqa.selenium.browserlaunchers.locators.InternetExplorerLocator;
import org.openqa.selenium.io.FileHandler;
import org.openqa.selenium.os.CommandLine;
import org.openqa.selenium.os.WindowsProcessGroup;
import org.openqa.selenium.os.WindowsUtils;
import org.openqa.selenium.server.FrameGroupCommandQueueSet;
import org.openqa.selenium.server.RemoteControlConfiguration;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.logging.Logger;

//EB - Why doesn't this class extend AbstractBrowserLauncher
//DGF - because it would override every method of ABL.
public class HTABrowserLauncher implements BrowserLauncher {
  static Logger log = Logger.getLogger(HTABrowserLauncher.class.getName());
  private String sessionId;
  private File dir;
  private String htaCommandPath;
  private WindowsProcessGroup htaProcess;
  private WindowsProcessGroup iexploreProcess;
  private RemoteControlConfiguration configuration;
  private Capabilities browserOptions;

  public HTABrowserLauncher(Capabilities browserOptions, RemoteControlConfiguration configuration,
      String sessionId, String browserLaunchLocation) {
    if (browserLaunchLocation == null) {
      browserLaunchLocation = findHTALaunchLocation();
    }
    htaCommandPath = browserLaunchLocation;
    this.sessionId = sessionId;
    this.configuration = configuration;
    this.browserOptions = configuration.copySettingsIntoBrowserOptions(browserOptions);
  }

  private static String findHTALaunchLocation() {
    String defaultPath = System.getProperty("mshtaDefaultPath");
    if (defaultPath == null) {
      defaultPath = WindowsUtils.findSystemRoot() + "\\system32\\mshta.exe";
    }
    File defaultLocation = new File(defaultPath);
    if (defaultLocation.exists()) {
      return defaultLocation.getAbsolutePath();
    }
    String mshtaEXE = CommandLine.find("mshta.exe");
    if (mshtaEXE != null) return mshtaEXE;
    throw new RuntimeException("MSHTA.exe couldn't be found in the path!\n" +
        "Please add the directory containing mshta.exe to your PATH environment\n" +
        "variable, or explicitly specify a path to mshta.exe like this:\n" +
        "*mshta c:\\blah\\mshta.exe");
  }

  private void launch(String url, String htaName) {
    String query = LauncherUtils.getQueryString(url);
    query += "&baseUrl=http://localhost:" + getPort() + "/selenium-server/";
    createHTAFiles();
    String hta = (new File(dir, "core/" + htaName)).getAbsolutePath();
    log.info("Launching Embedded Internet Explorer...");
    iexploreProcess = new WindowsProcessGroup(
        new InternetExplorerLocator().findBrowserLocationOrFail().launcherFilePath(),
        "-Embedding");
    iexploreProcess.executeAsync();
    log.info("Launching Internet Explorer HTA...");

    htaProcess = new WindowsProcessGroup(htaCommandPath, hta, query);
    htaProcess.executeAsync();
  }

  private void createHTAFiles() {
    dir = LauncherUtils.createCustomProfileDir(sessionId);
    File coreDir = new File(dir, "core");
    try {
      coreDir.mkdirs();
      ResourceExtractor.extractResourcePath(HTABrowserLauncher.class, "/core", coreDir);
      File selRunnerSrc = new File(coreDir, "RemoteRunner.html");
      File selRunnerDest = new File(coreDir, "RemoteRunner.hta");
      File testRunnerSrc = new File(coreDir, "TestRunner.html");
      File testRunnerDest = new File(coreDir, "TestRunner.hta");
      // custom user-extensions
      File userExt = this.configuration.getUserExtensions();
      if (userExt != null) {
        File selUserExt = new File(coreDir, "scripts/user-extensions.js");
        FileHandler.copy(userExt, selUserExt);
      }
      FileHandler.copy(selRunnerSrc, selRunnerDest);
      FileHandler.copy(testRunnerSrc, testRunnerDest);
      writeSessionExtensionJs(coreDir);
    } catch (IOException e) {
      throw new RuntimeException(e);
    }
  }

  /**
   * Writes the session extension javascript to the custom profile directory. The request for it
   * does not pass through the Selenium server in HTA mode, thus the specialized extension js
   * resource handler is of no use.
   * 
   * @param coreDir
   * @throws IOException
   */
  private void writeSessionExtensionJs(File coreDir) throws IOException {
    FrameGroupCommandQueueSet queueSet =
        FrameGroupCommandQueueSet.getQueueSet(sessionId);

    if (queueSet.getExtensionJs().length() > 0) {
      String path = "scripts/user-extensions.js[" + sessionId + "]";
      FileWriter fileWriter = new FileWriter(new File(coreDir, path));
      BufferedWriter writer = new BufferedWriter(fileWriter);

      writer.write(queueSet.getExtensionJs());
      writer.close();

      fileWriter.close();
    }
  }

  public void close() {
    if (browserOptions.is("killProcessesByName")) {
      WindowsUtils.tryToKillByName("iexplore.exe");
    }
    if (browserOptions.is("killProcessesByName")) {
      WindowsUtils.tryToKillByName("mshta.exe");
    }
    if (iexploreProcess != null) {
      int exitValue = iexploreProcess.destroy();
      if (exitValue == 0) {
        log.warning("Embedded iexplore seems to have ended on its own (did we kill the real browser???)");
      }
    }
    if (htaProcess == null) return;
    htaProcess.destroy();
    LauncherUtils.recursivelyDeleteDir(dir);
  }

  public void launchHTMLSuite(String suiteUrl, String browserURL) {
    launch(
        LauncherUtils.getDefaultHTMLSuiteUrl(browserURL, suiteUrl,
            (!BrowserOptions.isSingleWindow(browserOptions)), getPort()), "TestRunner.hta");
  }

  private int getPort() {
    return configuration.getPortDriversShouldContact();
  }

  public void launchRemoteSession(String url) {
    launch(
        LauncherUtils.getDefaultRemoteSessionUrl(url, sessionId,
            (!BrowserOptions.isSingleWindow(browserOptions)), getPort(),
            browserOptions.is("browserSideLog")), "RemoteRunner.hta");
  }

}