fitnesse.responders.NameWikiPageResponder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fitnesse Show documentation

The fully integrated standalone wiki, and acceptance testing framework.

There is a newer version: 20240707

// Copyright (C) 2003-2009 by Object Mentor, Inc. All rights reserved.
// Released under the terms of the CPL Common Public License version 1.0.
package fitnesse.responders;

import fitnesse.FitNesseContext;
import fitnesse.authentication.SecureOperation;
import fitnesse.authentication.SecureReadOperation;
import fitnesse.http.Request;
import fitnesse.wiki.PageData;
import fitnesse.wiki.WikiPage;
import org.apache.commons.lang3.StringUtils;
import org.json.JSONArray;

import java.util.*;

public class NameWikiPageResponder extends BasicResponder {
  @Override
  protected String contentFrom(FitNesseContext context, Request request, WikiPage requestedPage) {
    List lines = addLines(request, requestedPage, "");

    String format = request.getInput("format");
    if ("json".equalsIgnoreCase(format)) {
      JSONArray jsonPages = new JSONArray(lines);
      return jsonPages.toString();
    }
    return StringUtils.join(lines, System.getProperty("line.separator"));
  }

  private List addLines(Request request, WikiPage requestedPage, String prefix) {
    List lines = new ArrayList<>();

    for (WikiPage child : requestedPage.getChildren()) {
	  if(!request.hasInput("LeafOnly") || child.getChildren().isEmpty()) {
        lines.add(makeLine(request, child, prefix));
      }

	  if (request.hasInput("Recursive")) {
	    lines.addAll(addLines(request, child, prefix + child.getName() + "."));
	  }
    }

    return lines;
  }

  private String makeLine(Request request, WikiPage child, String prefix) {
    int numberOfChildren = child.getChildren().size();

    StringBuilder line = new StringBuilder(64)
            .append(prefix)
            .append(child.getName());

    if (request.hasInput("ShowChildCount")) {
      line.append(" ").append(numberOfChildren);
    }

    if (request.hasInput("ShowTags")) {
	  Set tags = getTags(child);
	  if(!tags.isEmpty()) {
	    line.append(" ");
		for(String tag : tags) {
          line.append("[").append(tag).append("]");
		}
      }
	}

    return line.toString();
  }

  private Set getTags(WikiPage page) {
    Set result = new TreeSet<>();

	// get the tags of the given page
    String tags = page.getData().getAttribute(PageData.PropertySUITES);
    if((tags != null) && !tags.isEmpty()) {
	  result.addAll(Arrays.asList(tags.split(", ")));
    }

	// recusrively collect all tags up to the root
	if(!page.isRoot()) {
	  result.addAll(getTags(page.getParent()));
	}

	return result;
  }

  @Override
  protected String getContentType() {
    return "text/plain";
  }

  @Override
  public SecureOperation getSecureOperation() {
    return new SecureReadOperation();
  }
}