org.lockss.servlet.DisplayContentTab Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
Copyright (c) 2000-2019 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.
*/
package org.lockss.servlet;
import org.apache.commons.lang3.time.FastDateFormat;
import org.lockss.config.TdbAu;
import org.lockss.config.TdbUtil;
import org.lockss.daemon.Crawler;
import org.lockss.daemon.status.ColumnDescriptor;
import org.lockss.daemon.status.StatusService;
import org.lockss.daemon.status.StatusTable;
import org.lockss.plugin.*;
import org.lockss.remote.RemoteApi;
import org.lockss.state.AuState;
import org.lockss.state.SubstanceChecker;
import org.lockss.util.*;
import org.lockss.util.net.IPAddr;
import org.lockss.util.time.Deadline;
import org.lockss.util.time.TimeUtil;
import org.mortbay.html.*;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.text.DecimalFormat;
import java.text.Format;
import java.text.Normalizer;
import java.text.NumberFormat;
import java.util.*;
import java.util.List;
/**
* Display Content Status servlet
*/
public class DisplayContentTab extends LockssServlet {
private static final Logger log = Logger.getLogger();
/**
* Supported output formats
*/
static final int OUTPUT_HTML = 1;
private String tableName;
private String tableKey;
private String sortKey;
private String groupKey;
private String typeKey;
private String filterKey;
private String timeKey;
private StatusService statSvc;
private int outputFmt;
private List rules;
private BitSet tableOptions;
private PluginManager pluginMgr;
private RemoteApi remoteApi;
private String action;
private Character auStart;
private Character auEnd;
private String type;
private ArrayList columnArrayList = new ArrayList() {{
add("");
add("Year");
add("Collected");
add("Last crawl");
add("Last poll");
add("");
}};
private Page page;
private static final String OK_ICON = "images/button_ok.png";
private static final String CANCEL_ICON = "images/button_cancel.png";
private static final String WARN_ICON = "images/button_warn.png";
private static final String CLOCK_ICON = "images/button_clock.png";
private static final String QUESTION_ICON = "images/button_question.png";
private static final String EXTERNAL_LINK_ICON = "images/external_link.png";
private static final String EXPAND_ICON = "images/extend-right.gif";
private static final String COLLAPSE_ICON = "images/expanded.gif";
private static final String PLUS_ICON = "images/control_add.png";
private static final String DELETE_ICON = "images/decline.png";
private static final String GREEN_DOT_ICON = "images/green-dot.png";
private static final String RED_DOT_ICON = "images/red-dot.png";
protected void resetLocals() {
super.resetLocals();
rules = null;
}
public void init(ServletConfig config) throws ServletException {
super.init(config);
statSvc = getLockssDaemon().getStatusService();
pluginMgr = getLockssDaemon().getPluginManager();
remoteApi = getLockssDaemon().getRemoteApi();
}
static final Set fixedParams =
SetUtil.set("text", "output", "options", "table", "key", "sort");
/**
* Handle a request
*
* @throws java.io.IOException
*/
public void lockssHandleRequest() throws IOException {
if (!StringUtil.isNullString(req.getParameter("isDaemonReady"))) {
if (pluginMgr.areAusStarted()) {
resp.setStatus(200);
PrintWriter wrtr = resp.getWriter();
resp.setContentType("text/plain");
wrtr.println("true");
} else {
PrintWriter wrtr = resp.getWriter();
resp.setContentType("text/plain");
wrtr.println("false");
resp.sendError(202, "Not ready");
}
return;
}
if (StringUtil.isNullString(action)) {
try {
getMultiPartRequest();
if (multiReq != null) {
action = multiReq.getString(ACTION_TAG);
}
} catch (FormDataTooLongException e) {
errMsg = "Uploaded file too large: " + e.getMessage();
// leave action null, will call displayAuSummary() below
}
}
outputFmt = OUTPUT_HTML; // default output is html
String outputParam = req.getParameter("output");
if (!StringUtil.isNullString(outputParam)) {
if ("html".equalsIgnoreCase(outputParam)) {
outputFmt = OUTPUT_HTML;
} else {
log.warning("Unknown output format: " + outputParam);
}
}
String optionsParam = req.getParameter("options");
tableOptions = new BitSet();
if (isDebugUser()) {
log.debug2("Debug user. Setting OPTION_DEBUG_USER");
tableOptions.set(StatusTable.OPTION_DEBUG_USER);
}
for (String s : StringUtil.breakAt(optionsParam, ',')) {
if ("norows".equalsIgnoreCase(s)) {
tableOptions.set(StatusTable.OPTION_NO_ROWS);
}
}
tableName = req.getParameter("table");
tableKey = req.getParameter("key");
if (StringUtil.isNullString(tableName)) {
tableName = "AuOverview";
}
if (StringUtil.isNullString(tableKey)) {
tableKey = null;
}
sortKey = req.getParameter("sort");
if (StringUtil.isNullString(sortKey)) {
sortKey = null;
}
groupKey = req.getParameter("group");
if (StringUtil.isNullString(groupKey)) {
groupKey = "publisher";
}
type = req.getParameter("type");
if (StringUtil.isNullString(type)) {
type = "";
}
typeKey = req.getParameter("type");
String auStartString = req.getParameter("start");
if (auStartString == null) {
auStart = 'a';
} else {
auStart = auStartString.charAt(0);
}
String auEndString = req.getParameter("end");
if (auEndString == null) {
auEnd = 'a';
} else {
auEnd = auEndString.charAt(0);
}
filterKey = req.getParameter("filter");
if (StringUtil.isNullString(filterKey)) {
filterKey = "";
}
timeKey = req.getParameter("timeKey");
if (StringUtil.isNullString(timeKey)) {
timeKey = "";
}
switch (outputFmt) {
case OUTPUT_HTML:
doHtmlStatusTable();
break;
}
}
public static TreeMap>> getAusByPublisherName() {
return getAusByPublisherName('A', 'Z', "none", "");
}
public static TreeMap>>
getAusByPublisherName(Character start, Character end, String filterType, String filterKey) {
TreeMap>> aus = new TreeMap>>();
TreeMap>> allAus;
if ("none".equals(filterType)) {
allAus = DisplayContentTable.orderAusByPublisherAndTitle(TdbUtil.getConfiguredAus(), filterKey);
} else {
allAus = DisplayContentTable.orderAusByPublisherAndTitle(filterAus(TdbUtil.getConfiguredAus(),
filterType), filterKey);
}
for (int i = start; i <= end; i++) {
for (Map.Entry>> stringTreeSetEntry : allAus.entrySet()) {
Map.Entry>> pairs = (Map.Entry) stringTreeSetEntry;
String publisherName = pairs.getKey().toLowerCase();
String startLetter = Character.toString((char) i);
if (publisherName.startsWith(startLetter.toLowerCase())) {
aus.put(pairs.getKey(), pairs.getValue());
}
}
}
return aus;
}
public static TreeMap>> getAusByPluginName() {
return getAusByPluginName('A', 'Z', "none", "");
}
public static TreeMap>>
getAusByPluginName(Character start, Character end, String filterType, String filterKey) {
TreeMap>> aus = new TreeMap>>();
TreeMap>> allAus;
if ("none".equals(filterType)) {
allAus = DisplayContentTable.orderAusByPluginAndTitle(TdbUtil.getConfiguredAus(), filterKey);
} else {
allAus = DisplayContentTable.orderAusByPluginAndTitle(filterAus(TdbUtil.getConfiguredAus(),
filterType), filterKey);
}
for (int i = start; i < end; i++) {
for (Map.Entry>> stringTreeSetEntry : allAus.entrySet()) {
Map.Entry>> pairs = (Map.Entry) stringTreeSetEntry;
String pluginName = pairs.getKey().toLowerCase();
String startLetter = Character.toString((char) i);
if (pluginName.startsWith(startLetter.toLowerCase())) {
aus.put(pairs.getKey(), pairs.getValue());
}
}
}
return aus;
}
private static Collection filterAus(Collection aus, String filterType) {
Collection filteredAus;
if ("books".equals(filterType)) {
filteredAus = TdbUtil.filterAusByType(aus, TdbUtil.ContentType.BOOKS);
} else if ("journals".equals(filterType)) {
filteredAus = TdbUtil.filterAusByType(aus, TdbUtil.ContentType.JOURNALS);
} else {
filteredAus = TdbUtil.filterAusByType(aus, TdbUtil.ContentType.ALL);
}
return filteredAus;
}
private void doHtmlStatusTable() throws IOException {
writePage(doHtmlStatusTable0());
}
// Build the table, adding elements to page
private Page doHtmlStatusTable0() throws IOException {
page = new Page();
addJS("js/DisplayContentTab.js");
Table divTable = createTabDiv(auStart);
TreeMap>> aus;
if ("plugin".equals(groupKey)) {
aus = getAusByPluginName(auStart, auEnd, type, filterKey);
} else {
aus = getAusByPublisherName(auStart, auEnd, type, filterKey);
}
for (Map.Entry>> entry : aus.entrySet()) {
createTabContent(divTable, entry.getKey(), entry.getValue());
}
Form tabForm = new Form();
tabForm.attribute("onsubmit", "return confirm('Do you wish to delete the selected items?');");
tabForm.method("GET");
tabForm.add(divTable);
if (aus.size() > 0) {
// Input formAdd = new Input("submit", "addSubmit");
// formAdd.attribute("value", "Add selected");
// formAdd.attribute("id", "add-submit");
// formAdd.attribute("class", "submit-button");
// tabForm.add(formAdd);
Input formDelete = new Input("submit", "deleteSubmit");
formDelete.attribute("value", "Delete selected");
formDelete.attribute("id", "delete-submit");
formDelete.attribute("class", "submit-button");
tabForm.add(formDelete);
}
page.add(tabForm);
return page;
}
/**
* Creates the div for each tab
*
* @param letter Start letter of the tab group
* @return Returns string to add to the page
*/
private Table createTabDiv(Character letter) {
Block tabDiv = new Block(Block.Div, "id='" + letter + "'");
Table divTable = new Table(0, "class='status-table' cellspacing='0'");
tabDiv.add(divTable);
Block tabsDiv = new Block(Block.Div, "id='tabs'");
tabsDiv.add(tabDiv);
return divTable;
}
/**
* Creates the relevant content for each of the tabs
*
* @param divTable The table object to add to
* @param sortName Name of the publisher or plugin
* @param auSet TreeSet of archival units
* @throws java.io.UnsupportedEncodingException
*
*/
private void createTabContent(Table divTable, String sortName,
TreeMap> auSet) throws UnsupportedEncodingException {
if (auSet != null) {
String cleanNameString = cleanName(sortName);
createTitleRow(divTable, sortName, auSet.size());
for (Map.Entry> filteredAu : auSet.entrySet()) {
createAuRow(divTable, filteredAu, cleanNameString);
}
addClearRow(divTable, cleanNameString, false);
}
}
/**
* Builds the title row for each of the publishers or plugins
*
* @param divTable The table object to add to
* @param sortName Name of the publisher or plugin
*/
private void createTitleRow(Table divTable, String sortName, Integer auCount) {
String cleanNameString = cleanName(sortName);
divTable.newRow();
Link headingLink = new Link("javascript:showRows('" + cleanNameString
+ "_class', '" + cleanNameString + "_id', '" + cleanNameString
+ "_AUimage', '" + cleanNameString + "')");
headingLink.attribute("id='" + cleanNameString + "_id'");
headingLink.attribute("class='pub-title'");
Image headingLinkImage = new Image(PLUS_ICON);
headingLinkImage.attribute("id ='" + cleanNameString + "_AUimage'");
headingLinkImage.attribute("class='publisher-icon'");
headingLinkImage.attribute("alt", "Expand Title");
headingLinkImage.attribute("title", "Expand Title");
headingLink.add(headingLinkImage);
StringBuilder titleCountString = new StringBuilder("title");
if (auCount != 1) {
titleCountString.append("s");
}
headingLink.add(HtmlUtil.encode(sortName, HtmlUtil.ENCODE_TEXT) + " (" + auCount + " " +
titleCountString.toString() + ")");
Block boldHeadingLink = new Block(Block.Bold);
boldHeadingLink.add(headingLink);
Block pubDiv = new Block(Block.Div);
Link removePubLink = new Link("DisplayContentStatus?deletePublisher=" + urlEncode(sortName));
removePubLink.attribute("onClick=\"return confirm('Confirm deletion of AUs associated with the publisher " +
HtmlUtil.encode(sortName, HtmlUtil.ENCODE_TEXT) + "');\"");
Image deleteIcon = new Image(DELETE_ICON);
deleteIcon.attribute("class", "publisher-delete");
deleteIcon.attribute("alt", "Delete publisher");
deleteIcon.attribute("title", "Delete publisher");
removePubLink.add(deleteIcon);
pubDiv.add(boldHeadingLink);
Block pubSpan = new Block(Block.Span);
pubSpan.attribute("class='remove-au-button'");
pubSpan.add(removePubLink);
pubDiv.add(pubSpan);
divTable.addHeading(pubDiv, "class='pub-title' colspan='7'");
addClearRow(divTable, cleanNameString, true);
}
private Boolean filterAu(ArchivalUnit au) {
if (StringUtil.isNullString(filterKey)) {
return true;
} else {
AuState auState = AuUtil.getAuState(au);
if ("neverCrawled".equals(filterKey)) {
log.error("Last crawl result: " + auState.getLastCrawlResult());
return auState.getLastCrawlResult() == Crawler.STATUS_QUEUED || auState.getLastCrawlResult() == -1;
} else if ("noSubstance".equals(filterKey)) {
return auState.hasNoSubstance();
} else if ("noPermission".equals(filterKey)) {
return auState.getLastCrawlResult() == Crawler.STATUS_NO_PUB_PERMISSION;
} else if ("serverDown".equals(filterKey)) {
return auState.getLastCrawlResult() == Crawler.STATUS_FETCH_ERROR;
} else {
return true;
}
}
}
/**
* Creates table rows for each AU
*
*
* @param divTable The table object to add to
* @param auMap Archival unit object for this row
* @param cleanNameString Sanitised name used to create classes and divs
* @throws UnsupportedEncodingException
*/
private void createAuRow(Table divTable, Map.Entry> auMap,
String cleanNameString) throws UnsupportedEncodingException {
String title = auMap.getKey();
String cleanTitleString = cleanName(title);
TreeSet auSet = auMap.getValue();
if (auSet.size() > 0) {
ArchivalUnit firstAu = auSet.first();
TdbAu firstTdbAu = TdbUtil.getTdbAu(firstAu);
divTable.newRow();
Block columnRow = divTable.row();
columnRow.attribute("class", cleanNameString + "_class column-row hide-row");
divTable.addCell("", "class=\"checkboxDiv\"");
for (String columnArray : columnArrayList) {
Block columnHeader = new Block(Block.Bold);
columnHeader.add(columnArray);
divTable.addCell(columnHeader, "class=\"column-header\"");
}
divTable.newRow();
Block titleDiv = divTable.row();
titleDiv.attribute("id", cleanName(title) + "_title");
titleDiv.attribute("class", "journal-title " + cleanNameString + "_class hide-row");
Table titleTable = new Table();
titleTable.attribute("class", "title-table");
Input titleCheckbox = new Input(Input.Checkbox, cleanNameString + "_checkbox");
titleCheckbox.attribute("onClick", "titleCheckbox(this, \"" + cleanTitleString + "\")");
Block titleCheckboxDiv = new Block(Block.Div);
titleCheckboxDiv.attribute("class", "checkboxDiv");
titleCheckboxDiv.add(titleCheckbox);
divTable.addCell(titleCheckboxDiv, "class=\"checkboxDiv\"");
addTitleRow(titleTable, "Title:", HtmlUtil.encode(firstTdbAu.getJournalTitle(), HtmlUtil.ENCODE_TEXT));
addTitleRow(titleTable, "Print ISSN:", firstTdbAu.getIssn());
addTitleRow(titleTable, "E-ISSN:", firstTdbAu.getEissn());
divTable.addCell(titleTable, "colspan=\"6\"");
int rowCount = 0;
for (ArchivalUnit au : auSet) {
if (filterAu(au)) {
String rowClass = rowCss(rowCount);
TdbAu tdbAu = TdbUtil.getTdbAu(au);
AuState auState = AuUtil.getAuState(au);
String auName = HtmlUtil.encode(au.getName(), HtmlUtil.ENCODE_TEXT);
String cleanedAuName = cleanAuName(auName);
String encodedHref = URLEncoder.encode(au.getAuId(), "UTF-8");
divTable.newRow();
Block newRow = divTable.row();
newRow.attribute("class", cleanNameString + "_class hide-row "
+ rowClass);
Block auDiv = new Block(Block.Div);
auDiv.attribute("id", cleanedAuName + "_au_title");
auDiv.attribute("class", "au-title");
Link auLink = new Link("DaemonStatus");
if (tdbAu != null) {
auLink.attribute("onClick", "updateDiv('" + cleanedAuName + "', '"
+ au.getAuId() + "', '" + cleanNameString + "-au', '"
+ cleanNameString + tdbAu.getYear() + "_image');return false");
Image auLinkImage = new Image(EXPAND_ICON);
auLinkImage.attribute("id", cleanNameString + tdbAu.getYear() + "_image");
auLinkImage.attribute("class", "title-icon");
auLinkImage.attribute("alt", "Expand Volume");
auLinkImage.attribute("title", "Expand Volume");
auLink.add(auLinkImage);
auLink.add(auName);
auDiv.add(auLink);
Block checkboxDiv = new Block(Block.Div);
checkboxDiv.attribute("class", "checkboxDiv");
Input checkbox = new Input("checkbox", "deleteAu");
checkbox.attribute("value", au.getAuId());
checkbox.attribute("class", "chkbox " + cleanTitleString + "_chkbox");
checkboxDiv.add(checkbox);
divTable.addCell(checkboxDiv, "class='checkboxDiv'");
divTable.addCell(auDiv, "class='au-title-cell'");
divTable.addCell(tdbAu.getYear());
divTable.addCell(checkHasContent(auState.getSubstanceState()));
divTable.addCell(getCrawlImage(auState.getLastCrawlResult(), auState.getLastCrawlResultMsg()) + " " + showTimeElapsed(auState.getLastCrawlTime(), timeKey));
divTable.addCell(showTimeElapsed(auState.getLastPollStart(), timeKey));
} else {
log.debug("TdbAu not found for Au " + au.getName());
auLink.attribute("onClick", "updateDiv('" + cleanedAuName + "', '"
+ au.getAuId() + "', '" + cleanNameString + "-au', '"
+ cleanNameString + rowCount + "_image');return false");
Image auLinkImage = new Image(EXPAND_ICON);
auLinkImage.attribute("id", cleanNameString + rowCount + "_image");
auLinkImage.attribute("class", "title-icon");
auLinkImage.attribute("alt", "Expand Volume");
auLinkImage.attribute("title", "Expand Volume");
auLink.add(auLinkImage);
auLink.add(auName);
auDiv.add(auLink);
divTable.addCell(auDiv);
divTable.addCell(au.getName());
divTable.addCell("unknown");
divTable.addCell("unknown");
divTable.addCell(checkCollected(au, auState.getLastCrawlTime()));
}
Block serveContentDiv = new Block(Block.Div);
serveContentDiv.attribute("class", "au-serve-content-div");
Link serveContentLink = new Link("ServeContent?auid=" + encodedHref);
serveContentLink.target("_blank");
Image externalLinkImage = new Image(EXTERNAL_LINK_ICON);
serveContentLink.add("Serve content" + externalLinkImage + "");
serveContentLink.attribute("class", "au-link");
serveContentDiv.add("[ " + serveContentLink + " ]");
divTable.addCell(serveContentDiv);
divTable.newRow("class='hide-row " + rowClass + " " + cleanNameString + "-au' id='" + cleanedAuName + "_row'");
Block detailsDiv = new Block(Block.Div);
detailsDiv.attribute("id", cleanedAuName + "_cell");
detailsDiv.attribute("class", rowClass);
divTable.addCell(detailsDiv, "colspan='7' id='" + cleanedAuName + "'");
}
rowCount++;
}
}
addClearRow(divTable, cleanNameString, true);
}
private void addClearRow(Table table, String titleString, Boolean hidden) {
table.newRow();
StringBuilder classString = new StringBuilder("class=\"clear-row");
if (hidden) {
classString.append(" " + titleString + "_class hide-row");
}
classString.append(" colspan=\"7\"");
table.addCell("", classString.toString());
}
private void addTitleRow(Table table, String key, String value) {
table.newRow();
table.addCell(key);
Block titleBold = new Block(Block.Bold);
titleBold.add(value);
table.addCell(titleBold);
}
public static String showTimeElapsed(Long date, String timeKey) {
String result;
Date current = Calendar.getInstance().getTime();
if ("accurate".equals(timeKey) || (current.getTime() - date) > 86400) {
result = dateString(new Date(date));
} else {
Date dateTime = new Date(date);
Long val = dateTime.getTime();
if (val == 0 || val == -1) {
return "never";
} else {
StringBuilder sb = new StringBuilder();
long diffInSeconds = (current.getTime() - dateTime.getTime()) / 1000;
long sec = (diffInSeconds >= 60 ? diffInSeconds % 60 : diffInSeconds);
long min = (diffInSeconds = (diffInSeconds / 60)) >= 60 ? diffInSeconds % 60 : diffInSeconds;
long hrs = (diffInSeconds = (diffInSeconds / 60)) >= 24 ? diffInSeconds % 24 : diffInSeconds;
long days = (diffInSeconds = (diffInSeconds / 24)) >= 30 ? diffInSeconds % 30 : diffInSeconds;
long months = (diffInSeconds = (diffInSeconds / 30)) >= 12 ? diffInSeconds % 12 : diffInSeconds;
long years = (diffInSeconds = (diffInSeconds / 12));
if (years > 0) {
if (years == 1) {
sb.append("a year");
} else {
sb.append(years + " years");
}
if (years <= 6 && months > 0) {
if (months == 1) {
sb.append(" and a month");
} else {
sb.append(" and " + months + " months");
}
}
} else if (months > 0) {
if (months == 1) {
sb.append("a month");
} else {
sb.append(months + " months");
}
if (months <= 6 && days > 0) {
if (days == 1) {
sb.append(" and a day");
} else {
sb.append(" and " + days + " days");
}
}
} else if (days > 0) {
if (days == 1) {
sb.append("a day");
} else {
sb.append(days + " days");
}
if (days <= 3 && hrs > 0) {
if (hrs == 1) {
sb.append(" and an hour");
} else {
sb.append(" and " + hrs + " hours");
}
}
} else if (hrs > 0) {
if (hrs == 1) {
sb.append("an hour");
} else {
sb.append(hrs + " hours");
}
if (min > 1) {
sb.append(" and " + min + " minutes");
}
} else if (min > 0) {
if (min == 1) {
sb.append("a minute");
} else {
sb.append(min + " minutes");
}
if (sec > 1) {
sb.append(" and " + sec + " seconds");
}
} else {
if (sec <= 1) {
sb.append("about a second");
} else {
sb.append("about " + sec + " seconds");
}
}
sb.append(" ago");
result = sb.toString();
}
}
return result;
}
/**
* Checks if the AU is collected and returns the relevant image
*
* @param au Archival unit
* @return URL of relevant image
*/
public static Image checkCollected(ArchivalUnit au, long lastCrawlTime) {
Image collectedImage;
AuState state = AuUtil.getAuState(au);
int crawlResult = state.getLastCrawlResult();
String lastCrawlString = showTimeElapsed(lastCrawlTime, "");
if (crawlResult == Crawler.STATUS_SUCCESSFUL) {
collectedImage = new Image(OK_ICON);
} else {
collectedImage = new Image(CANCEL_ICON);
}
collectedImage.attribute("title", "Last successful crawl: " + lastCrawlString);
collectedImage.attribute("alt", "Last successful crawl: " + lastCrawlString);
return collectedImage;
}
public static Image checkHasContent(SubstanceChecker.State substanceState) {
Image collectedImage;
if (substanceState == SubstanceChecker.State.No || substanceState == SubstanceChecker.State.Unknown) {
collectedImage = new Image(CANCEL_ICON);
collectedImage.attribute("alt", "AU has no substance");
collectedImage.attribute("title", "AU has no substance");
} else {
collectedImage = new Image(OK_ICON);
collectedImage.attribute("alt", "AU has substance");
collectedImage.attribute("title", "AU has substance");
}
return collectedImage;
}
/**
* Sanitises a string so that it can be used as a div id
*
* @param name
* @return Returns sanitised string
*/
// XXX Should move to utility class, but we have several
// sanitize/clean methods in use in different places so need to
// rationalize them and come up with a meaningful naming scheme.
public static String cleanName(String name) {
return HtmlUtil.encode(Normalizer.normalize(name, Normalizer.Form.NFC)
.replace(" ", "_")
.replace("&", "")
.replace("(", "")
.replace(")", "")
.replace(",", "")
.replace("+", "_"),
HtmlUtil.ENCODE_TEXT);
}
public static String cleanAuName(String auName) {
return auName.replaceAll(" ", "_").replaceAll(",", "");
}
/**
* Provides a CSS class based on the row number
*
* @param rowCount Row number
* @return Returns a CSS class for that row
*/
public static String rowCss(Integer rowCount) {
return (rowCount % 2 == 0) ? "even-row" : "odd-row";
}
// Thread-safe formatters.
// FastDateFormat is thread-safe, NumberFormat & subclasses aren't.
/**
* Format to display date/time in tables
*/
private static final Format tableDf =
FastDateFormat.getInstance("HH:mm:ss MM/dd/yy");
// public static final DateFormat tableDf =
// DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);
static Format getTableDateFormat() {
return tableDf;
}
private static final ThreadLocal agmntFmt =
new ThreadLocal() {
@Override
protected NumberFormat initialValue() {
return new DecimalFormat("0.00");
}
};
static NumberFormat getAgreementFormat() {
return agmntFmt.get();
}
private static final ThreadLocal floatFmt =
new ThreadLocal() {
@Override
protected NumberFormat initialValue() {
return new DecimalFormat("0.0");
}
};
static NumberFormat getFloatFormat() {
return floatFmt.get();
}
private static final ThreadLocal bigIntFmt =
new ThreadLocal() {
@Override
protected NumberFormat initialValue() {
// if (fmt instanceof DecimalFormat) {
// ((DecimalFormat)fmt).setDecimalSeparatorAlwaysShown(true);
// }
return NumberFormat.getInstance();
}
};
static NumberFormat getBigIntFormat() {
return bigIntFmt.get();
}
/* DecimalFormat automatically applies half-even rounding to
* values being formatted under Java < 1.6. This is a workaround. */
private static String doubleToPercent(double d) {
int i = (int) (d * 10000);
double pc = i / 100.0;
return getAgreementFormat().format(pc);
}
// turn a value into a display string
public static String convertDisplayString(Object val, int type) {
if (val == null) {
return "";
}
try {
switch (type) {
case ColumnDescriptor.TYPE_INT:
if (val instanceof Number) {
long lv = ((Number) val).longValue();
if (lv >= 1000000) {
return getBigIntFormat().format(lv);
}
}
// fall thru
case ColumnDescriptor.TYPE_STRING:
default:
return val.toString();
case ColumnDescriptor.TYPE_FLOAT:
return getFloatFormat().format(((Number) val).doubleValue());
case ColumnDescriptor.TYPE_PERCENT:
float fv = ((Number) val).floatValue();
return Integer.toString(Math.round(fv * 100)) + "%";
case ColumnDescriptor.TYPE_AGREEMENT:
float av = ((Number) val).floatValue();
return doubleToPercent(av) + "%";
case ColumnDescriptor.TYPE_DATE:
Date d;
if (val instanceof Number) {
d = new Date(((Number) val).longValue());
} else if (val instanceof Date) {
d = (Date) val;
} else if (val instanceof Deadline) {
d = ((Deadline) val).getExpiration();
} else {
return val.toString();
}
return dateString(d);
case ColumnDescriptor.TYPE_IP_ADDRESS:
return ((IPAddr) val).getHostAddress();
case ColumnDescriptor.TYPE_TIME_INTERVAL:
long millis = ((Number) val).longValue();
return TimeUtil.timeIntervalToString(millis);
}
} catch (NumberFormatException e) {
log.warning("Bad number: " + val.toString(), e);
return val.toString();
} catch (ClassCastException e) {
log.warning("Wrong type value: " + val.toString(), e);
return val.toString();
} catch (Exception e) {
log.warning("Error formatting value: " + val.toString(), e);
return val.toString();
}
}
public static String dateString(Date d) {
long val = d.getTime();
if (val == 0 || val == -1) {
return "never";
} else {
return getTableDateFormat().format(d);
}
}
private static BitSet debugOptions = new BitSet();
static {
debugOptions.set(StatusTable.OPTION_DEBUG_USER);
}
protected boolean isAllTablesTable() {
return StatusService.ALL_TABLES_TABLE.equals(tableName);
}
// make me a link in nav table unless I'm displaying table of all tables
protected boolean linkMeInNav() {
return !isAllTablesTable();
}
private static String getCrawlImage(int crawlResult, String crawlMessage) {
String image;
if ("Unknown code -1".equals(crawlMessage)) {
crawlMessage = "Never crawled";
}
if (crawlResult == Crawler.STATUS_SUCCESSFUL) {
image = "![](" + GREEN_DOT_ICON + " "\" + HtmlUtil.encode(crawlMessage, HtmlUtil.ENCODE_TEXT) + \"")
";
} else {
image = "![](" + RED_DOT_ICON + " "\" + HtmlUtil.encode(crawlMessage, HtmlUtil.ENCODE_TEXT) + \"")
";
}
return image;
}
/**
* Adds javascript to the page based on the URL provided
*
* @param jsLocation URL of javascript file
*/
private void addJS(String jsLocation) {
Script ajaxScript = new Script("");
ajaxScript.attribute("src", jsLocation);
ajaxScript.attribute("type", "text/javascript");
page.addHeader(ajaxScript);
}
}