/*******************************************************************************
* Copyright (c) 2004, 2007 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.ats.artifact;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.osee.ats.artifact.TeamWorkFlowArtifact.DefaultTeamState;
import org.eclipse.osee.ats.internal.AtsPlugin;
import org.eclipse.osee.framework.core.exception.MultipleAttributesExist;
import org.eclipse.osee.framework.core.exception.OseeArgumentException;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.exception.OseeStateException;
import org.eclipse.osee.framework.jdk.core.util.AHTML;
import org.eclipse.osee.framework.jdk.core.util.AXml;
import org.eclipse.osee.framework.jdk.core.util.Strings;
import org.eclipse.osee.framework.jdk.core.util.xml.Jaxp;
import org.eclipse.osee.framework.logging.OseeLevel;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.skynet.core.User;
import org.eclipse.osee.framework.skynet.core.UserManager;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.ui.skynet.widgets.XDate;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* @author Donald G. Dunne
*/
public class ATSLog {
private final WeakReference<Artifact> artifactRef;
private boolean enabled = true;
private static String ATS_LOG_TAG = "AtsLog";
private static String LOG_ITEM_TAG = "Item";
private LogItem cancelledLogItem;
private LogItem completedLogItem;
public static enum LogType {
None, Originated, StateComplete, StateCancelled, StateEntered, Released, Error, Assign, Note, Metrics;
public static LogType getType(String type) throws OseeArgumentException {
for (Enum<LogType> e : LogType.values()) {
if (e.name().equals(type)) {
return (LogType) e;
}
}
throw new OseeArgumentException("Unhandled LogType: \"" + type + "\"");
}
};
public ATSLog(Artifact artifact) {
this.artifactRef = new WeakReference<Artifact>(artifact);
}
@Override
public String toString() {
try {
return getLogItems().toString();
} catch (Exception ex) {
OseeLog.log(AtsPlugin.class, Level.SEVERE, ex);
return ex.getLocalizedMessage();
}
}
public String getHtml() throws OseeCoreException {
return getHtml(true);
}
public String getHtml(boolean showLog) throws OseeCoreException {
if (getLogItems().size() == 0) {
return "";
}
StringBuffer sb = new StringBuffer();
if (showLog) {
sb.append(AHTML.addSpace(1) + AHTML.getLabelStr(
AHTML.LABEL_FONT,
"History for \"" + getArtifact().getArtifactTypeName() + "\" - " + getArtifact().getHumanReadableId() + " - titled \"" + getArtifact().getName() + "\""));
}
sb.append(getTable());
return sb.toString();
}
public Artifact getArtifact() throws OseeStateException {
if (artifactRef.get() == null) {
throw new OseeStateException("Artifact has been garbage collected");
}
return artifactRef.get();
}
private static Pattern LOG_ITEM_PATTERN =
Pattern.compile("<Item date=\"(.*?)\" msg=\"(.*?)\" state=\"(.*?)\" type=\"(.*?)\" userId=\"(.*?)\"/>");
private static Pattern LOG_ITEM_TAG_PATTERN = Pattern.compile("<Item ");
public List<LogItem> getLogItems() throws OseeCoreException {
// System.out.println("getLogItems " + artifact.getHumanReadableId());
List<LogItem> logItems = new ArrayList<LogItem>();
String xml = getArtifact().getSoleAttributeValue(ATSAttributes.LOG_ATTRIBUTE.getStoreName(), "");
if (!xml.equals("")) {
Matcher m = LOG_ITEM_PATTERN.matcher(xml);
while (m.find()) {
LogItem item =
new LogItem(m.group(4), m.group(1), Strings.intern(m.group(5)), Strings.intern(m.group(3)),
AXml.xmlToText(m.group(2)), getArtifact().getHumanReadableId());
logItems.add(item);
}
Matcher m2 = LOG_ITEM_TAG_PATTERN.matcher(xml);
int openTagsFound = 0;
while (m2.find()) {
openTagsFound++;
}
if (logItems.size() != openTagsFound) {
OseeLog.log(AtsPlugin.class, Level.SEVERE, String.format(
"ATS Log: open tags found %d doesn't match log items parsed %d for %s", openTagsFound,
logItems.size(), getArtifact().getHumanReadableId()));
}
}
return logItems;
}
public Date getLastStatusedDate() throws OseeCoreException {
LogItem logItem = getLastEvent(LogType.Metrics);
if (logItem == null) {
return null;
}
return logItem.getDate();
}
public void putLogItems(List<LogItem> items) {
try {
Document doc = Jaxp.newDocument();
Element rootElement = doc.createElement(ATS_LOG_TAG);
doc.appendChild(rootElement);
for (LogItem item : items) {
Element element = doc.createElement(LOG_ITEM_TAG);
element.setAttribute("type", item.getType().name());
element.setAttribute("date", item.getDate().getTime() + "");
element.setAttribute("userId", item.getUser().getUserId());
element.setAttribute("state", item.getState());
element.setAttribute("msg", item.getMsg());
rootElement.appendChild(element);
}
getArtifact().setSoleAttributeValue(ATSAttributes.LOG_ATTRIBUTE.getStoreName(), Jaxp.getDocumentXml(doc));
} catch (Exception ex) {
OseeLog.log(AtsPlugin.class, OseeLevel.SEVERE_POPUP, "Can't create ats log document", ex);
}
}
public List<LogItem> getLogItemsReversed() throws OseeCoreException {
List<LogItem> logItems = getLogItems();
Collections.reverse(logItems);
return logItems;
}
public void setOriginator(User user) throws OseeCoreException {
List<LogItem> logItems = getLogItems();
for (LogItem item : logItems) {
if (item.getType() == LogType.Originated) {
item.setUser(user);
putLogItems(logItems);
return;
}
}
}
/**
* Since originator can be changed, return the date of the first originated log item
*/
public Date getCreationDate() throws OseeCoreException {
LogItem logItem = getEvent(LogType.Originated);
if (logItem == null) {
return null;
}
return logItem.getDate();
}
/**
* Since originator change be changed, return the last originated event's user
*/
public User getOriginator() throws OseeCoreException {
LogItem logItem = getLastEvent(LogType.Originated);
if (logItem == null) {
return null;
}
return logItem.getUser();
}
/**
* Overwrite the first logItem to match type and state with newItem data
*/
public void overrideStateItemData(LogType matchType, String matchState, LogItem newItem) throws OseeCoreException {
List<LogItem> logItems = getLogItems();
for (LogItem item : logItems) {
if (item.getType() == matchType && item.getState().equals(matchState)) {
item.setUser(newItem.getUser());
item.setDate(newItem.getDate());
item.setMsg(newItem.getMsg());
putLogItems(logItems);
return;
}
}
}
/**
* Overwrite the first logItem to match matchType with newItem data
*/
public void overrideItemData(LogType matchType, LogItem newItem) throws OseeCoreException {
List<LogItem> logItems = getLogItems();
for (LogItem item : logItems) {
if (item.getType() == matchType) {
item.setState(newItem.getState());
item.setUser(newItem.getUser());
item.setDate(newItem.getDate());
item.setMsg(newItem.getMsg());
putLogItems(logItems);
return;
}
}
}
/**
* @param state name of state or null
* @throws OseeArgumentException
* @throws MultipleAttributesExist
*/
public void addLog(LogType type, String state, String msg) throws OseeCoreException {
addLog(type, state, msg, new Date(), UserManager.getUser());
}
/**
* @param state name of state or null
* @throws MultipleAttributesExist
*/
public void addLog(LogType type, String state, String msg, User user) throws OseeCoreException {
addLog(type, state, msg, new Date(), user);
}
public void addLogItem(LogItem item) throws OseeCoreException {
addLog(item.getType(), item.getState(), item.getMsg(), item.getDate(), item.getUser());
}
/**
* @param state name of state or null
* @throws MultipleAttributesExist
*/
public void addLog(LogType type, String state, String msg, Date date, User user) throws OseeCoreException {
if (!enabled) {
return;
}
LogItem logItem = new LogItem(type, date, user, state, msg, artifactRef.get().getHumanReadableId());
List<LogItem> logItems = getLogItems();
logItems.add(logItem);
putLogItems(logItems);
}
public void clearLog() {
putLogItems(new ArrayList<LogItem>());
}
public String getTable() throws OseeCoreException {
StringBuilder builder = new StringBuilder();
List<LogItem> logItems = getLogItems();
builder.append("<TABLE BORDER=\"1\" cellspacing=\"1\" cellpadding=\"3%\" width=\"100%\"><THEAD><TR><TH>Event</TH>" + "<TH>State</TH><TH>Message</TH><TH>User</TH><TH>Date</TH></THEAD></TR>");
for (LogItem item : logItems) {
User user = item.getUser();
if (user != null) {
builder.append("<TR>");
builder.append("<TD>" + item.getType() + "</TD>");
builder.append("<TD>" + (item.getState().equals("") ? "." : item.getState()) + "</TD>");
builder.append("<TD>" + (item.getMsg().equals("") ? "." : item.getMsg()) + "</TD>");
if (user.equals(UserManager.getUser())) {
builder.append("<TD bgcolor=\"#CCCCCC\">" + user.getName() + "</TD>");
} else {
builder.append("<TD>" + user.getName() + "</TD>");
}
builder.append("<TD>" + item.getDate(XDate.MMDDYYHHMM) + "</TD>");
builder.append("</TR>");
}
}
builder.append("</TABLE>");
return builder.toString();
}
public boolean isEnabled() {
return enabled;
}
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public LogItem getEvent(LogType type) throws OseeCoreException {
for (LogItem item : getLogItems()) {
if (item.getType() == type) {
return item;
}
}
return null;
}
public LogItem getLastEvent(LogType type) throws OseeCoreException {
for (LogItem item : getLogItemsReversed()) {
if (item.getType() == type) {
return item;
}
}
return null;
}
public LogItem getStateEvent(LogType type, String stateName) throws OseeCoreException {
for (LogItem item : getLogItemsReversed()) {
if (item.getType() == type && item.getState().equals(stateName)) {
return item;
}
}
return null;
}
public LogItem getStateEvent(LogType type) throws OseeCoreException {
for (LogItem item : getLogItemsReversed()) {
if (item.getType() == type) {
return item;
}
}
return null;
}
public LogItem getCancelledLogItem() throws OseeCoreException {
if (cancelledLogItem == null) {
cancelledLogItem = getStateEvent(LogType.StateEntered, DefaultTeamState.Cancelled.name());
}
return cancelledLogItem;
}
public LogItem getCompletedLogItem() throws OseeCoreException {
if (completedLogItem == null) {
completedLogItem = getStateEvent(LogType.StateEntered, DefaultTeamState.Completed.name());
}
return completedLogItem;
}
}
