Source/WebCore/inspector/DOMEditor.cpp

/*
 * Copyright (C) 2012 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 "config.h"
#include "DOMEditor.h"

#include "DOMPatchSupport.h"
#include "Document.h"
#include "Element.h"
#include "ExceptionCode.h"
#include "ExceptionCodeDescription.h"
#include "InspectorHistory.h"
#include "Node.h"
#include "Text.h"
#include "markup.h"
#include <wtf/RefPtr.h>

namespace WebCore {

class DOMEditor::RemoveChildAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(RemoveChildAction);
public:
    RemoveChildAction(Node& parentNode, Node& node)
        : InspectorHistory::Action("RemoveChild")
        , m_parentNode(parentNode)
        , m_node(node)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_anchorNode = m_node->nextSibling();
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        return m_parentNode->insertBefore(m_node, m_anchorNode.get(), ec);
    }

    bool redo(ExceptionCode& ec) override
    {
        return m_parentNode->removeChild(m_node, ec);
    }

private:
    Ref<Node> m_parentNode;
    Ref<Node> m_node;
    RefPtr<Node> m_anchorNode;
};

class DOMEditor::InsertBeforeAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(InsertBeforeAction);
public:
    InsertBeforeAction(Node& parentNode, Ref<Node>&& node, Node* anchorNode)
        : InspectorHistory::Action("InsertBefore")
        , m_parentNode(parentNode)
        , m_node(WTFMove(node))
        , m_anchorNode(anchorNode)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        if (m_node->parentNode()) {
            m_removeChildAction = std::make_unique<RemoveChildAction>(*m_node->parentNode(), m_node);
            if (!m_removeChildAction->perform(ec))
                return false;
        }
        return m_parentNode->insertBefore(m_node, m_anchorNode.get(), ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        if (!m_parentNode->removeChild(m_node, ec))
            return false;
        if (m_removeChildAction)
            return m_removeChildAction->undo(ec);
        return true;
    }

    bool redo(ExceptionCode& ec) override
    {
        if (m_removeChildAction && !m_removeChildAction->redo(ec))
            return false;
        return m_parentNode->insertBefore(m_node, m_anchorNode.get(), ec);
    }

private:
    Ref<Node> m_parentNode;
    Ref<Node> m_node;
    RefPtr<Node> m_anchorNode;
    std::unique_ptr<RemoveChildAction> m_removeChildAction;
};

class DOMEditor::RemoveAttributeAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(RemoveAttributeAction);
public:
    RemoveAttributeAction(Element* element, const String& name)
        : InspectorHistory::Action("RemoveAttribute")
        , m_element(element)
        , m_name(name)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_value = m_element->getAttribute(m_name);
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        m_element->setAttribute(m_name, m_value, ec);
        return true;
    }

    bool redo(ExceptionCode&) override
    {
        m_element->removeAttribute(m_name);
        return true;
    }

private:
    RefPtr<Element> m_element;
    String m_name;
    String m_value;
};

class DOMEditor::SetAttributeAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(SetAttributeAction);
public:
    SetAttributeAction(Element* element, const String& name, const String& value)
        : InspectorHistory::Action("SetAttribute")
        , m_element(element)
        , m_name(name)
        , m_value(value)
        , m_hadAttribute(false)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_hadAttribute = m_element->hasAttribute(m_name);
        if (m_hadAttribute)
            m_oldValue = m_element->getAttribute(m_name);
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        if (m_hadAttribute)
            m_element->setAttribute(m_name, m_oldValue, ec);
        else
            m_element->removeAttribute(m_name);
        return true;
    }

    bool redo(ExceptionCode& ec) override
    {
        m_element->setAttribute(m_name, m_value, ec);
        return true;
    }

private:
    RefPtr<Element> m_element;
    String m_name;
    String m_value;
    bool m_hadAttribute;
    String m_oldValue;
};

class DOMEditor::SetOuterHTMLAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(SetOuterHTMLAction);
public:
    SetOuterHTMLAction(Node& node, const String& html)
        : InspectorHistory::Action("SetOuterHTML")
        , m_node(node)
        , m_nextSibling(node.nextSibling())
        , m_html(html)
        , m_newNode(nullptr)
        , m_history(std::make_unique<InspectorHistory>())
        , m_domEditor(std::make_unique<DOMEditor>(m_history.get()))
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_oldHTML = createMarkup(m_node.get());
        DOMPatchSupport domPatchSupport(m_domEditor.get(), &m_node->document());
        m_newNode = domPatchSupport.patchNode(m_node.get(), m_html, ec);
        return !ec;
    }

    bool undo(ExceptionCode& ec) override
    {
        return m_history->undo(ec);
    }

    bool redo(ExceptionCode& ec) override
    {
        return m_history->redo(ec);
    }

    Node* newNode()
    {
        return m_newNode;
    }

private:
    Ref<Node> m_node;
    RefPtr<Node> m_nextSibling;
    String m_html;
    String m_oldHTML;
    Node* m_newNode;
    std::unique_ptr<InspectorHistory> m_history;
    std::unique_ptr<DOMEditor> m_domEditor;
};

class DOMEditor::ReplaceWholeTextAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(ReplaceWholeTextAction);
public:
    ReplaceWholeTextAction(Text* textNode, const String& text)
        : InspectorHistory::Action("ReplaceWholeText")
        , m_textNode(textNode)
        , m_text(text)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_oldText = m_textNode->wholeText();
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        m_textNode->replaceWholeText(m_oldText, ec);
        return true;
    }

    bool redo(ExceptionCode& ec) override
    {
        m_textNode->replaceWholeText(m_text, ec);
        return true;
    }

private:
    RefPtr<Text> m_textNode;
    String m_text;
    String m_oldText;
};

class DOMEditor::ReplaceChildNodeAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(ReplaceChildNodeAction);
public:
    ReplaceChildNodeAction(Node& parentNode, Ref<Node>&& newNode, Node& oldNode)
        : InspectorHistory::Action("ReplaceChildNode")
        , m_parentNode(parentNode)
        , m_newNode(WTFMove(newNode))
        , m_oldNode(oldNode)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        return m_parentNode->replaceChild(m_oldNode, m_newNode.get(), ec);
    }

    bool redo(ExceptionCode& ec) override
    {
        return m_parentNode->replaceChild(m_newNode, m_oldNode, ec);
    }

private:
    Ref<Node> m_parentNode;
    Ref<Node> m_newNode;
    Ref<Node> m_oldNode;
};

class DOMEditor::SetNodeValueAction : public InspectorHistory::Action {
    WTF_MAKE_NONCOPYABLE(SetNodeValueAction);
public:
    SetNodeValueAction(Node* node, const String& value)
        : InspectorHistory::Action("SetNodeValue")
        , m_node(node)
        , m_value(value)
    {
    }

    bool perform(ExceptionCode& ec) override
    {
        m_oldValue = m_node->nodeValue();
        return redo(ec);
    }

    bool undo(ExceptionCode& ec) override
    {
        m_node->setNodeValue(m_oldValue, ec);
        return !ec;
    }

    bool redo(ExceptionCode& ec) override
    {
        m_node->setNodeValue(m_value, ec);
        return !ec;
    }

private:
    RefPtr<Node> m_node;
    String m_value;
    String m_oldValue;
};

DOMEditor::DOMEditor(InspectorHistory* history) : m_history(history) { }

DOMEditor::~DOMEditor() { }

bool DOMEditor::insertBefore(Node& parentNode, Ref<Node>&& node, Node* anchorNode, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<InsertBeforeAction>(parentNode, WTFMove(node), anchorNode), ec);
}

bool DOMEditor::removeChild(Node& parentNode, Node& node, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<RemoveChildAction>(parentNode, node), ec);
}

bool DOMEditor::setAttribute(Element* element, const String& name, const String& value, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<SetAttributeAction>(element, name, value), ec);
}

bool DOMEditor::removeAttribute(Element* element, const String& name, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<RemoveAttributeAction>(element, name), ec);
}

bool DOMEditor::setOuterHTML(Node& node, const String& html, Node** newNode, ExceptionCode& ec)
{
    auto action = std::make_unique<SetOuterHTMLAction>(node, html);
    SetOuterHTMLAction* rawAction = action.get();
    bool result = m_history->perform(WTFMove(action), ec);
    if (result)
        *newNode = rawAction->newNode();
    return result;
}

bool DOMEditor::replaceWholeText(Text* textNode, const String& text, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<ReplaceWholeTextAction>(textNode, text), ec);
}

bool DOMEditor::replaceChild(Node& parentNode, Ref<Node>&& newNode, Node& oldNode, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<ReplaceChildNodeAction>(parentNode, WTFMove(newNode), oldNode), ec);
}

bool DOMEditor::setNodeValue(Node* node, const String& value, ExceptionCode& ec)
{
    return m_history->perform(std::make_unique<SetNodeValueAction>(node, value), ec);
}

static void populateErrorString(const ExceptionCode& ec, ErrorString& errorString)
{
    if (ec) {
        ExceptionCodeDescription description(ec);
        errorString = description.name;
    }
}

bool DOMEditor::insertBefore(Node& parentNode, Ref<Node>&& node, Node* anchorNode, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = insertBefore(parentNode, WTFMove(node), anchorNode, ec);
    populateErrorString(ec, errorString);
    return result;
}

bool DOMEditor::removeChild(Node& parentNode, Node& node, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = removeChild(parentNode, node, ec);
    populateErrorString(ec, errorString);
    return result;
}

bool DOMEditor::setAttribute(Element* element, const String& name, const String& value, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = setAttribute(element, name, value, ec);
    populateErrorString(ec, errorString);
    return result;
}

bool DOMEditor::removeAttribute(Element* element, const String& name, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = removeAttribute(element, name, ec);
    populateErrorString(ec, errorString);
    return result;
}

bool DOMEditor::setOuterHTML(Node& node, const String& html, Node** newNode, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = setOuterHTML(node, html, newNode, ec);
    populateErrorString(ec, errorString);
    return result;
}

bool DOMEditor::replaceWholeText(Text* textNode, const String& text, ErrorString& errorString)
{
    ExceptionCode ec = 0;
    bool result = replaceWholeText(textNode, text, ec);
    populateErrorString(ec, errorString);
    return result;
}

} // namespace WebCore