/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "web/ExternalPopupMenu.h"

#include "core/dom/ExecutionContextTask.h"
#include "core/dom/NodeComputedStyle.h"
#include "core/frame/FrameHost.h"
#include "core/frame/FrameView.h"
#include "core/frame/LocalFrame.h"
#include "core/html/HTMLOptionElement.h"
#include "core/html/HTMLSelectElement.h"
#include "core/layout/LayoutBox.h"
#include "core/page/Page.h"
#include "core/style/ComputedStyle.h"
#include "platform/geometry/FloatQuad.h"
#include "platform/geometry/IntPoint.h"
#include "platform/text/TextDirection.h"
#include "public/platform/WebVector.h"
#include "public/web/WebExternalPopupMenu.h"
#include "public/web/WebFrameClient.h"
#include "public/web/WebMenuItemInfo.h"
#include "public/web/WebPopupMenuInfo.h"
#include "web/WebLocalFrameImpl.h"
#include "web/WebViewImpl.h"
#include "wtf/PtrUtil.h"

namespace blink {

ExternalPopupMenu::ExternalPopupMenu(LocalFrame& frame,
                                     HTMLSelectElement& ownerElement,
                                     WebViewImpl& webView)
    : m_ownerElement(ownerElement),
      m_localFrame(frame),
      m_webView(webView),
      m_dispatchEventTimer(this, &ExternalPopupMenu::dispatchEvent),
      m_webExternalPopupMenu(0) {}

ExternalPopupMenu::~ExternalPopupMenu() {}

DEFINE_TRACE(ExternalPopupMenu) {
  visitor->trace(m_ownerElement);
  visitor->trace(m_localFrame);
  PopupMenu::trace(visitor);
}

bool ExternalPopupMenu::showInternal() {
  // Blink core reuses the PopupMenu of an element.  For simplicity, we do
  // recreate the actual external popup everytime.
  if (m_webExternalPopupMenu) {
    m_webExternalPopupMenu->close();
    m_webExternalPopupMenu = 0;
  }

  WebPopupMenuInfo info;
  getPopupMenuInfo(info, *m_ownerElement);
  if (info.items.isEmpty())
    return false;
  WebLocalFrameImpl* webframe =
      WebLocalFrameImpl::fromFrame(m_localFrame.get());
  m_webExternalPopupMenu =
      webframe->client()->createExternalPopupMenu(info, this);
  if (m_webExternalPopupMenu) {
    LayoutObject* layoutObject = m_ownerElement->layoutObject();
    if (!layoutObject || !layoutObject->isBox())
      return false;
    FloatQuad quad(toLayoutBox(layoutObject)
                       ->localToAbsoluteQuad(FloatQuad(
                           toLayoutBox(layoutObject)->borderBoundingBox())));
    IntRect rect(quad.enclosingBoundingBox());
    IntRect rectInViewport =
        m_localFrame->view()->soonToBeRemovedContentsToUnscaledViewport(rect);
    m_webExternalPopupMenu->show(rectInViewport);
    return true;
  } else {
    // The client might refuse to create a popup (when there is already one
    // pending to be shown for example).
    didCancel();
    return false;
  }
}

void ExternalPopupMenu::show() {
  if (!showInternal())
    return;
#if OS(MACOSX)
  const WebInputEvent* currentEvent = WebViewImpl::currentInputEvent();
  if (currentEvent && currentEvent->type == WebInputEvent::MouseDown) {
    m_syntheticEvent = wrapUnique(new WebMouseEvent);
    *m_syntheticEvent = *static_cast<const WebMouseEvent*>(currentEvent);
    m_syntheticEvent->type = WebInputEvent::MouseUp;
    m_dispatchEventTimer.startOneShot(0, BLINK_FROM_HERE);
    // FIXME: show() is asynchronous. If preparing a popup is slow and a
    // user released the mouse button before showing the popup, mouseup and
    // click events are correctly dispatched. Dispatching the synthetic
    // mouseup event is redundant in this case.
  }
#endif
}

void ExternalPopupMenu::dispatchEvent(TimerBase*) {
  m_webView.handleInputEvent(*m_syntheticEvent);
  m_syntheticEvent.reset();
}

void ExternalPopupMenu::hide() {
  if (m_ownerElement)
    m_ownerElement->popupDidHide();
  if (!m_webExternalPopupMenu)
    return;
  m_webExternalPopupMenu->close();
  m_webExternalPopupMenu = 0;
}

void ExternalPopupMenu::updateFromElement(UpdateReason reason) {
  switch (reason) {
    case BySelectionChange:
    case ByDOMChange:
      if (m_needsUpdate)
        return;
      m_needsUpdate = true;
      m_ownerElement->document().postTask(
          BLINK_FROM_HERE, createSameThreadTask(&ExternalPopupMenu::update,
                                                wrapPersistent(this)));
      break;

    case ByStyleChange:
      // TOOD(tkent): We should update the popup location/content in some
      // cases.  e.g. Updating ComputedStyle of the SELECT element affects
      // popup position and OPTION style.
      break;
  }
}

void ExternalPopupMenu::update() {
  if (!m_webExternalPopupMenu || !m_ownerElement)
    return;
  m_ownerElement->document().updateStyleAndLayoutTree();
  // disconnectClient() might have been called.
  if (!m_ownerElement)
    return;
  m_needsUpdate = false;

  if (showInternal())
    return;
  // We failed to show a popup.  Notify it to the owner.
  hide();
}

void ExternalPopupMenu::disconnectClient() {
  hide();
  m_ownerElement = nullptr;
}

void ExternalPopupMenu::didChangeSelection(int index) {}

void ExternalPopupMenu::didAcceptIndex(int index) {
  // Calling methods on the HTMLSelectElement might lead to this object being
  // derefed. This ensures it does not get deleted while we are running this
  // method.
  int popupMenuItemIndex = toPopupMenuItemIndex(index, *m_ownerElement);

  if (m_ownerElement) {
    m_ownerElement->popupDidHide();
    m_ownerElement->selectOptionByPopup(popupMenuItemIndex);
  }
  m_webExternalPopupMenu = 0;
}

// Android uses this function even for single SELECT.
void ExternalPopupMenu::didAcceptIndices(const WebVector<int>& indices) {
  if (!m_ownerElement) {
    m_webExternalPopupMenu = 0;
    return;
  }

  HTMLSelectElement* ownerElement = m_ownerElement;
  ownerElement->popupDidHide();

  if (indices.size() == 0) {
    ownerElement->selectOptionByPopup(-1);
  } else if (!ownerElement->isMultiple()) {
    ownerElement->selectOptionByPopup(
        toPopupMenuItemIndex(indices[indices.size() - 1], *ownerElement));
  } else {
    Vector<int> listIndices;
    listIndices.reserveCapacity(indices.size());
    for (size_t i = 0; i < indices.size(); ++i)
      listIndices.append(toPopupMenuItemIndex(indices[i], *ownerElement));
    ownerElement->selectMultipleOptionsByPopup(listIndices);
  }

  m_webExternalPopupMenu = 0;
}

void ExternalPopupMenu::didCancel() {
  if (m_ownerElement)
    m_ownerElement->popupDidHide();
  m_webExternalPopupMenu = 0;
}

void ExternalPopupMenu::getPopupMenuInfo(WebPopupMenuInfo& info,
                                         HTMLSelectElement& ownerElement) {
  const HeapVector<Member<HTMLElement>>& listItems = ownerElement.listItems();
  size_t itemCount = listItems.size();
  size_t count = 0;
  Vector<WebMenuItemInfo> items(itemCount);
  for (size_t i = 0; i < itemCount; ++i) {
    if (ownerElement.itemIsDisplayNone(*listItems[i]))
      continue;

    Element& itemElement = *listItems[i];
    WebMenuItemInfo& popupItem = items[count++];
    popupItem.label = ownerElement.itemText(itemElement);
    popupItem.toolTip = itemElement.title();
    popupItem.checked = false;
    if (isHTMLHRElement(itemElement)) {
      popupItem.type = WebMenuItemInfo::Separator;
    } else if (isHTMLOptGroupElement(itemElement)) {
      popupItem.type = WebMenuItemInfo::Group;
    } else {
      popupItem.type = WebMenuItemInfo::Option;
      popupItem.checked = toHTMLOptionElement(itemElement).selected();
    }
    popupItem.enabled = !itemElement.isDisabledFormControl();
    const ComputedStyle& style = *ownerElement.itemComputedStyle(itemElement);
    popupItem.textDirection = toWebTextDirection(style.direction());
    popupItem.hasTextDirectionOverride = isOverride(style.unicodeBidi());
  }

  const ComputedStyle& menuStyle = ownerElement.computedStyle()
                                       ? *ownerElement.computedStyle()
                                       : *ownerElement.ensureComputedStyle();
  const SimpleFontData* fontData = menuStyle.font().primaryFont();
  DCHECK(fontData);
  info.itemHeight = fontData ? fontData->getFontMetrics().height() : 0;
  info.itemFontSize =
      static_cast<int>(menuStyle.font().getFontDescription().computedSize());
  info.selectedIndex = toExternalPopupMenuItemIndex(
      ownerElement.selectedListIndex(), ownerElement);
  info.rightAligned = menuStyle.direction() == RTL;
  info.allowMultipleSelection = ownerElement.isMultiple();
  if (count < itemCount)
    items.shrink(count);
  info.items = items;
}

int ExternalPopupMenu::toPopupMenuItemIndex(int externalPopupMenuItemIndex,
                                            HTMLSelectElement& ownerElement) {
  if (externalPopupMenuItemIndex < 0)
    return externalPopupMenuItemIndex;

  int indexTracker = 0;
  const HeapVector<Member<HTMLElement>>& items = ownerElement.listItems();
  for (int i = 0; i < static_cast<int>(items.size()); ++i) {
    if (ownerElement.itemIsDisplayNone(*items[i]))
      continue;
    if (indexTracker++ == externalPopupMenuItemIndex)
      return i;
  }
  return -1;
}

int ExternalPopupMenu::toExternalPopupMenuItemIndex(
    int popupMenuItemIndex,
    HTMLSelectElement& ownerElement) {
  if (popupMenuItemIndex < 0)
    return popupMenuItemIndex;

  size_t indexTracker = 0;
  const HeapVector<Member<HTMLElement>>& items = ownerElement.listItems();
  for (int i = 0; i < static_cast<int>(items.size()); ++i) {
    if (ownerElement.itemIsDisplayNone(*items[i]))
      continue;
    if (popupMenuItemIndex == i)
      return indexTracker;
    ++indexTracker;
  }
  return -1;
}

}  // namespace blink