1 package org
.argeo
.cms
.ui
.workbench
.internal
.jcr
.parts
;
3 import java
.text
.DateFormat
;
4 import java
.text
.SimpleDateFormat
;
5 import java
.util
.ArrayList
;
6 import java
.util
.Calendar
;
10 import javax
.jcr
.Node
;
11 import javax
.jcr
.Property
;
12 import javax
.jcr
.PropertyType
;
13 import javax
.jcr
.RepositoryException
;
14 import javax
.jcr
.Value
;
15 import javax
.jcr
.nodetype
.NodeType
;
16 import javax
.jcr
.version
.Version
;
17 import javax
.jcr
.version
.VersionHistory
;
18 import javax
.jcr
.version
.VersionIterator
;
19 import javax
.jcr
.version
.VersionManager
;
21 import org
.argeo
.cms
.ui
.CmsUiConstants
;
22 import org
.argeo
.cms
.ui
.jcr
.FullVersioningTreeContentProvider
;
23 import org
.argeo
.cms
.ui
.jcr
.JcrDClickListener
;
24 import org
.argeo
.cms
.ui
.jcr
.VersionLabelProvider
;
25 import org
.argeo
.cms
.ui
.workbench
.WorkbenchUiPlugin
;
26 import org
.argeo
.cms
.ui
.workbench
.internal
.WorkbenchConstants
;
27 import org
.argeo
.eclipse
.ui
.EclipseUiException
;
28 import org
.argeo
.jcr
.JcrUtils
;
29 import org
.argeo
.jcr
.PropertyDiff
;
30 import org
.argeo
.jcr
.VersionDiff
;
31 import org
.eclipse
.jface
.viewers
.ITreeContentProvider
;
32 import org
.eclipse
.jface
.viewers
.TreeViewer
;
33 import org
.eclipse
.swt
.SWT
;
34 import org
.eclipse
.swt
.layout
.GridData
;
35 import org
.eclipse
.swt
.layout
.GridLayout
;
36 import org
.eclipse
.swt
.widgets
.Composite
;
37 import org
.eclipse
.swt
.widgets
.Text
;
38 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
39 import org
.eclipse
.ui
.forms
.IManagedForm
;
40 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
41 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
42 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
43 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
44 import org
.eclipse
.ui
.forms
.widgets
.Section
;
45 import org
.eclipse
.ui
.forms
.widgets
.TableWrapData
;
46 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
49 * Offers two main sections : one to display a text area with a summary of all
50 * variations between a version and its predecessor and one tree view that
53 public class NodeVersionHistoryPage
extends FormPage
implements WorkbenchConstants
{
54 // private final static CmsLog log = CmsLog
55 // .getLog(NodeVersionHistoryPage.class);
58 protected DateFormat timeFormatter
= new SimpleDateFormat(CmsUiConstants
.DATE_TIME_FORMAT
);
61 private Node currentNode
;
63 // this page UI components
64 private FullVersioningTreeContentProvider nodeContentProvider
;
65 private TreeViewer nodesViewer
;
66 private FormToolkit tk
;
68 public NodeVersionHistoryPage(FormEditor editor
, String title
, Node currentNode
) {
69 super(editor
, "NodeVersionHistoryPage", title
);
70 this.currentNode
= currentNode
;
73 protected void createFormContent(IManagedForm managedForm
) {
74 ScrolledForm form
= managedForm
.getForm();
75 form
.setText(WorkbenchUiPlugin
.getMessage("nodeVersionHistoryPageTitle"));
76 tk
= managedForm
.getToolkit();
77 Composite innerBox
= form
.getBody();
78 // Composite innerBox = new Composite(body, SWT.NO_FOCUS);
79 GridLayout twt
= new GridLayout(1, false);
80 twt
.marginWidth
= twt
.marginHeight
= 5;
81 innerBox
.setLayout(twt
);
83 if (!currentNode
.isNodeType(NodeType
.MIX_VERSIONABLE
)) {
84 tk
.createLabel(innerBox
, WorkbenchUiPlugin
.getMessage("warningUnversionableNode"));
86 createHistorySection(innerBox
);
87 createTreeSection(innerBox
);
89 } catch (RepositoryException e
) {
90 throw new EclipseUiException("Unable to check if node is versionable", e
);
94 protected void createTreeSection(Composite parent
) {
95 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
96 section
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
97 section
.setText(WorkbenchUiPlugin
.getMessage("versionTreeSectionTitle"));
99 Composite body
= tk
.createComposite(section
, SWT
.FILL
);
100 section
.setClient(body
);
101 section
.setExpanded(true);
102 body
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
103 body
.setLayout(new GridLayout());
105 nodeContentProvider
= new FullVersioningTreeContentProvider();
106 nodesViewer
= createNodeViewer(body
, nodeContentProvider
);
107 nodesViewer
.setInput(currentNode
);
110 protected TreeViewer
createNodeViewer(Composite parent
, final ITreeContentProvider nodeContentProvider
) {
112 final TreeViewer tmpNodeViewer
= new TreeViewer(parent
, SWT
.MULTI
);
114 tmpNodeViewer
.getTree().setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
116 tmpNodeViewer
.setContentProvider(nodeContentProvider
);
117 tmpNodeViewer
.setLabelProvider(new VersionLabelProvider());
118 tmpNodeViewer
.addDoubleClickListener(new JcrDClickListener(tmpNodeViewer
));
119 return tmpNodeViewer
;
122 protected void createHistorySection(Composite parent
) {
125 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
126 section
.setLayoutData(new GridData(TableWrapData
.FILL_GRAB
));
127 TableWrapLayout twt
= new TableWrapLayout();
128 section
.setLayout(twt
);
130 // Set title of the section
131 section
.setText(WorkbenchUiPlugin
.getMessage("versionHistorySectionTitle"));
133 final Text styledText
= tk
.createText(section
, "",
134 SWT
.FULL_SELECTION
| SWT
.BORDER
| SWT
.MULTI
| SWT
.WRAP
| SWT
.V_SCROLL
);
135 section
.setClient(styledText
);
136 styledText
.setLayoutData(new TableWrapData(TableWrapData
.FILL_GRAB
, TableWrapData
.FILL_GRAB
));
137 refreshHistory(styledText
);
138 styledText
.setEditable(false);
139 section
.setExpanded(false);
141 AbstractFormPart part
= new AbstractFormPart() {
142 public void commit(boolean onSave
) {
145 public void refresh() {
147 refreshHistory(styledText
);
150 getManagedForm().addPart(part
);
153 protected void refreshHistory(Text styledText
) {
155 List
<VersionDiff
> lst
= listHistoryDiff();
156 StringBuffer main
= new StringBuffer("");
158 for (int i
= lst
.size() - 1; i
>= 0; i
--) {
160 main
.append("Creation (");
162 main
.append("Update " + i
+ " (");
164 if (lst
.get(i
).getUserId() != null)
165 main
.append("UserId : " + lst
.get(i
).getUserId());
167 if (lst
.get(i
).getUserId() != null && lst
.get(i
).getUpdateTime() != null)
170 if (lst
.get(i
).getUpdateTime() != null)
171 main
.append("Date : " + timeFormatter
.format(lst
.get(i
).getUpdateTime().getTime()) + ")\n");
173 StringBuffer buf
= new StringBuffer("");
174 Map
<String
, PropertyDiff
> diffs
= lst
.get(i
).getDiffs();
175 for (String prop
: diffs
.keySet()) {
176 PropertyDiff pd
= diffs
.get(prop
);
177 // String propName = pd.getRelPath();
178 Value refValue
= pd
.getReferenceValue();
179 Value newValue
= pd
.getNewValue();
180 String refValueStr
= "";
181 String newValueStr
= "";
183 if (refValue
!= null) {
184 if (refValue
.getType() == PropertyType
.DATE
) {
185 refValueStr
= timeFormatter
.format(refValue
.getDate().getTime());
187 refValueStr
= refValue
.getString();
189 if (newValue
!= null) {
190 if (newValue
.getType() == PropertyType
.DATE
) {
191 newValueStr
= timeFormatter
.format(newValue
.getDate().getTime());
193 newValueStr
= newValue
.getString();
196 if (pd
.getType() == PropertyDiff
.MODIFIED
) {
197 buf
.append(prop
).append(": ");
198 buf
.append(refValueStr
);
200 buf
.append(newValueStr
);
202 } else if (pd
.getType() == PropertyDiff
.ADDED
&& !"".equals(newValueStr
)) {
203 // we don't list property that have been added with an
204 // empty string as value
205 buf
.append(prop
).append(": ");
207 buf
.append(newValueStr
);
209 } else if (pd
.getType() == PropertyDiff
.REMOVED
) {
210 buf
.append(prop
).append(": ");
212 buf
.append(refValueStr
);
219 styledText
.setText(main
.toString());
220 } catch (RepositoryException e
) {
221 throw new EclipseUiException("Cannot generate history for node", e
);
225 public List
<VersionDiff
> listHistoryDiff() {
227 List
<VersionDiff
> res
= new ArrayList
<VersionDiff
>();
228 VersionManager versionManager
= currentNode
.getSession().getWorkspace().getVersionManager();
229 VersionHistory versionHistory
= versionManager
.getVersionHistory(currentNode
.getPath());
231 VersionIterator vit
= versionHistory
.getAllLinearVersions();
232 while (vit
.hasNext()) {
233 Version version
= vit
.nextVersion();
234 Node node
= version
.getFrozenNode();
235 Version predecessor
= null;
237 predecessor
= version
.getLinearPredecessor();
238 } catch (Exception e
) {
239 // no predecessor seems to throw an exception even if it
242 if (predecessor
== null) {// original
244 Map
<String
, PropertyDiff
> diffs
= JcrUtils
.diffProperties(predecessor
.getFrozenNode(), node
);
245 if (!diffs
.isEmpty()) {
246 String lastUserName
= null;
247 Calendar lastUpdate
= null;
249 if (currentNode
.isNodeType(NodeType
.MIX_LAST_MODIFIED
)) {
250 lastUserName
= node
.getProperty(Property
.JCR_LAST_MODIFIED_BY
).getString();
251 lastUpdate
= node
.getProperty(Property
.JCR_LAST_MODIFIED
).getDate();
253 lastUpdate
= version
.getProperty(Property
.JCR_CREATED
).getDate();
255 } catch (Exception e
) {
256 // Silent that info is optional
258 VersionDiff vd
= new VersionDiff(lastUserName
, lastUpdate
, diffs
);
264 } catch (RepositoryException e
) {
265 throw new EclipseUiException("Cannot generate history for node ");
271 public void setActive(boolean active
) {
272 super.setActive(active
);