2 * Copyright (C) 2007-2012 Argeo GmbH
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org
.argeo
.cms
.ui
.workbench
.internal
.jcr
.parts
;
18 import java
.text
.DateFormat
;
19 import java
.text
.SimpleDateFormat
;
20 import java
.util
.ArrayList
;
21 import java
.util
.Calendar
;
22 import java
.util
.List
;
25 import javax
.jcr
.Node
;
26 import javax
.jcr
.Property
;
27 import javax
.jcr
.PropertyType
;
28 import javax
.jcr
.RepositoryException
;
29 import javax
.jcr
.Value
;
30 import javax
.jcr
.nodetype
.NodeType
;
31 import javax
.jcr
.version
.Version
;
32 import javax
.jcr
.version
.VersionHistory
;
33 import javax
.jcr
.version
.VersionIterator
;
34 import javax
.jcr
.version
.VersionManager
;
36 import org
.argeo
.cms
.ui
.CmsConstants
;
37 import org
.argeo
.cms
.ui
.jcr
.FullVersioningTreeContentProvider
;
38 import org
.argeo
.cms
.ui
.jcr
.JcrDClickListener
;
39 import org
.argeo
.cms
.ui
.jcr
.VersionLabelProvider
;
40 import org
.argeo
.cms
.ui
.workbench
.WorkbenchUiPlugin
;
41 import org
.argeo
.cms
.ui
.workbench
.internal
.WorkbenchConstants
;
42 import org
.argeo
.eclipse
.ui
.EclipseUiException
;
43 import org
.argeo
.jcr
.JcrUtils
;
44 import org
.argeo
.jcr
.PropertyDiff
;
45 import org
.argeo
.jcr
.VersionDiff
;
46 import org
.eclipse
.jface
.viewers
.ITreeContentProvider
;
47 import org
.eclipse
.jface
.viewers
.TreeViewer
;
48 import org
.eclipse
.swt
.SWT
;
49 import org
.eclipse
.swt
.layout
.GridData
;
50 import org
.eclipse
.swt
.layout
.GridLayout
;
51 import org
.eclipse
.swt
.widgets
.Composite
;
52 import org
.eclipse
.swt
.widgets
.Text
;
53 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
54 import org
.eclipse
.ui
.forms
.IManagedForm
;
55 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
56 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
57 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
58 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
59 import org
.eclipse
.ui
.forms
.widgets
.Section
;
60 import org
.eclipse
.ui
.forms
.widgets
.TableWrapData
;
61 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
64 * Offers two main sections : one to display a text area with a summary of all
65 * variations between a version and its predecessor and one tree view that
68 public class NodeVersionHistoryPage
extends FormPage
implements WorkbenchConstants
{
69 // private final static Log log = LogFactory
70 // .getLog(NodeVersionHistoryPage.class);
73 protected DateFormat timeFormatter
= new SimpleDateFormat(CmsConstants
.DATE_TIME_FORMAT
);
76 private Node currentNode
;
78 // this page UI components
79 private FullVersioningTreeContentProvider nodeContentProvider
;
80 private TreeViewer nodesViewer
;
81 private FormToolkit tk
;
83 public NodeVersionHistoryPage(FormEditor editor
, String title
, Node currentNode
) {
84 super(editor
, "NodeVersionHistoryPage", title
);
85 this.currentNode
= currentNode
;
88 protected void createFormContent(IManagedForm managedForm
) {
89 ScrolledForm form
= managedForm
.getForm();
90 form
.setText(WorkbenchUiPlugin
.getMessage("nodeVersionHistoryPageTitle"));
91 tk
= managedForm
.getToolkit();
92 Composite innerBox
= form
.getBody();
93 // Composite innerBox = new Composite(body, SWT.NO_FOCUS);
94 GridLayout twt
= new GridLayout(1, false);
95 twt
.marginWidth
= twt
.marginHeight
= 5;
96 innerBox
.setLayout(twt
);
98 if (!currentNode
.isNodeType(NodeType
.MIX_VERSIONABLE
)) {
99 tk
.createLabel(innerBox
, WorkbenchUiPlugin
.getMessage("warningUnversionableNode"));
101 createHistorySection(innerBox
);
102 createTreeSection(innerBox
);
104 } catch (RepositoryException e
) {
105 throw new EclipseUiException("Unable to check if node is versionable", e
);
109 protected void createTreeSection(Composite parent
) {
110 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
111 section
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
112 section
.setText(WorkbenchUiPlugin
.getMessage("versionTreeSectionTitle"));
114 Composite body
= tk
.createComposite(section
, SWT
.FILL
);
115 section
.setClient(body
);
116 section
.setExpanded(true);
117 body
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
118 body
.setLayout(new GridLayout());
120 nodeContentProvider
= new FullVersioningTreeContentProvider();
121 nodesViewer
= createNodeViewer(body
, nodeContentProvider
);
122 nodesViewer
.setInput(currentNode
);
125 protected TreeViewer
createNodeViewer(Composite parent
, final ITreeContentProvider nodeContentProvider
) {
127 final TreeViewer tmpNodeViewer
= new TreeViewer(parent
, SWT
.MULTI
);
129 tmpNodeViewer
.getTree().setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
131 tmpNodeViewer
.setContentProvider(nodeContentProvider
);
132 tmpNodeViewer
.setLabelProvider(new VersionLabelProvider());
133 tmpNodeViewer
.addDoubleClickListener(new JcrDClickListener(tmpNodeViewer
));
134 return tmpNodeViewer
;
137 protected void createHistorySection(Composite parent
) {
140 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
141 section
.setLayoutData(new GridData(TableWrapData
.FILL_GRAB
));
142 TableWrapLayout twt
= new TableWrapLayout();
143 section
.setLayout(twt
);
145 // Set title of the section
146 section
.setText(WorkbenchUiPlugin
.getMessage("versionHistorySectionTitle"));
148 final Text styledText
= tk
.createText(section
, "",
149 SWT
.FULL_SELECTION
| SWT
.BORDER
| SWT
.MULTI
| SWT
.WRAP
| SWT
.V_SCROLL
);
150 section
.setClient(styledText
);
151 styledText
.setLayoutData(new TableWrapData(TableWrapData
.FILL_GRAB
, TableWrapData
.FILL_GRAB
));
152 refreshHistory(styledText
);
153 styledText
.setEditable(false);
154 section
.setExpanded(false);
156 AbstractFormPart part
= new AbstractFormPart() {
157 public void commit(boolean onSave
) {
160 public void refresh() {
162 refreshHistory(styledText
);
165 getManagedForm().addPart(part
);
168 protected void refreshHistory(Text styledText
) {
170 List
<VersionDiff
> lst
= listHistoryDiff();
171 StringBuffer main
= new StringBuffer("");
173 for (int i
= lst
.size() - 1; i
>= 0; i
--) {
175 main
.append("Creation (");
177 main
.append("Update " + i
+ " (");
179 if (lst
.get(i
).getUserId() != null)
180 main
.append("UserId : " + lst
.get(i
).getUserId());
182 if (lst
.get(i
).getUserId() != null && lst
.get(i
).getUpdateTime() != null)
185 if (lst
.get(i
).getUpdateTime() != null)
186 main
.append("Date : " + timeFormatter
.format(lst
.get(i
).getUpdateTime().getTime()) + ")\n");
188 StringBuffer buf
= new StringBuffer("");
189 Map
<String
, PropertyDiff
> diffs
= lst
.get(i
).getDiffs();
190 for (String prop
: diffs
.keySet()) {
191 PropertyDiff pd
= diffs
.get(prop
);
192 // String propName = pd.getRelPath();
193 Value refValue
= pd
.getReferenceValue();
194 Value newValue
= pd
.getNewValue();
195 String refValueStr
= "";
196 String newValueStr
= "";
198 if (refValue
!= null) {
199 if (refValue
.getType() == PropertyType
.DATE
) {
200 refValueStr
= timeFormatter
.format(refValue
.getDate().getTime());
202 refValueStr
= refValue
.getString();
204 if (newValue
!= null) {
205 if (newValue
.getType() == PropertyType
.DATE
) {
206 newValueStr
= timeFormatter
.format(newValue
.getDate().getTime());
208 newValueStr
= newValue
.getString();
211 if (pd
.getType() == PropertyDiff
.MODIFIED
) {
212 buf
.append(prop
).append(": ");
213 buf
.append(refValueStr
);
215 buf
.append(newValueStr
);
217 } else if (pd
.getType() == PropertyDiff
.ADDED
&& !"".equals(newValueStr
)) {
218 // we don't list property that have been added with an
219 // empty string as value
220 buf
.append(prop
).append(": ");
222 buf
.append(newValueStr
);
224 } else if (pd
.getType() == PropertyDiff
.REMOVED
) {
225 buf
.append(prop
).append(": ");
227 buf
.append(refValueStr
);
234 styledText
.setText(main
.toString());
235 } catch (RepositoryException e
) {
236 throw new EclipseUiException("Cannot generate history for node", e
);
240 public List
<VersionDiff
> listHistoryDiff() {
242 List
<VersionDiff
> res
= new ArrayList
<VersionDiff
>();
243 VersionManager versionManager
= currentNode
.getSession().getWorkspace().getVersionManager();
244 VersionHistory versionHistory
= versionManager
.getVersionHistory(currentNode
.getPath());
246 VersionIterator vit
= versionHistory
.getAllLinearVersions();
247 while (vit
.hasNext()) {
248 Version version
= vit
.nextVersion();
249 Node node
= version
.getFrozenNode();
250 Version predecessor
= null;
252 predecessor
= version
.getLinearPredecessor();
253 } catch (Exception e
) {
254 // no predecessor seems to throw an exception even if it
257 if (predecessor
== null) {// original
259 Map
<String
, PropertyDiff
> diffs
= JcrUtils
.diffProperties(predecessor
.getFrozenNode(), node
);
260 if (!diffs
.isEmpty()) {
261 String lastUserName
= null;
262 Calendar lastUpdate
= null;
264 if (currentNode
.isNodeType(NodeType
.MIX_LAST_MODIFIED
)) {
265 lastUserName
= node
.getProperty(Property
.JCR_LAST_MODIFIED_BY
).getString();
266 lastUpdate
= node
.getProperty(Property
.JCR_LAST_MODIFIED
).getDate();
268 lastUpdate
= version
.getProperty(Property
.JCR_CREATED
).getDate();
270 } catch (Exception e
) {
271 // Silent that info is optional
273 VersionDiff vd
= new VersionDiff(lastUserName
, lastUpdate
, diffs
);
279 } catch (RepositoryException e
) {
280 throw new EclipseUiException("Cannot generate history for node ");
286 public void setActive(boolean active
) {
287 super.setActive(active
);