Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 631f0c64e8fbea12bd543e41bb17a508b45c57d1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
/*******************************************************************************
 * Copyright (c) 2013 protos software gmbh (http://www.protos.de).
 * 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:
 * 		Juergen Haug (initial contribution)
 * 
 *******************************************************************************/

package org.eclipse.etrice.ui.common.base.refactoring;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceProxy;
import org.eclipse.core.resources.IResourceProxyVisitor;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.etrice.ui.common.base.support.DiagramAccessBase;
import org.eclipse.graphiti.mm.pictograms.Diagram;
import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.CompositeChange;
import org.eclipse.ltk.core.refactoring.FileStatusContext;
import org.eclipse.ltk.core.refactoring.NullChange;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext;
import org.eclipse.ltk.core.refactoring.participants.RenameParticipant;
import org.eclipse.ltk.core.refactoring.resource.ResourceChange;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorReference;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.FileEditorInput;

public class DiagramRenameParticipant extends RenameParticipant {

	private URI roomURI;
	private List<IFile> diagramFiles;
	
	private static String[] diagramExtensions;
	private static String[] diagramEditorsIds;
	
	static {
		IConfigurationElement[] elements = Platform.getExtensionRegistry().getConfigurationElementsFor("org.eclipse.etrice.ui.common.base.refactoring.rename");
		diagramExtensions = new String[elements.length];
		diagramEditorsIds = new String[elements.length];
		for(int i=0;i<elements.length;i++){
			diagramExtensions[i] = elements[i].getAttribute("diagram_extension");
			diagramEditorsIds[i] = elements[i].getAttribute("editor_id");
		}
	}
	
	public DiagramRenameParticipant(){
		this.diagramFiles = new ArrayList<IFile>();
	}
	
	@Override
	protected boolean initialize(Object element) {		
		IFile roomFile = (IFile) element;
		IFolder diagramFolder = roomFile.getParent().getFolder(new Path(DiagramAccessBase.DIAGRAMS_FOLDER_NAME));
		
		if(!diagramFolder.exists())
			return false;
		
		// find all diagrams in diagram folder
		final  List<IFile> allDiagrams = new ArrayList<IFile>();
		IResourceProxyVisitor visitor = new IResourceProxyVisitor() {
						
			@Override
			public boolean visit(IResourceProxy proxy) throws CoreException {
				for(String extension : diagramExtensions)
					if(proxy.getName().endsWith(extension))
						allDiagrams.add((IFile) proxy.requestResource());
				
				return true;
			}
		};
		try {
			diagramFolder.accept(visitor, IResource.DEPTH_ONE, IResource.FILE);
		}
		catch (CoreException e) {
			e.printStackTrace();
		}
		
		// select diagrams that point to roomFile
		roomURI = URI.createPlatformResourceURI(roomFile.getFullPath().toString(), false);
		ResourceSet rs = new ResourceSetImpl();
		for(IFile diagramFile : allDiagrams){
			URI diagramURI = URI.createPlatformResourceURI(diagramFile.getFullPath().toString(), false);
			Resource res = rs.getResource(diagramURI, true);
			EObject obj = res.getContents().iterator().next();
			if(obj instanceof Diagram){
				Diagram diagram = (Diagram) obj;
				if(diagram.getLink().getBusinessObjects().isEmpty())
					continue;
				URI boURI = EcoreUtil.getURI(diagram.getLink().getBusinessObjects().iterator().next());
				if(roomURI.equals(boURI.trimFragment()))
					diagramFiles.add(diagramFile);
			}
		}
		
		return !diagramFiles.isEmpty();
	}

	
	@Override
	public String getName() {
		return null;
	}
	
	@Override
	public RefactoringStatus checkConditions(IProgressMonitor pm,
			CheckConditionsContext context) throws OperationCanceledException {
				
		// collect open diagrams
		final RefactoringStatus status = RefactoringStatus.create(Status.OK_STATUS);
		final List<IFile> toIgnore = new ArrayList<IFile>();
		Runnable runnable = new Runnable() {
			
			@Override
			public void run() {
				IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
				for(IFile diagramFile : diagramFiles)
					if(isDiagramEditorOpen(diagramFile, page))
						toIgnore.add(diagramFile);
			}
		};
		Display.getDefault().syncExec(runnable);
		
		/* Issues:
		 * - after renaming open diagram causes exception and bad update (graphiti bug ?)
		 * - saving diagram here can cause deadlock somehow
		 */
		
		// print warning and ignore
		for(IFile diagramFile : toIgnore){
			diagramFiles.remove(diagramFile);
			status.addWarning("Cannot update open diagram " + diagramFile.getName(), new FileStatusContext(diagramFile, null));
		}
		
		return status;
	}	
	
	@Override
	public Change createChange(IProgressMonitor pm) throws CoreException,
			OperationCanceledException {
		
		if(diagramFiles.isEmpty())
			return new NullChange();
		
		URI oldURI = roomURI;
		String newFileName = getArguments().getNewName();
		URI newURI = oldURI.trimSegments(1).appendSegment(newFileName);
		
		ResourceSet rs = new ResourceSetImpl();
		rs.getResource(oldURI, true);
		CompositeChange compositeChange = new DiagramCompositeChange(oldURI, newURI, rs);
		
		for(IFile diagramFile : diagramFiles){
			URI diagramURI = URI.createPlatformResourceURI(diagramFile.getFullPath().toString(), false);
			Resource diagramRes = rs.getResource(diagramURI, true);
			compositeChange.add(new DiagramUpdateChange(diagramRes));
		}
		
		return compositeChange;
		
	}
	
	/**
	 *  has to be executed in ui thread
	 */
	private boolean isDiagramEditorOpen(IFile input, IWorkbenchPage page){
		IEditorInput editorInput = new FileEditorInput(input);
		for(String editorId : diagramEditorsIds){
			IEditorReference[] editorRefs = page.findEditors(editorInput, editorId, IWorkbenchPage.MATCH_ID|IWorkbenchPage.MATCH_INPUT);
			if (editorRefs.length > 0)
				return true;
		}
		
		return false;
	}
	
	private class DiagramCompositeChange extends CompositeChange{
		
		private URI oldURI, newURI;
		private ResourceSet rs;
		
		public DiagramCompositeChange(URI oldURI, URI newURI, ResourceSet rs) {
			super("Update Diagrams");
			this.oldURI = oldURI;
			this.newURI = newURI;
			this.rs = rs;
		}
		
		public DiagramCompositeChange(URI oldURI, URI newURI, ResourceSet rs, Change[] childUndos) {
			super("Update Diagrams", childUndos);
			this.oldURI = oldURI;
			this.newURI = newURI;
			this.rs = rs;
		}

		@Override
		public Change perform(IProgressMonitor pm) throws CoreException {
			Resource roomRes = rs.getResources().get(0);
			
			// resolve all cross references
			EcoreUtil.resolveAll(rs);
			
			// change uri of room objects
			roomRes.setURI(newURI);
			
			// perform child changes (and create undo changes):
			// save only diagrams to change cross references
			Change undoChange = super.perform(pm);
			
			return undoChange;
		}
		
		
		@Override
		protected Change createUndoChange(Change[] childUndos) {
			return new DiagramCompositeChange(newURI, oldURI, rs, childUndos);
		}
		
		
		@Override
		protected boolean internalContinueOnCancel() {
			return true;
		}
		
	}
	
	/**
	 * does diagramRes.save(null);
	 */
	private class DiagramUpdateChange extends ResourceChange{

		Resource diagramRes;
		
		public DiagramUpdateChange(Resource diagramRes){
			super();
			this.diagramRes = diagramRes;
			
			setValidationMethod(VALIDATE_NOT_DIRTY);
		}
		
		@Override
		public RefactoringStatus isValid(IProgressMonitor pm)
				throws CoreException, OperationCanceledException {
			
			// ResourceChange valid ?
			final RefactoringStatus status = super.isValid(pm);
			if(status.hasFatalError())
				return status;
			
			// diagram open ?
			Runnable runnable = new Runnable() {

				@Override
				public void run() {
					IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
					if(isDiagramEditorOpen((IFile) getModifiedResource(), page))
						status.addFatalError("Diagram " + diagramRes.getURI().lastSegment() + " is open");	
				}
			};
			Display.getDefault().syncExec(runnable);
			
			// resource still loaded ?
			if(!diagramRes.isLoaded())
				status.addFatalError("Expired");
			
			return status;
		}
		
		@Override
		protected IResource getModifiedResource() {
			IPath path = new Path(diagramRes.getURI().toPlatformString(false));
			return ResourcesPlugin.getWorkspace().getRoot().findMember(path);
		}

		@Override
		public String getName() {
			return "Update references";
		}

		@Override
		public Change perform(IProgressMonitor pm) throws CoreException {
			// save diagram resource to change cross references
			try {
				diagramRes.save(null);
			} catch (IOException e) {
				e.printStackTrace();
				throw new CoreException(Status.CANCEL_STATUS);
			}
			
			return new DiagramUpdateChange(diagramRes);
		}
		
	}

}

Back to the top