/*
    * Copyright 2005-2013 The Kuali Foundation
    *
    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
    *
   * 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 edu.samplu.common;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.commons.lang3.exception.ExceptionUtils;
  import org.openqa.selenium.By;
  import org.openqa.selenium.JavascriptExecutor;
  import org.openqa.selenium.NoSuchFrameException;
  import org.openqa.selenium.Proxy;
  import org.openqa.selenium.WebDriver;
  import org.openqa.selenium.WebElement;
  import org.openqa.selenium.chrome.ChromeDriver;
  import org.openqa.selenium.chrome.ChromeDriverService;
  import org.openqa.selenium.firefox.FirefoxDriver;
  import org.openqa.selenium.firefox.FirefoxProfile;
  import org.openqa.selenium.remote.CapabilityType;
  import org.openqa.selenium.remote.DesiredCapabilities;
  import org.openqa.selenium.remote.RemoteWebDriver;
  import org.openqa.selenium.safari.SafariDriver;
  
  import com.thoughtworks.selenium.SeleneseTestBase;
  
  import java.io.File;
  import java.net.MalformedURLException;
  import java.net.URL;
  import java.util.concurrent.TimeUnit;
  
  /**
   * The goal of the WebDriverUtil class is to invert the dependencies on WebDriver from WebDriverLegacyITBase for reuse
   * without having to extend WebDriverLegacyITBase.  For the first example see waitFor
   *
   * @see WebDriverLegacyITBase
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class WebDriverUtil {
  
      public static boolean jGrowlEnabled = false;
  
      public static boolean jsHighlightEnabled = false;
  
      /**
       * TODO apparent dup WebDriverITBase.DEFAULT_WAIT_SEC
       * TODO parametrize for JVM Arg
       * 30 Seconds
       */
      public static int DEFAULT_IMPLICIT_WAIT_TIME = 30;
  
      /**
       * false
       * TODO upgrade to config via JVM param.
       */
      public static final boolean JGROWL_ERROR_FAILURE = false;
  
      /**
       * green
       */
      public static final String JS_HIGHLIGHT_BACKGROUND = "green";
  
      /**
       * green
       */
      public static final String JS_HIGHLIGHT_BOARDER = "green";
  
      /**
       * 400 milliseconds
       */
      public static final int JS_HIGHLIGHT_MS = 400;
  
      /**
       * -Dremote.driver.highlight=true to enable highlighting of elements as selenium runs
       */
      public static final String JS_HIGHLIGHT_PROPERTY = "remote.driver.highlight";
  
      /**
       * TODO introduce SHORT_IMPLICIT_WAIT_TIME with param in WebDriverITBase
       * TODO parametrize for JVM Arg
       * 1 Second
       */
      public static int SHORT_IMPLICIT_WAIT_TIME = 1;
  
      /**
       * Set -Dremote.driver.saucelabs for running on saucelabs
       * @link https://wiki.kuali.org/display/KULRICE/How+To+Run+a+Selenium+Test for patch required
       */
      public static final String REMOTE_DRIVER_SAUCELABS_PROPERTY = "remote.driver.saucelabs";
 
     /**
      * Selenium's webdriver.chrome.driver parameter, you can set -Dwebdriver.chrome.driver= or Rice's REMOTE_PUBLIC_CHROME
      */
     public static final String WEBDRIVER_CHROME_DRIVER = "webdriver.chrome.driver";
 
     /**
      * Set -Dremote.jgrowl.enabled=
      */
     public static final String REMOTE_JGROWL_ENABLED = "remote.jgrowl.enabled";
 
     /**
      * Set -Dremote.login.uif=KNS to use old login screen.  Default value = KRAD
      */
     public static final String REMOTE_LOGIN_UIF = "remote.login.uif";
 
     /**
      * Set -Dremote.public.chrome= or WEBDRIVER_CHROME_DRIVER
      */
     public static final String REMOTE_PUBLIC_CHROME = "remote.public.chrome";
 
     /**
      * Time to wait for the URL used in setup to load.  Sometimes this is the first hit on the app and it needs a bit
      * longer than any other.  120 Seconds.
      * TODO parametrize for JVM Arg
      */
     public static final int SETUP_URL_LOAD_WAIT_SECONDS = 120;
 
     /**
      * local proxy used for running tests thru jmeter.
      * Include host name and port number. Example: localhost:7777
      */
     public static final String PROXY_HOST_PROPERTY = "remote.public.proxy";
 
     /**
      * Setup the WebDriver test, login, and load the given web page
      *
      * @param username
      * @param url
      * @return driver
      * @throws Exception
      */
     public static WebDriver setUp(String username, String url) throws Exception {
         return setUp(username, url, null, null);
     }
 
     /**
      * Setup the WebDriver test, login, and load the given web page
      *
      * @param username
      * @param url
      * @param className
      * @param testName
      * @return driver
      * @throws Exception
      */
     public static WebDriver setUp(String username, String url, String className, String testName) throws Exception {
         if ("true".equals(System.getProperty(REMOTE_JGROWL_ENABLED, "false"))) {
             jGrowlEnabled = true;
         }
 
         if ("true".equals(System.getProperty(JS_HIGHLIGHT_PROPERTY, "false"))) {
             jsHighlightEnabled = true;
         }
 
         WebDriver driver = null;
         if (System.getProperty(REMOTE_DRIVER_SAUCELABS_PROPERTY) == null) {
             driver = getWebDriver();
         } else {
             SauceLabsWebDriverHelper saucelabs = new SauceLabsWebDriverHelper();
             saucelabs.setUp(className, testName);
             driver = saucelabs.getDriver();
         }
 
         driver.manage().timeouts().implicitlyWait(SETUP_URL_LOAD_WAIT_SECONDS, TimeUnit.SECONDS);
         driver.manage().window().maximize();
 
         // TODO Got into the situation where the first url doesn't expect server, but all others do.  Readdress once
         // the NavIT WDIT conversion has been completed.
         if (!url.startsWith("http")) {
             url = ITUtil.getBaseUrlString() + url;
         }
 
         driver.get(url);
         driver.manage().timeouts().implicitlyWait(DEFAULT_IMPLICIT_WAIT_TIME, TimeUnit.SECONDS);
         return driver;
     }
 
     /**
      *
      * @param passed
      * @param sessionId
      * @param testParam
      * @param userParam
      * @throws Exception
      */
     public static void tearDown(boolean passed, String sessionId, String testParam, String userParam) throws Exception {
 
         if (System.getProperty(SauceLabsWebDriverHelper.SAUCE_PROPERTY) != null) {
             SauceLabsWebDriverHelper.tearDown(passed, sessionId, System.getProperty(SauceLabsWebDriverHelper.SAUCE_USER_PROPERTY),
                     System.getProperty(SauceLabsWebDriverHelper.SAUCE_KEY_PROPERTY));
         }
 
         if (System.getProperty(WebDriverLegacyITBase.REMOTE_PUBLIC_USERPOOL_PROPERTY) != null) {
             ITUtil.getHTML(ITUtil.prettyHttp(System.getProperty(WebDriverLegacyITBase.REMOTE_PUBLIC_USERPOOL_PROPERTY) + "?test="
                     + testParam + "&user=" + userParam));
         }
     }
 
     /**
      *
      * @param testParam
      * @return
      */
     public static String determineUser(String testParam) {
         String user = null;
 
         if (System.getProperty(WebDriverLegacyITBase.REMOTE_PUBLIC_USER_PROPERTY) != null) {
             return System.getProperty(WebDriverLegacyITBase.REMOTE_PUBLIC_USER_PROPERTY);
         } else if (System.getProperty(WebDriverLegacyITBase.REMOTE_PUBLIC_USERPOOL_PROPERTY) != null) { // deprecated
             String userResponse = ITUtil.getHTML(ITUtil.prettyHttp(System.getProperty(
                     WebDriverLegacyITBase.REMOTE_PUBLIC_USERPOOL_PROPERTY) + "?test=" + testParam.trim()));
             return userResponse.substring(userResponse.lastIndexOf(":") + 2, userResponse.lastIndexOf("\""));
         }
 
         return user;
     }
 
     /***
      * @link ITUtil#checkForIncidentReport
      * @param driver
      * @param locator
      * @param message
      */
     public static void checkForIncidentReport(WebDriver driver, String locator, Failable failable,
             String message) {
         ITUtil.checkForIncidentReport(driver.getPageSource(), locator, failable, message);
     }
 
     /**
      * @link http://code.google.com/p/chromedriver/downloads/list
      * @link #REMOTE_PUBLIC_CHROME
      * @link #WEBDRIVER_CHROME_DRIVER
      * @link ITUtil#HUB_DRIVER_PROPERTY
      * @return chromeDriverService
      */
     public static ChromeDriverService chromeDriverCreateCheck() {
         String driverParam = System.getProperty(ITUtil.HUB_DRIVER_PROPERTY);
         // TODO can the saucelabs driver stuff be leveraged here?
         if (driverParam != null && "chrome".equals(driverParam.toLowerCase())) {
             if (System.getProperty(WEBDRIVER_CHROME_DRIVER) == null) {
                 if (System.getProperty(REMOTE_PUBLIC_CHROME) != null) {
                     System.setProperty(WEBDRIVER_CHROME_DRIVER, System.getProperty(REMOTE_PUBLIC_CHROME));
                 }
             }
             try {
                 ChromeDriverService chromeDriverService = new ChromeDriverService.Builder()
                         .usingDriverExecutable(new File(System.getProperty(WEBDRIVER_CHROME_DRIVER)))
                         .usingAnyFreePort()
                         .build();
                 return chromeDriverService;
             } catch (Throwable t) {
                 throw new RuntimeException("Exception starting chrome driver service, is chromedriver ( http://code.google.com/p/chromedriver/downloads/list ) installed? You can include the path to it using -Dremote.public.chrome", t)   ;
             }
         }
         return null;
     }
 
     public static void jGrowl(WebDriver driver, String jGrowlHeader, boolean sticky, String message, Throwable t) {
         if (jGrowlEnabled) { // check if jGrowl is enabled to skip over the stack trace extraction if it is not.
             jGrowl(driver, jGrowlHeader, sticky, message + " " + t.getMessage() + "\n" + ExceptionUtils.getStackTrace(t));
         }
     }
 
     public static void jGrowl(WebDriver driver, String jGrowlHeader, boolean sticky, String message) {
         if (jGrowlEnabled) {
             try {
                 String javascript="jQuery.jGrowl('" + message + "' , {sticky: " + sticky + ", header : '" + jGrowlHeader + "'});";
                 ((JavascriptExecutor) driver).executeScript(javascript);
             } catch (Throwable t) {
                 jGrowlException(t);
             }
         }
     }
 
     public static void jGrowlException(Throwable t) {
         String failMessage = t.getMessage() + "\n" + ExceptionUtils.getStackTrace(t);
         System.out.println("jGrowl failure " + failMessage);
         if (JGROWL_ERROR_FAILURE) {
             SeleneseTestBase.fail(failMessage);
         }
     }
 
     public static void highlightElement(WebDriver webDriver, WebElement webElement) {
         if (jsHighlightEnabled) {
             try {
                 JavascriptExecutor js = (JavascriptExecutor) webDriver;
                 js.executeScript("element = arguments[0];\n"
                         + "originalStyle = element.getAttribute('style');\n"
                         + "element.setAttribute('style', originalStyle + \"; background: "
                         + JS_HIGHLIGHT_BACKGROUND + "; border: 2px solid " + JS_HIGHLIGHT_BOARDER + ";\");\n"
                         + "setTimeout(function(){\n"
                         + "    element.setAttribute('style', originalStyle);\n"
                         + "}, " + JS_HIGHLIGHT_MS + ");", webElement);
             } catch (Throwable t) {
                 System.out.println("Throwable during javascript highlight element");
                 t.printStackTrace();
             }
         }
     }
 
 
     /**
      * remote.public.driver set to chrome or firefox (null assumes firefox)
      * if remote.public.hub is set a RemoteWebDriver is created (Selenium Grid)
      * if proxy.host is set, the web driver is setup to use a proxy
      * @return WebDriver or null if unable to create
      */
     public static WebDriver getWebDriver() {
         String driverParam = System.getProperty(ITUtil.HUB_DRIVER_PROPERTY);
         String hubParam = System.getProperty(ITUtil.HUB_PROPERTY);
         String proxyParam = System.getProperty(PROXY_HOST_PROPERTY);
 
         // setup proxy if specified as VM Arg
         DesiredCapabilities capabilities = new DesiredCapabilities();
         WebDriver webDriver = null;
         if (StringUtils.isNotEmpty(proxyParam)) {
             capabilities.setCapability(CapabilityType.PROXY, new Proxy().setHttpProxy(proxyParam));
         }
 
         if (hubParam == null) {
             if (driverParam == null || "firefox".equalsIgnoreCase(driverParam)) {
                 FirefoxProfile profile = new FirefoxProfile();
                 profile.setEnableNativeEvents(false);
                 capabilities.setCapability(FirefoxDriver.PROFILE, profile);
                 return new FirefoxDriver(capabilities);
             } else if ("chrome".equalsIgnoreCase(driverParam)) {
                 return new ChromeDriver(capabilities);
             } else if ("safari".equals(driverParam)) {
                 System.out.println("SafariDriver probably won't work, if it does please contact Erik M.");
                 return new SafariDriver(capabilities);
             }
         } else {
             try {
                 if (driverParam == null || "firefox".equalsIgnoreCase(driverParam)) {
                     return new RemoteWebDriver(new URL(ITUtil.getHubUrlString()), DesiredCapabilities.firefox());
                 } else if ("chrome".equalsIgnoreCase(driverParam)) {
                     return new RemoteWebDriver(new URL(ITUtil.getHubUrlString()), DesiredCapabilities.chrome());
                 }
             } catch (MalformedURLException mue) {
                 System.out.println(ITUtil.getHubUrlString() + " " + mue.getMessage());
                 mue.printStackTrace();
             }
         }
         return null;
     }
 
     /**
      * Logs in using the KRAD Login Page
      * If the JVM arg remote.autologin is set, auto login as admin will not be done.
      * @param driver
      * @param userName
      * @param failable
      * @throws InterruptedException
      */
     public static void kradLogin(WebDriver driver, String userName, Failable failable) throws InterruptedException {
             driver.findElement(By.name("login_user")).clear();
             driver.findElement(By.name("login_user")).sendKeys(userName);
             driver.findElement(By.id("Rice-LoginButton")).click();
             Thread.sleep(1000);
             String contents = driver.getPageSource();
             ITUtil.failOnInvalidUserName(userName, contents, failable);
             ITUtil.checkForIncidentReport(driver.getPageSource(), "Krad Login", failable, "Krad Login failure");
     }
 
     /**
      * Logs into the Rice portal using the KNS Style Login Page.
      * @param driver
      * @param userName
      * @param failable
      * @throws InterruptedException
      */
     public static void login(WebDriver driver, String userName, Failable failable) throws InterruptedException {
             driver.findElement(By.name("__login_user")).clear();
             driver.findElement(By.name("__login_user")).sendKeys(userName);
             driver.findElement(By.cssSelector("input[type=\"submit\"]")).click();
             Thread.sleep(1000);
             String contents = driver.getPageSource();
             ITUtil.failOnInvalidUserName(userName, contents, failable);
             ITUtil.checkForIncidentReport(driver.getPageSource(), "KNS Login", failable, "KNS Login failure");
     }
 
     public static void loginKradOrKns(WebDriver driver, String user, Failable failable) throws InterruptedException {// login via either KRAD or KNS login page
         if ("true".equalsIgnoreCase(System.getProperty(ITUtil.REMOTE_AUTOLOGIN_PROPERTY, "true"))) {
             if (isKradLogin()){
                 WebDriverUtil.kradLogin(driver, user, failable);
             } else {
                 WebDriverUtil.login(driver, user, failable);
             }
         }
     }
 
     /**
      * Use the KRAD Login Screen or the old KNS Login Screen
      */
     public static boolean isKradLogin(){
         // check system property, default to KRAD
         String loginUif = System.getProperty(REMOTE_LOGIN_UIF);
         if (loginUif == null) {
             loginUif = ITUtil.REMOTE_UIF_KRAD;
         }
 
         return (ITUtil.REMOTE_UIF_KRAD.equalsIgnoreCase(loginUif));
     }
 
     protected static void selectFrameSafe(WebDriver driver, String locator) {
         try {
             driver.switchTo().frame(locator);
         } catch (NoSuchFrameException nsfe) {
             // don't fail
         }
     }
 
     /**
      * Wait for the given amount of seconds, for the given by, using the given driver.  The message is displayed if the
      * by cannot be found.  No action is performed on the by, so it is possible that the by found is not visible or enabled.
      *
      * @param driver WebDriver
      * @param waitSeconds int
      * @param by By
      * @param message String
      * @throws InterruptedException
      */
     public static void waitFor(WebDriver driver, int waitSeconds, By by, String message) throws InterruptedException {
         driver.manage().timeouts().implicitlyWait(waitSeconds, TimeUnit.SECONDS);
         Thread.sleep(1000);
         driver.findElement(by);  // NOTICE just the find, no action, so by is found, but might not be visible or enabled.
         driver.manage().timeouts().implicitlyWait(1, TimeUnit.SECONDS);
     }
 
     /**
      * Wait for the given amount of seconds, for the given by, using the given driver.  The message is displayed if the
      * by cannot be found.  No action is performed on the by, so it is possible that the by found is not visible or enabled.
      *
      * @param driver WebDriver
      * @param waitSeconds int
      * @param by By
      * @param message String
      * @throws InterruptedException
      */
     public static void waitFors(WebDriver driver, int waitSeconds, By by, String message) throws InterruptedException {
         driver.manage().timeouts().implicitlyWait(waitSeconds, TimeUnit.SECONDS);
         Thread.sleep(1000);
         driver.findElements(by);  // NOTICE just the find, no action, so by is found, but might not be visible or enabled.
         driver.manage().timeouts().implicitlyWait(1, TimeUnit.SECONDS);
     }
 
 
     public static void failOnMatchedJira(String contents, Failable failable) {
         JiraAwareFailureUtil.failOnMatchedJira(contents, failable);
     }
     
     private static void failWithReportInfoForKim(String contents, String linkLocator, String message) {
         final String kimIncidentReport = extractIncidentReportKim(contents, linkLocator, message);
         SeleneseTestBase.fail(kimIncidentReport);
     }
     
     private static String extractIncidentReportKim(String contents, String linkLocator, String message) {
         String chunk =  contents.substring(contents.indexOf("id=\"headerarea\""), contents.lastIndexOf("</div>") );
         String docIdPre = "type=\"hidden\" value=\"";
         String docId = chunk.substring(chunk.indexOf(docIdPre) + docIdPre.length(), chunk.indexOf("\" name=\"documentId\""));
 
         String stackTrace = chunk.substring(chunk.lastIndexOf("name=\"displayMessage\""), chunk.length());
         String stackTracePre = "value=\"";
         stackTrace = stackTrace.substring(stackTrace.indexOf(stackTracePre) + stackTracePre.length(), stackTrace.indexOf("name=\"stackTrace\"") - 2);
 
         return "\nIncident report "+ message+ " navigating to "+ linkLocator + " Doc Id: "+ docId.trim()+ "\nStackTrace: "+ stackTrace.trim().replace(" at ","");
     }
     
     private static void processIncidentReport(String contents, String linkLocator, Failable failable, String message) {
         failOnMatchedJira(contents, failable);
 
         if (contents.indexOf("Incident Feedback") > -1) {
             failWithReportInfo(contents, linkLocator, message);
         }
 
         if (contents.indexOf("Incident Report") > -1) { // KIM incident report
             failWithReportInfoForKim(contents, linkLocator, message);
         }
 
         SeleneseTestBase.fail("\nIncident report detected " + message + "\n Unable to parse out details for the contents that triggered exception: " + deLinespace(
                 contents));
     }
 
     private static void failWithReportInfo(String contents, String linkLocator, String message) {
         final String incidentReportInformation = extractIncidentReportInfo(contents, linkLocator, message);
         SeleneseTestBase.fail(incidentReportInformation);
     }
     
     private static String extractIncidentReportInfo(String contents, String linkLocator, String message) {
         String chunk =  contents.substring(contents.indexOf("Incident Feedback"), contents.lastIndexOf("</div>") );
         String docId = chunk.substring(chunk.lastIndexOf("Document Id"), chunk.indexOf("View Id"));
         docId = docId.substring(0, docId.indexOf("</span>"));
         docId = docId.substring(docId.lastIndexOf(">") + 2, docId.length());
 
         String viewId = chunk.substring(chunk.lastIndexOf("View Id"), chunk.indexOf("Error Message"));
         viewId = viewId.substring(0, viewId.indexOf("</span>"));
         viewId = viewId.substring(viewId.lastIndexOf(">") + 2, viewId.length());
 
         String stackTrace = chunk.substring(chunk.lastIndexOf("(only in dev mode)"), chunk.length());
         stackTrace = stackTrace.substring(stackTrace.indexOf("<span id=\"") + 3, stackTrace.length());
         stackTrace = stackTrace.substring(stackTrace.indexOf("\">") + 2, stackTrace.indexOf("</span>"));
     
         return "\nIncident report "+ message+ " navigating to "+ linkLocator+ " : View Id: "+ viewId.trim()+ " Doc Id: "+ docId.trim()+ "\nStackTrace: "+ stackTrace.trim().replace(" at ", "");
     }
     
     public static String deLinespace(String contents) {
         while (contents.contains("\n\n")) {
             contents = contents.replaceAll("\n\n", "\n");
         }
         
         return contents;
     }
 }