cpp/iedriver/CommandHandlers/GetElementRectCommandHandler.cpp

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you 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.

#include "GetElementRectCommandHandler.h"
#include "errorcodes.h"
#include "../Browser.h"
#include "../BrowserFactory.h"
#include "../Element.h"
#include "../Generated/atoms.h"
#include "../IECommandExecutor.h"
#include "../Script.h"

namespace webdriver {

GetElementRectCommandHandler::GetElementRectCommandHandler(void) {
}

GetElementRectCommandHandler::~GetElementRectCommandHandler(void) {
}

void GetElementRectCommandHandler::ExecuteInternal(
    const IECommandExecutor& executor,
    const ParametersMap& command_parameters,
    Response* response) {
  ParametersMap::const_iterator id_parameter_iterator = command_parameters.find("id");
  if (id_parameter_iterator == command_parameters.end()) {
    response->SetErrorResponse(ERROR_INVALID_ARGUMENT, "Missing parameter in URL: id");
    return;
  } else {
    std::string element_id = id_parameter_iterator->second.asString();

    BrowserHandle browser_wrapper;
    int status_code = executor.GetCurrentBrowser(&browser_wrapper);
    if (status_code != WD_SUCCESS) {
      response->SetErrorResponse(ERROR_NO_SUCH_WINDOW, "Unable to get browser");
      return;
    }

    ElementHandle element_wrapper;
    status_code = this->GetElement(executor, element_id, &element_wrapper);
    if (status_code == WD_SUCCESS) {
      // The atom is just the definition of an anonymous
      // function: "function() {...}"; Wrap it in another function so we can
      // invoke it with our arguments without polluting the current namespace.
      // Furthermore, we need to invoke the function that is the atom and
      // get the result, but we need to wrap the execution in another function
      // so that it can be invoked without polluting the current namespace.
      std::wstring script_source(L"(function() { return (");
      script_source += atoms::asString(atoms::GET_ELEMENT_RECT);
      script_source += L")})();";

      CComPtr<IHTMLDocument2> doc;
      browser_wrapper->GetDocument(&doc);

      Json::Value rect_object;
      Script script_wrapper(doc, script_source, 1);
      script_wrapper.AddArgument(element_wrapper);
      status_code = script_wrapper.Execute();

      if (status_code == WD_SUCCESS) {
        script_wrapper.ConvertResultToJsonValue(executor, &rect_object);

        Json::Value response_value;
        response_value["width"] = rect_object["width"];
        response_value["height"] = rect_object["height"];

        double x = rect_object.get("x", 0).asDouble();
        double y = rect_object.get("y", 0).asDouble();

        int browser_version = executor.browser_factory()->browser_version();
        bool browser_appears_before_ie8 = browser_version < 8 || DocumentHost::GetDocumentMode(doc) <= 7;
        bool is_quirks_mode = !DocumentHost::IsStandardsMode(doc);
        if (browser_appears_before_ie8 && !is_quirks_mode) {
          // NOTE: For IE 6 and 7 in standards mode, elements with "display:none"
          // in the CSS style should have a 2-pixel offset for their location.
          std::string display_value = "";
          element_wrapper->GetCssPropertyValue("display", &display_value);
          if (display_value == "none") {
            int offset = 2;
            x += offset;
            y += offset;
          }
        }

        double x_int_part;
        if (std::modf(x, &x_int_part) == 0.0) {
          response_value["x"] = static_cast<long long>(x);
        } else {
          response_value["x"] = x;
        }

        double y_int_part;
        if (std::modf(y, &y_int_part) == 0.0) {
          response_value["y"] = static_cast<long long>(y);
        } else {
          response_value["y"] = y;
        }
        response->SetSuccessResponse(response_value);
        return;
      } else {
        response->SetErrorResponse(status_code, "Unable to get element sizes");
        return;
      }
    } else if (status_code == ENOSUCHELEMENT) {
      response->SetErrorResponse(ERROR_NO_SUCH_ELEMENT, "Invalid internal element ID requested: " + element_id);
      return;
    } else {
      response->SetErrorResponse(ERROR_STALE_ELEMENT_REFERENCE, "Element is no longer valid");
      return;
    }
  }
}

} // namespace webdriver