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) 2004 - 2006 University Of British Columbia and others.
* 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:
* University Of British Columbia - initial API and implementation
*******************************************************************************/
package org.eclipse.mylar.tasks.core;
import java.io.File;
import java.io.IOException;
import java.net.Proxy;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.mylar.context.core.ContextCorePlugin;
import org.eclipse.mylar.internal.context.core.util.ZipFileUtil;
import org.eclipse.mylar.tasks.core.AbstractRepositoryTask.RepositoryTaskSyncState;
/**
* Encapsulates synchronization policy.
*
* @author Mik Kersten
* @author Rob Elves
*/
public abstract class AbstractRepositoryConnector {
public static final String MESSAGE_ATTACHMENTS_NOT_SUPPORTED = "Attachments not supported by connector: ";
public static final String MYLAR_CONTEXT_DESCRIPTION = "mylar/context/zip";
private static final String APPLICATION_OCTET_STREAM = "application/octet-stream";
private static final String ZIPFILE_EXTENSION = ".zip";
protected List<String> supportedVersions;
protected Set<RepositoryTemplate> templates = new LinkedHashSet<RepositoryTemplate>();
protected TaskList taskList;
public void init(TaskList taskList) {
this.taskList = taskList;
}
/**
* @return null if not supported
*/
public abstract IAttachmentHandler getAttachmentHandler();
/**
* @return null if not supported
*/
public abstract IOfflineTaskHandler getOfflineTaskHandler();
public abstract String getRepositoryUrlFromTaskUrl(String url);
public abstract boolean canCreateTaskFromKey(TaskRepository repository);
public abstract boolean canCreateNewTask(TaskRepository repository);
/**
* Reset and update the repository attributes from the server (e.g.
* products, components)
* @param proxySettings TODO
* @throws CoreException TODO
*/
public abstract void updateAttributes(TaskRepository repository, Proxy proxySettings, IProgressMonitor monitor) throws CoreException;
/**
* @param id
* identifier, e.g. "123" bug Bugzilla bug 123
* @param proxySettings TODO
* @return null if task could not be created
* @throws CoreException TODO
*/
public abstract ITask createTaskFromExistingKey(TaskRepository repository, String id, Proxy proxySettings) throws CoreException;
/**
* Implementors must execute query synchronously.
*
* @param query
* @param repository TODO
* @param proxySettings TODO
* @param monitor
* @param resultCollector
* IQueryHitCollector that collects the hits found
*/
public abstract IStatus performQuery(AbstractRepositoryQuery query, TaskRepository repository,
Proxy proxySettings, IProgressMonitor monitor, QueryHitCollector resultCollector);
public abstract String getLabel();
/**
* @return the unique type of the repository, e.g. "bugzilla"
*/
public abstract String getRepositoryType();
public abstract List<String> getSupportedVersions();
public abstract void updateTaskState(AbstractRepositoryTask repositoryTask);
public String[] repositoryPropertyNames() {
return new String[] { IRepositoryConstants.PROPERTY_VERSION, IRepositoryConstants.PROPERTY_TIMEZONE,
IRepositoryConstants.PROPERTY_ENCODING };
}
/**
* Implementors of this repositoryOperations must perform it locally without
* going to the server since it is used for frequent repositoryOperations
* such as decoration.
*
* @return an empty set if no contexts
*/
public final Set<RepositoryAttachment> getContextAttachments(TaskRepository repository, AbstractRepositoryTask task) {
Set<RepositoryAttachment> contextAttachments = new HashSet<RepositoryAttachment>();
if (task.getTaskData() != null) {
for (RepositoryAttachment attachment : task.getTaskData().getAttachments()) {
if (attachment.getDescription().equals(MYLAR_CONTEXT_DESCRIPTION)) {
contextAttachments.add(attachment);
}
}
}
return contextAttachments;
}
// TODO: move
public final boolean hasRepositoryContext(TaskRepository repository, AbstractRepositoryTask task) {
if (repository == null || task == null) {
return false;
} else {
Set<RepositoryAttachment> remoteContextAttachments = getContextAttachments(repository, task);
return (remoteContextAttachments != null && remoteContextAttachments.size() > 0);
}
}
/**
* Attaches the associated context to <code>task</code>.
*
* @return false, if operation is not supported by repository
*/
public final boolean attachContext(TaskRepository repository, AbstractRepositoryTask task, String longComment,
Proxy proxySettings) throws CoreException {
ContextCorePlugin.getContextManager().saveContext(task.getHandleIdentifier());
File sourceContextFile = ContextCorePlugin.getContextManager().getFileForContext(task.getHandleIdentifier());
if (sourceContextFile != null && sourceContextFile.exists()) {
IAttachmentHandler handler = getAttachmentHandler();
if (handler == null) {
return false;
}
// compress context file
List<File> filesToZip = new ArrayList<File>();
filesToZip.add(sourceContextFile);
File destinationFile;
try {
destinationFile = File.createTempFile(sourceContextFile.getName(), ZIPFILE_EXTENSION);
destinationFile.deleteOnExit();
ZipFileUtil.createZipFile(destinationFile, filesToZip, new NullProgressMonitor());
} catch (IOException e) {
throw new CoreException(new Status(IStatus.ERROR, ContextCorePlugin.PLUGIN_ID, 0,
"Error compressing context file", e));
}
try {
// TODO: 'faking' outgoing state
task.setSyncState(RepositoryTaskSyncState.OUTGOING);
handler.uploadAttachment(repository, task, longComment, MYLAR_CONTEXT_DESCRIPTION, destinationFile,
APPLICATION_OCTET_STREAM, false, proxySettings);
} catch (CoreException e) {
task.setSyncState(RepositoryTaskSyncState.SYNCHRONIZED);
throw e;
}
task.setTaskData(null);
}
return true;
}
/**
* Retrieves a context stored in <code>attachment</code> from
* <code>task</code>.
*
* @return false, if operation is not supported by repository
*/
public final boolean retrieveContext(TaskRepository repository, AbstractRepositoryTask task,
RepositoryAttachment attachment, Proxy proxySettings, String destinationPath) throws CoreException {
IAttachmentHandler attachmentHandler = getAttachmentHandler();
if (attachmentHandler == null) {
return false;
}
File destinationContextFile = ContextCorePlugin.getContextManager().getFileForContext(
task.getHandleIdentifier());
// TODO what if destinationContextFile == null?
File destinationZipFile = new File(destinationContextFile.getPath() + ZIPFILE_EXTENSION);
attachmentHandler.downloadAttachment(repository, task, attachment, destinationZipFile, proxySettings);
// if (destinationContextFile.exists()) {
try {
ZipFileUtil.unzipFiles(destinationZipFile, destinationPath);
} catch (IOException e) {
throw new CoreException(new Status(IStatus.ERROR, ContextCorePlugin.PLUGIN_ID, 0,
"Error extracting context file", e));
}
return true;
}
public void addTemplate(RepositoryTemplate template) {
this.templates.add(template);
}
public Set<RepositoryTemplate> getTemplates() {
return templates;
}
/** returns null if template not found */
public RepositoryTemplate getTemplate(String label) {
for (RepositoryTemplate template : getTemplates()) {
if (template.label.equals(label)) {
return template;
}
}
return null;
}
}
|
