2 * Copyright (C) 2007-2012 Mathieu Baudier
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
.jcr
.ui
.explorer
.editors
;
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
.ArgeoException
;
37 import org
.argeo
.jcr
.JcrUtils
;
38 import org
.argeo
.jcr
.PropertyDiff
;
39 import org
.argeo
.jcr
.VersionDiff
;
40 import org
.argeo
.jcr
.ui
.explorer
.JcrExplorerConstants
;
41 import org
.argeo
.jcr
.ui
.explorer
.JcrExplorerPlugin
;
42 import org
.argeo
.jcr
.ui
.explorer
.providers
.FullVersioningTreeContentProvider
;
43 import org
.argeo
.jcr
.ui
.explorer
.providers
.VersionLabelProvider
;
44 import org
.argeo
.jcr
.ui
.explorer
.utils
.GenericNodeDoubleClickListener
;
45 import org
.eclipse
.jface
.viewers
.ITreeContentProvider
;
46 import org
.eclipse
.jface
.viewers
.TreeViewer
;
47 import org
.eclipse
.swt
.SWT
;
48 import org
.eclipse
.swt
.layout
.GridData
;
49 import org
.eclipse
.swt
.layout
.GridLayout
;
50 import org
.eclipse
.swt
.widgets
.Composite
;
51 import org
.eclipse
.swt
.widgets
.Text
;
52 import org
.eclipse
.ui
.forms
.AbstractFormPart
;
53 import org
.eclipse
.ui
.forms
.IManagedForm
;
54 import org
.eclipse
.ui
.forms
.editor
.FormEditor
;
55 import org
.eclipse
.ui
.forms
.editor
.FormPage
;
56 import org
.eclipse
.ui
.forms
.widgets
.FormToolkit
;
57 import org
.eclipse
.ui
.forms
.widgets
.ScrolledForm
;
58 import org
.eclipse
.ui
.forms
.widgets
.Section
;
59 import org
.eclipse
.ui
.forms
.widgets
.TableWrapData
;
60 import org
.eclipse
.ui
.forms
.widgets
.TableWrapLayout
;
63 * Offers two main sections : one to display a text area with a summary of all
64 * variations between a version and its predecessor and one tree view that
67 public class NodeVersionHistoryPage
extends FormPage
implements
68 JcrExplorerConstants
{
69 // private final static Log log = LogFactory
70 // .getLog(NodeVersionHistoryPage.class);
73 protected DateFormat timeFormatter
= new SimpleDateFormat(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
,
85 super(editor
, "NodeVersionHistoryPage", title
);
86 this.currentNode
= currentNode
;
89 protected void createFormContent(IManagedForm managedForm
) {
90 ScrolledForm form
= managedForm
.getForm();
91 form
.setText(JcrExplorerPlugin
92 .getMessage("nodeVersionHistoryPageTitle"));
93 tk
= managedForm
.getToolkit();
94 GridLayout twt
= new GridLayout(1, false);
95 twt
.marginWidth
= twt
.marginHeight
= 5;
96 Composite body
= form
.getBody();
100 if (!currentNode
.isNodeType(NodeType
.MIX_VERSIONABLE
)) {
101 tk
.createLabel(body
, JcrExplorerPlugin
102 .getMessage("warningUnversionableNode"));
104 createHistorySection(form
.getBody());
105 createTreeSection(form
.getBody());
107 } catch (RepositoryException e
) {
108 throw new ArgeoException(
109 "Unexpected error while checking if node is versionable", e
);
113 protected void createTreeSection(Composite parent
) {
114 // Section Layout & MetaData
115 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
116 section
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
117 section
.setText(JcrExplorerPlugin
.getMessage("versionTreeSectionTitle"));
120 Composite body
= tk
.createComposite(section
, SWT
.FILL
);
121 // WARNING : 2 following lines are compulsory or body won't be
123 body
.setLayout(new GridLayout());
124 section
.setClient(body
);
126 body
.setLayoutData(new GridData(GridData
.FILL_BOTH
));
127 section
.setExpanded(true);
129 nodeContentProvider
= new FullVersioningTreeContentProvider();
130 nodesViewer
= createNodeViewer(body
, nodeContentProvider
);
131 nodesViewer
.setInput(currentNode
);
134 protected TreeViewer
createNodeViewer(Composite parent
,
135 final ITreeContentProvider nodeContentProvider
) {
137 final TreeViewer tmpNodeViewer
= new TreeViewer(parent
, SWT
.MULTI
);
139 tmpNodeViewer
.getTree().setLayoutData(
140 new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
142 tmpNodeViewer
.setContentProvider(nodeContentProvider
);
143 tmpNodeViewer
.setLabelProvider(new VersionLabelProvider());
145 .addDoubleClickListener(new GenericNodeDoubleClickListener(
147 return tmpNodeViewer
;
150 protected void createHistorySection(Composite parent
) {
153 Section section
= tk
.createSection(parent
, Section
.TWISTIE
);
154 section
.setLayoutData(new GridData(TableWrapData
.FILL_GRAB
));
155 TableWrapLayout twt
= new TableWrapLayout();
156 section
.setLayout(twt
);
158 // Set title of the section
159 section
.setText(JcrExplorerPlugin
160 .getMessage("versionHistorySectionTitle"));
162 final Text styledText
= tk
.createText(section
, "", SWT
.FULL_SELECTION
163 | SWT
.BORDER
| SWT
.MULTI
| SWT
.WRAP
| SWT
.V_SCROLL
);
164 styledText
.setLayoutData(new GridData(SWT
.FILL
, SWT
.FILL
, true, true));
165 section
.setClient(styledText
);
166 refreshHistory(styledText
);
167 styledText
.setEditable(false);
168 section
.setExpanded(false);
170 AbstractFormPart part
= new AbstractFormPart() {
171 public void commit(boolean onSave
) {
174 public void refresh() {
176 refreshHistory(styledText
);
179 getManagedForm().addPart(part
);
182 protected void refreshHistory(Text styledText
) {
184 List
<VersionDiff
> lst
= listHistoryDiff();
185 StringBuffer main
= new StringBuffer("");
187 for (int i
= lst
.size() - 1; i
>= 0; i
--) {
189 main
.append("Creation (");
191 main
.append("Update " + i
+ " (");
193 if (lst
.get(i
).getUserId() != null)
194 main
.append("UserId : " + lst
.get(i
).getUserId());
196 if (lst
.get(i
).getUserId() != null
197 && lst
.get(i
).getUpdateTime() != null)
200 if (lst
.get(i
).getUpdateTime() != null)
201 main
.append("Date : "
202 + timeFormatter
.format(lst
.get(i
).getUpdateTime()
203 .getTime()) + ")\n");
205 StringBuffer buf
= new StringBuffer("");
206 Map
<String
, PropertyDiff
> diffs
= lst
.get(i
).getDiffs();
207 for (String prop
: diffs
.keySet()) {
208 PropertyDiff pd
= diffs
.get(prop
);
209 // String propName = pd.getRelPath();
210 Value refValue
= pd
.getReferenceValue();
211 Value newValue
= pd
.getNewValue();
212 String refValueStr
= "";
213 String newValueStr
= "";
215 if (refValue
!= null) {
216 if (refValue
.getType() == PropertyType
.DATE
) {
217 refValueStr
= timeFormatter
.format(refValue
218 .getDate().getTime());
220 refValueStr
= refValue
.getString();
222 if (newValue
!= null) {
223 if (newValue
.getType() == PropertyType
.DATE
) {
224 newValueStr
= timeFormatter
.format(newValue
225 .getDate().getTime());
227 newValueStr
= newValue
.getString();
230 if (pd
.getType() == PropertyDiff
.MODIFIED
) {
231 buf
.append(prop
).append(": ");
232 buf
.append(refValueStr
);
234 buf
.append(newValueStr
);
236 } else if (pd
.getType() == PropertyDiff
.ADDED
237 && !"".equals(newValueStr
)) {
238 // we don't list property that have been added with an
239 // empty string as value
240 buf
.append(prop
).append(": ");
242 buf
.append(newValueStr
);
244 } else if (pd
.getType() == PropertyDiff
.REMOVED
) {
245 buf
.append(prop
).append(": ");
247 buf
.append(refValueStr
);
254 styledText
.setText(main
.toString());
255 } catch (RepositoryException e
) {
256 throw new ArgeoException("Cannot generate history for node", e
);
261 public List
<VersionDiff
> listHistoryDiff() {
263 List
<VersionDiff
> res
= new ArrayList
<VersionDiff
>();
264 VersionManager versionManager
= currentNode
.getSession()
265 .getWorkspace().getVersionManager();
266 VersionHistory versionHistory
= versionManager
267 .getVersionHistory(currentNode
.getPath());
269 VersionIterator vit
= versionHistory
.getAllLinearVersions();
270 while (vit
.hasNext()) {
271 Version version
= vit
.nextVersion();
272 Node node
= version
.getFrozenNode();
273 Version predecessor
= null;
275 predecessor
= version
.getLinearPredecessor();
276 } catch (Exception e
) {
277 // no predecessor seems to throw an exception even if it
280 if (predecessor
== null) {// original
282 Map
<String
, PropertyDiff
> diffs
= JcrUtils
.diffProperties(
283 predecessor
.getFrozenNode(), node
);
284 if (!diffs
.isEmpty()) {
285 String lastUserName
= null;
286 Calendar lastUpdate
= null;
289 .isNodeType(NodeType
.MIX_LAST_MODIFIED
)) {
290 lastUserName
= node
.getProperty(
291 Property
.JCR_LAST_MODIFIED_BY
)
293 lastUpdate
= node
.getProperty(
294 Property
.JCR_LAST_MODIFIED
).getDate();
296 lastUpdate
= version
.getProperty(
297 Property
.JCR_CREATED
).getDate();
299 } catch (Exception e
) {
300 // Silent that info is optional
302 VersionDiff vd
= new VersionDiff(lastUserName
,
309 } catch (RepositoryException e
) {
310 throw new ArgeoException("Cannot generate history for node ");
316 public void setActive(boolean active
) {
317 super.setActive(active
);