com.astamuse.asta4d.util.ElementUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asta4d-core Show documentation
core functionalities of asta4d framework, including template and snippt implemention
There is a newer version: 1.2-M2
/*
 * Copyright 2012 astamuse company,Ltd.
 * 
 * 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
 * 
 *     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.
 * 
 */

package com.astamuse.asta4d.util;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.lang3.reflect.FieldUtils;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Element;
import org.jsoup.nodes.Node;
import org.jsoup.nodes.TextNode;
import org.jsoup.select.Elements;

import com.astamuse.asta4d.extnode.GroupNode;

public class ElementUtil {

    public ElementUtil() {
    }

    public final static Element text(String text) {
        TextNode node = new TextNode(text, "");
        Element wrap = new GroupNode();
        wrap.appendChild(node);
        return wrap;
    }

    /**
     * parse given html source to a single Element
     * 
     * ATTENTION: this method will cause a potential XSS problem, so be sure that you have escaped the passed html string if
     * necessary.
     * 
     * @param html
     *            the html source
     * @return a Element object which contains the dom tree created from passed html source
     */
    public final static Element parseAsSingle(String html) {
        Element body = Jsoup.parseBodyFragment(html).body();
        List children = body.childNodes();
        return wrapElementsToSingleNode(children);
    }

    public final static Element wrapElementsToSingleNode(List elements) {
        Element groupNode = new GroupNode();
        List list = new ArrayList(elements);
        for (Node node : list) {
            node.remove();
            groupNode.appendChild(node);
        }
        return groupNode;
    }

    /**
     * there is a bug in jsoup, so we implement a safe empty by ourselves. https://github.com/jhy/jsoup/issues/239
     * 
     * @param node
     */
    public final static void safeEmpty(Node node) {
        List children = new ArrayList<>(node.childNodes());
        for (Node child : children) {
            child.remove();
        }
    }

    /**
     * there is a bug in jsoup, so we implement a safe empty by ourselves. https://github.com/jhy/jsoup/issues/278
     * 
     * @param node
     */
    public final static Element safeClone(Element elem) {
        Element newElem = elem.clone();
        try {
            resetClassNames(newElem);
        } catch (IllegalAccessException e) {
            throw new RuntimeException(e);
        }
        return newElem;
    }

    private final static Field FieldClassNames;
    static {
        try {
            FieldClassNames = Element.class.getDeclaredField("classNames");
        } catch (Exception ex) {
            throw new RuntimeException(ex);
        }
    }

    private final static void resetClassNames(Element elem) throws IllegalAccessException {
        if (elem == null) {
            return;
        }
        FieldUtils.writeField(FieldClassNames, elem, null, true);

        // elem.classNames(new ProxiedClassNameSet(elem));
        Elements children = elem.children();
        for (Element child : children) {
            resetClassNames(child);
        }
    }

    public final static void appendNodes(Element parent, List children) {
        for (Node node : children) {
            parent.appendChild(node);
        }
    }

    public final static void removeNodesBySelector(Element target, String selector, boolean pullupChildren) {
        Elements removeNodes = target.select(selector);
        Iterator it = removeNodes.iterator();
        Element rm;
        while (it.hasNext()) {
            rm = it.next();
            if (target == rm) {
                continue;
            }
            if (rm.ownerDocument() == null) {
                continue;
            }
            if (pullupChildren) {
                pullupChildren(rm);
            }
            rm.remove();
        }
    }

    public final static void pullupChildren(Element elem) {
        List childrenNodes = new ArrayList<>(elem.childNodes());
        for (Node node : childrenNodes) {
            node.remove();
            elem.before(node);
        }
    }
}