Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: da35d05caf06cd3c8f2dc456b360859c9acb8703 (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
/*******************************************************************************
 * Copyright (c) 2000, 2007 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.team.internal.ccvs.core;

import java.util.*;

import org.eclipse.core.resources.*;
import org.eclipse.core.resources.team.FileModificationValidationContext;
import org.eclipse.core.resources.team.FileModificationValidator;
import org.eclipse.core.runtime.*;
import org.eclipse.core.runtime.jobs.*;
import org.eclipse.osgi.util.NLS;
import org.eclipse.team.core.RepositoryProvider;
import org.eclipse.team.internal.ccvs.core.resources.CVSWorkspaceRoot;

/**
 * Core validator that will load the UI validator only if a prompt is needed
 */
public class CVSCoreFileModificationValidator extends FileModificationValidator implements ICVSFileModificationValidator {
    
    FileModificationValidator uiValidator;

    @Override
    public IStatus validateEdit(IFile[] files, FileModificationValidationContext context) {
	    IFile[] unmanagedReadOnlyFiles = getUnmanagedReadOnlyFiles(files);
	    if (unmanagedReadOnlyFiles.length > 0) {
	        IStatus status = setWritable(unmanagedReadOnlyFiles);
	        if (!status.isOK()) {
	            return status;
	        }
	    }
		IFile[] readOnlyFiles = getManagedReadOnlyFiles(files);
		if (readOnlyFiles.length == 0) return Status.OK_STATUS;
		return edit(readOnlyFiles, context);
    }

    @Override
    public IStatus validateSave(IFile file) {
		if (!needsCheckout(file)) {
		    if (file.isReadOnly()) {
		        setWritable(new IFile[] { file } );
		    }
		    return Status.OK_STATUS;
		}
		return edit(new IFile[] {file}, (FileModificationValidationContext)null);
    }

    /**
     * Method for editing a set of files. Is overriden by the
     * UI to prompt the user. Default behavior is to try and load the
     * UI validator and, failing that, to edit without 
     * prompting.
     * @param readOnlyFiles
     * @param context
     * @return
     */
    protected IStatus edit(IFile[] readOnlyFiles, FileModificationValidationContext context) {
        FileModificationValidator override = getUIValidator();
        if (override != null) {
            return override.validateEdit(readOnlyFiles, context);
        } else {
	        performEdit(readOnlyFiles);
	        return Status.OK_STATUS;
        }
    }

    private FileModificationValidator getUIValidator() {
        synchronized(this) {
	        if (uiValidator == null) {
	            uiValidator = getPluggedInValidator();
	        }
        }
        return uiValidator;
    }
    
	/**
	 * @see org.eclipse.team.internal.ccvs.core.ICVSFileModificationValidator#validateMoveDelete(org.eclipse.core.resources.IFile[], org.eclipse.core.runtime.IProgressMonitor)
	 */
	public IStatus validateMoveDelete(IFile[] files, IProgressMonitor monitor) {
		IFile[] readOnlyFiles = getManagedReadOnlyFiles(files);
		if (readOnlyFiles.length == 0) return Status.OK_STATUS;

		performEdit(readOnlyFiles);
		return Status.OK_STATUS;
	}
	
    /*
     * Perform the headless edit check in the background.
     * The user will be notified of any errors that occurred.
     */
	protected void performEdit(final IFile[] readOnlyFiles) {
        setWritable(readOnlyFiles);
        Job job = new Job(CVSMessages.CVSCoreFileModificationValidator_editJob) {
            protected IStatus run(IProgressMonitor monitor) {
                try {
                    performEdit(readOnlyFiles, monitor);
                } catch (CVSException e) {
                    return e.getStatus();
                }
                return Status.OK_STATUS;
            }          
        };
        scheduleEditJob(job);
    }

    protected void scheduleEditJob(Job job) {
        job.schedule();
    }

    protected CVSTeamProvider getProvider(IFile[] files) {
		CVSTeamProvider provider = (CVSTeamProvider)RepositoryProvider.getProvider(files[0].getProject(), CVSProviderPlugin.getTypeId());
		return provider;
	}
	
	protected void performEdit(IFile[] files, IProgressMonitor monitor) throws CVSException {
		getProvider(files).edit(files, false /* recurse */, true /* notify server */, true /* notify for writtable files */, ICVSFile.NO_NOTIFICATION, monitor);
	}
	
	private boolean needsCheckout(IFile file) {
		try {
			if (file.isReadOnly()) {
				ICVSFile cvsFile = CVSWorkspaceRoot.getCVSFileFor(file);
				boolean managed = cvsFile.isManaged();
                return managed;
			}
		} catch (CVSException e) {
			// Log the exception and assume we don't need a checkout
			CVSProviderPlugin.log(e);
		}
		return false;
	}
	
	protected IStatus setWritable(final IFile[] files) {
        for (int i = 0; i < files.length; i++) {
        	IFile file = files[i];
        	ResourceAttributes attributes = file.getResourceAttributes();
        	if (attributes != null) {
        		attributes.setReadOnly(false);
        	}
        	try {
        		file.setResourceAttributes(attributes);
        	} catch (CoreException e) {
        		return CVSException.wrapException(e).getStatus();
        	}
        }
        return Status.OK_STATUS;
    }
    
	private IFile[] getManagedReadOnlyFiles(IFile[] files) {
		List readOnlys = new ArrayList();
		for (int i = 0; i < files.length; i++) {
			IFile iFile = files[i];
			if (needsCheckout(iFile)) {
				readOnlys.add(iFile);
			}
		}
		return (IFile[]) readOnlys.toArray(new IFile[readOnlys.size()]);
	}
	
    protected IFile[] getUnmanagedReadOnlyFiles(IFile[] files) {
		List readOnlys = new ArrayList();
		for (int i = 0; i < files.length; i++) {
			IFile iFile = files[i];
			if (iFile.isReadOnly() && !needsCheckout(iFile)) {
				readOnlys.add(iFile);
			}
		}
		return (IFile[]) readOnlys.toArray(new IFile[readOnlys.size()]);
    }
    
	private static FileModificationValidator getPluggedInValidator() {
		IExtension[] extensions = Platform.getExtensionRegistry().getExtensionPoint(CVSProviderPlugin.ID, CVSProviderPlugin.PT_FILE_MODIFICATION_VALIDATOR).getExtensions();
		if (extensions.length == 0)
			return null;
		IExtension extension = extensions[0];
		IConfigurationElement[] configs = extension.getConfigurationElements();
		if (configs.length == 0) {
			CVSProviderPlugin.log(IStatus.ERROR, NLS.bind("The CVS file modification validator is missing from extension {0}", (new Object[] {extension.getUniqueIdentifier()})), null);//$NON-NLS-1$
			return null;
		}
		try {
			IConfigurationElement config = configs[0];
			return (FileModificationValidator) config.createExecutableExtension("run");//$NON-NLS-1$
		} catch (CoreException ex) {
			CVSProviderPlugin.log(IStatus.ERROR, NLS.bind("The CVS file modification validator registered as ID {0} could not be instantiated", (new Object[] {extension.getUniqueIdentifier()})), ex);//$NON-NLS-1$
			return null;
		}
	}
    
    public ISchedulingRule validateEditRule(CVSResourceRuleFactory factory, IResource[] resources) {
        FileModificationValidator override = getUIValidator();
        if (override instanceof CVSCoreFileModificationValidator && override != this) {
            CVSCoreFileModificationValidator ui = (CVSCoreFileModificationValidator) override;
            return ui.validateEditRule(factory, resources);
        }
        return internalValidateEditRule(factory, resources);
    }

    protected final ISchedulingRule internalValidateEditRule(CVSResourceRuleFactory factory, IResource[] resources) {
        if (resources.length == 0)
            return null;
        //optimize rule for single file
        if (resources.length == 1)
            return isReadOnly(resources[0]) ? factory.getParent(resources[0]) : null;
        //need a lock on the parents of all read-only files
        HashSet rules = new HashSet();
        for (int i = 0; i < resources.length; i++)
            if (isReadOnly(resources[i]))
                rules.add(factory.getParent(resources[i]));
        return createSchedulingRule(rules);
    }

    protected ISchedulingRule createSchedulingRule(Set rules) {
        if (rules.isEmpty())
            return null;
        if (rules.size() == 1)
            return (ISchedulingRule) rules.iterator().next();
        ISchedulingRule[] ruleArray = (ISchedulingRule[]) rules
                .toArray(new ISchedulingRule[rules.size()]);
        return new MultiRule(ruleArray);
    }
    
    protected final boolean isReadOnly(IResource resource) {
        ResourceAttributes a = resource.getResourceAttributes();
        if (a != null) {
            return a.isReadOnly();
        }
        return false;
    }
}

Back to the top