org.opencms.workplace.comparison.A_CmsDiffViewDialog Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.workplace.comparison;
import com.alkacon.diff.Diff;
import org.opencms.jsp.CmsJspActionElement;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsDialog;
import org.opencms.workplace.CmsWorkplace;
import org.opencms.workplace.CmsWorkplaceSettings;
import org.opencms.workplace.list.A_CmsListDialog;
import org.opencms.workplace.tools.A_CmsHtmlIconButton;
import org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.StringReader;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
/**
* Provides a GUI for the configuration file comparison dialog.
*
* @since 6.0.0
*/
public abstract class A_CmsDiffViewDialog extends CmsDialog {
/** Diff mode. */
private CmsDiffViewMode m_mode;
/**
* Default constructor.
*
* @param jsp an initialized JSP action element
*/
protected A_CmsDiffViewDialog(CmsJspActionElement jsp) {
super(jsp);
setParamStyle(STYLE_NEW);
}
/**
* Performs the dialog actions depending on the initialized action and displays the dialog form.
*
* @throws Exception if writing to the JSP out fails
*/
public void displayDialog() throws Exception {
if (getAction() == ACTION_CANCEL) {
actionCloseDialog();
}
JspWriter out = getJsp().getJspContext().getOut();
out.print("");
out.println(dialogContentStart(getParamTitle()));
out.print("
");
// icon is displayed on the right in order that the user needs not scroll to the icon for long lines
out.println("");
out.println(getDiffOnlyButtonsHtml());
out.println("
");
out.println(dialogBlockStart(null));
out.println("\n");
try {
CmsHtmlDifferenceConfiguration conf = new CmsHtmlDifferenceConfiguration(
getMode() == CmsDiffViewMode.ALL ? -1 : getLinesBeforeSkip(),
getLocale());
String diff = Diff.diffAsHtml(getOriginalSource(), getCopySource(), conf);
if (CmsStringUtil.isNotEmpty(diff)) {
out.println(diff);
} else {
// print original source, if there are no differences
out.println(
wrapLinesWithUnchangedStyle(
CmsStringUtil.substitute(CmsStringUtil.escapeHtml(getOriginalSource()), "
", "")));
}
} catch (Exception e) {
out.print(e);
}
out.println("
");
out.println(dialogBlockEnd());
out.println(dialogContentEnd());
out.println(dialogEnd());
out.println(bodyEnd());
out.println(htmlEnd());
}
/**
* Returns the html code for the buttons 'show only differences' and 'show everything'.
*
* @return the html code for the buttons 'show only differences' and 'show everything'
*/
String getDiffOnlyButtonsHtml() {
StringBuffer result = new StringBuffer();
if (!getOriginalSource().equals(getCopySource())) {
String onClick1 = "javascript:document.forms['diff-form'].mode.value = '";
String onClick2 = "javascript:document.forms['diff-form'].mode.value = '";
onClick1 += CmsDiffViewMode.ALL;
onClick2 += CmsDiffViewMode.DIFF_ONLY;
onClick1 += "'; document.forms['diff-form'].submit();";
onClick2 += "'; document.forms['diff-form'].submit();";
result.append(
getTwoButtonsHtml(
CmsDiffViewMode.DIFF_ONLY.getName().key(getLocale()),
CmsDiffViewMode.ALL.getName().key(getLocale()),
onClick1,
onClick2,
getMode() == CmsDiffViewMode.DIFF_ONLY));
} else {
// display all text, if there are no differences
setMode(CmsDiffViewMode.ALL);
}
return result.toString();
}
/**
* Returns the html for two buttons, whereby the third parameter determines which one is active.
*
* @param label1 the label for the first button
* @param label2 the label for the second button
* @param firstActive a flag indicating wheter the first or second button is active
* @param onClick1 the action to be performed if the first button is clicked
* @param onClick2 the action to be performed if the second button is clicked
*
* @return the html for two buttons, whereby the third parameter determines which one is active
*/
public String getTwoButtonsHtml(
String label1,
String label2,
String onClick1,
String onClick2,
boolean firstActive) {
StringBuffer result = new StringBuffer();
if (firstActive) {
result.append(
A_CmsHtmlIconButton.defaultButtonHtml(
CmsHtmlIconButtonStyleEnum.SMALL_ICON_TEXT,
"id",
label1,
null,
true,
A_CmsListDialog.ICON_DETAILS_SHOW,
null,
onClick1));
result.append(" ");
result.append(deactivatedEmphasizedButtonHtml(label2, A_CmsListDialog.ICON_DETAILS_HIDE));
} else {
result.append(deactivatedEmphasizedButtonHtml(label1, A_CmsListDialog.ICON_DETAILS_HIDE));
result.append(" ");
result.append(
A_CmsHtmlIconButton.defaultButtonHtml(
CmsHtmlIconButtonStyleEnum.SMALL_ICON_TEXT,
"id",
label2,
null,
true,
A_CmsListDialog.ICON_DETAILS_SHOW,
null,
onClick2));
}
result.append(" ");
return result.toString();
}
/**
* Returns the html code for a deactivated empfasized button.
*
* @param name the label of the button
* @param iconPath the path to the icon
*
* @return the html code for a deactivated empfasized button
*/
public String deactivatedEmphasizedButtonHtml(String name, String iconPath) {
StringBuffer result = new StringBuffer();
result.append(
"![\'");](\'"); "\'\");")
");
result.append(name);
result.append("");
return result.toString();
}
/**
* Returns the mode.
*
* @return the mode
*/
public CmsDiffViewMode getMode() {
return m_mode;
}
/**
* Returns the parameter value for the Mode.
*
* @return the parameter value for the Mode
*/
public String getParamMode() {
if (m_mode == null) {
return null;
}
return m_mode.getMode();
}
/**
* Sets the mode.
*
* @param mode the mode to set
*/
public void setMode(CmsDiffViewMode mode) {
m_mode = mode;
}
/**
* Sets the parameter value for the Mode.
*
* @param mode the parameter value for the Mode to set
*/
public void setParamMode(String mode) {
m_mode = CmsDiffViewMode.valueOf(mode);
}
/**
* Returns the text to compare as copy.
*
* @return the text to compare as copy
*/
protected abstract String getCopySource();
/**
* Returns the number of lines to show before they are skipped.
*
* @return the number of lines to show before they are skipped
*/
protected abstract int getLinesBeforeSkip();
/**
* Returns the text to compare as original.
*
* @return the text to compare as original
*/
protected abstract String getOriginalSource();
/**
* @see org.opencms.workplace.CmsWorkplace#initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
*/
@Override
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) {
super.initWorkplaceRequestValues(settings, request);
if (CmsStringUtil.isEmptyOrWhitespaceOnly(getParamMode())) {
// ensure a valid mode is set
m_mode = CmsDiffViewMode.DIFF_ONLY;
}
// test the needed parameters
try {
validateParamaters();
} catch (Exception e) {
// close if parameters not available
setAction(ACTION_CANCEL);
try {
actionCloseDialog();
} catch (JspException e1) {
// noop
}
return;
}
}
/**
* Validates the parameters.
*
* @throws Exception if something goes wrong
*/
protected abstract void validateParamaters() throws Exception;
/**
*
* Returns a diff text wrapped with formatting style.
*
* @param diff the text to wrap with CSS formatting
* @return the text with formatting styles wrapped
* @throws IOException if something goes wrong
*/
protected String wrapLinesWithUnchangedStyle(String diff) throws IOException {
String line;
StringBuffer result = new StringBuffer();
BufferedReader br = new BufferedReader(new StringReader(diff));
while ((line = br.readLine()) != null) {
if ("".equals(line.trim())) {
line = " ";
}
result.append("
").append(line).append("\n");
}
return result.toString();
}
}