io.knotx.fragments.FragmentContentExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of knotx-core Show documentation

Core Knot.x module consisting of Server, Repositories, Splitter, Assembler and Gateway.

There is a newer version: 1.6.0

/*
 * Copyright (C) 2016 Cognifide Limited
 *
 * 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 io.knotx.fragments;

import io.knotx.dataobjects.Fragment;
import org.apache.commons.lang3.StringUtils;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.jsoup.parser.Parser;

public final class FragmentContentExtractor {

  private FragmentContentExtractor() {
    //util class
  }

  /**
   * Extracts pure markup from the given {@link Fragment}'s content removing a script tag with
   * Knot.x specific data.
   *
   * @param fragment that content will be unwrapped.
   * @return markup without Knotx data processing instructions.
   */
  public static String unwrapContent(Fragment fragment) {
    if (fragment == null) {
      return null;
    }
    
    return fragment.isRaw() ? fragment.content() : extractSnippetContent(fragment.content());
  }

  /**
   * Extracts pure markup from the given markup.
   *
   * @param content markup that contains Knotx processing instructions.
   * @return markup without Knotx data processing instructions in a form of jsoup {@link Element}.
   */
  public static Element unwrapContent(String content) {
    Document result = null;
    if (content != null) {
      final String unwrapped = extractSnippetContent(content);
      result = Jsoup.parse(unwrapped, "UTF-8", Parser.xmlParser());
    }
    return result;
  }

  /**
   * Extracts pure markup from the given {@link Fragment}'s content removing a script tag with
   * Knot.x specific data.
   *
   * @param fragment that content will be unwrapped.
   * @return markup without Knotx data processing instructions in a form of jsoup {@link Element}.
   */
  public static Element unwrapFragmentContent(Fragment fragment) {
    return fragment == null ? null : unwrapContent(fragment.content());
  }

  /**
   * Abbreviate fragment content.
   *
   * @param content to abbreviate
   * @return short fragment content used for logging purposes
   */
  public static String abbreviate(String content) {
    return StringUtils.abbreviate(content.replaceAll("[\n\r\t]", ""),
        FragmentConstants.DEBUG_MAX_FRAGMENT_CONTENT_LOG_LENGTH);
  }

  private static String extractSnippetContent(String content) {
    return content.substring(content.indexOf('>') + 1, content.lastIndexOf('<'));
  }
}