/*
    * Copyright (c) 2002-2026 Gargoyle Software Inc.
    *
    * 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
    * https://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.htmlunit.util;
  
  import java.awt.Frame;
  
  import org.apache.commons.lang3.StringUtils;
  import org.htmlunit.WebClient;
  import org.htmlunit.WebResponse;
  import org.htmlunit.WebWindow;
  import org.htmlunit.corejs.javascript.tools.debugger.Main;
  import org.htmlunit.corejs.javascript.tools.debugger.ScopeProvider;
  import org.htmlunit.corejs.javascript.tools.debugger.SourceProvider;
  import org.htmlunit.javascript.HtmlUnitContextFactory;
  
  /**
   * Utility class containing miscellaneous {@link WebClient}-related methods.
   *
   * @author Daniel Gredler
   * @author Ronald Brill
   */
  public final class WebClientUtils {
  
      /**
       * Disallow instantiation of this class.
       */
      private WebClientUtils() {
          // Empty.
      }
  
      /**
       * Attaches a visual (GUI) JavaScript debugger to the specified client.
       *
       * @param client the client to which the visual debugger is to be attached
       * @see <a href="https://developer.mozilla.org/en-US/docs/Tools">Mozilla Developer Tools</a>
       */
      public static void attachVisualDebugger(final WebClient client) {
          final HtmlUnitContextFactory cf = client.getJavaScriptEngine().getContextFactory();
          final Main main = Main.mainEmbedded(cf, (ScopeProvider) null, "HtmlUnit JavaScript Debugger");
          main.getDebugFrame().setExtendedState(Frame.MAXIMIZED_BOTH);
  
          final SourceProvider sourceProvider = script -> {
              String sourceName = script.getSourceName();
              if (sourceName.endsWith("(eval)") || sourceName.endsWith("(Function)")) {
                  return null; // script is result of eval call. Rhino already knows the source and we don't
              }
              if (sourceName.startsWith("script in ")) {
                  sourceName = StringUtils.substringBetween(sourceName, "script in ", " from");
                  for (final WebWindow ww : client.getWebWindows()) {
                      final WebResponse wr = ww.getEnclosedPage().getWebResponse();
                      if (sourceName.equals(wr.getWebRequest().getUrl().toString())) {
                          return wr.getContentAsString();
                      }
                  }
              }
              return null;
          };
          main.setSourceProvider(sourceProvider);
      }
  }