Skip to main content
summaryrefslogtreecommitdiffstats
blob: 53f3f9cb04be46fab64095d6eab3e8ba0c09cf4e (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
/*******************************************************************************
 * 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.mylyn.internal.tasks.ui;

import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
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.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.mylyn.monitor.core.DateUtil;
import org.eclipse.mylyn.monitor.core.StatusHandler;
import org.eclipse.mylyn.tasks.core.AbstractRepositoryConnector;
import org.eclipse.mylyn.tasks.core.AbstractRepositoryQuery;
import org.eclipse.mylyn.tasks.core.AbstractTask;
import org.eclipse.mylyn.tasks.core.QueryHitCollector;
import org.eclipse.mylyn.tasks.core.TaskList;
import org.eclipse.mylyn.tasks.core.TaskRepository;
import org.eclipse.mylyn.tasks.core.AbstractTask.RepositoryTaskSyncState;
import org.eclipse.mylyn.tasks.ui.TasksUiPlugin;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.progress.IProgressConstants;

/**
 * @author Mik Kersten
 * @author Rob Elves
 * @author Steffen Pingel
 */
class SynchronizeQueryJob extends Job {

	private final AbstractRepositoryConnector connector;

	private final TaskRepository repository;

	private final Set<AbstractRepositoryQuery> queries;

	private final TaskList taskList;

	private boolean synchronizeChangedTasks;

	private boolean forced = false;

	private HashSet<AbstractTask> tasksToBeSynchronized = new HashSet<AbstractTask>();

	public SynchronizeQueryJob(AbstractRepositoryConnector connector, TaskRepository repository,
			Set<AbstractRepositoryQuery> queries, TaskList taskList) {
		super("Synchronizying queries for " + repository.getRepositoryLabel());

		this.connector = connector;
		this.repository = repository;
		this.queries = queries;
		this.taskList = taskList;
	}

	public void setSynchronizeChangedTasks(boolean synchronizeChangedTasks) {
		this.synchronizeChangedTasks = synchronizeChangedTasks;
	}

	/**
	 * Returns true, if synchronization was triggered manually and not by an automatic background job.
	 */
	public boolean isForced() {
		return forced;
	}

	/**
	 * Indicates a manual synchronization (User initiated). If set to true, a dialog will be displayed in case of
	 * errors. Any tasks with missing data will be retrieved.
	 */
	public void setForced(boolean forced) {
		this.forced = forced;
	}

	@Override
	protected IStatus run(IProgressMonitor monitor) {
		try {
			monitor.beginTask("Synchronizing " + queries.size() + " queries", 20 + queries.size() * 10 + 40);

			Set<AbstractTask> allTasks = Collections.unmodifiableSet(taskList.getRepositoryTasks(repository.getUrl()));

			// check if the repository has changed at all and have the connector mark tasks that need synchronization 
			try {
				monitor.subTask("Checking for changed tasks");
				boolean hasChangedOrNew = connector.markStaleTasks(repository, allTasks,
						new SubProgressMonitor(monitor, 20));
				if (!hasChangedOrNew && !forced) {
					updateQueryStatus(null);
					return Status.OK_STATUS;
				}
			} catch (CoreException e) {
				// synchronization is unlikely to succeed, inform user and exit
				updateQueryStatus(e.getStatus());
				return Status.OK_STATUS;
			}

			// synchronize queries, tasks changed within query are added to set of tasks to be synchronized
			int n = 0;
			for (AbstractRepositoryQuery repositoryQuery : queries) {
				repositoryQuery.setSynchronizationStatus(null);

				monitor.setTaskName("Synchronizing " + ++n + "/" + queries.size() + ": " + repositoryQuery.getSummary());
				synchronizeQuery(repositoryQuery, new SubProgressMonitor(monitor, 10));

				repositoryQuery.setSynchronizing(false);
				taskList.notifyContainersUpdated(Collections.singleton(repositoryQuery));
			}

			// for background synchronizations all changed tasks are synchronized including the ones that are not part of a query
			if (!forced) {
				for (AbstractTask task : allTasks) {
					if (task.isStale()) {
						tasksToBeSynchronized.add(task);
						task.setSynchronizing(true);
					}
				}
			}

			// synchronize tasks that were marked by the connector
			if (!tasksToBeSynchronized.isEmpty()) {
				monitor.setTaskName("Synchronizing " + tasksToBeSynchronized.size() + " changed tasks");
				SynchronizeTaskJob job = new SynchronizeTaskJob(connector, tasksToBeSynchronized);
				job.setForced(forced);
				job.run(new SubProgressMonitor(monitor, 40));

				if (Platform.isRunning() && !(TasksUiPlugin.getRepositoryManager() == null)) {
					TasksUiPlugin.getRepositoryManager().setSynchronizationTime(repository,
							connector.getSynchronizationTimestamp(repository, tasksToBeSynchronized),
							TasksUiPlugin.getDefault().getRepositoriesFilePath());
				}
			}

			taskList.notifyContainersUpdated(null);

			return Status.OK_STATUS;
		} finally {
			monitor.done();
		}
	}

	private void updateQueryStatus(final IStatus status) {
		for (AbstractRepositoryQuery repositoryQuery : queries) {
			repositoryQuery.setSynchronizationStatus(status);
			repositoryQuery.setSynchronizing(false);
		}
		taskList.notifyContainersUpdated(queries);
		
		if (status != null && isForced()) {
			PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
				public void run() {
					StatusHandler.displayStatus("Query Synchronization Failed", status);
				}
			});
		}
	}

	private void synchronizeQuery(AbstractRepositoryQuery repositoryQuery, IProgressMonitor monitor) {
		setProperty(IProgressConstants.ICON_PROPERTY, TasksUiImages.REPOSITORY_SYNCHRONIZE);

		QueryHitCollector collector = new QueryHitCollector(new TaskFactory(repository, true, false));

		final IStatus resultingStatus = connector.performQuery(repositoryQuery, repository, monitor, collector);
		if (resultingStatus.getSeverity() == IStatus.CANCEL) {
			// do nothing
		} else if (resultingStatus.isOK()) {
			if (collector.getTasks().size() >= QueryHitCollector.MAX_HITS) {
				StatusHandler.log(QueryHitCollector.MAX_HITS_REACHED + "\n" + repositoryQuery.getSummary(), this);
			}

			repositoryQuery.clear();

			for (AbstractTask hit : collector.getTasks()) {
				AbstractTask task = taskList.getTask(hit.getHandleIdentifier());
				if (task != null) {
					// update the existing task from the query hit
					boolean changed = connector.updateTaskFromQueryHit(repository, task, hit);
					if (changed && !task.isStale() && task.getSynchronizationState() == RepositoryTaskSyncState.SYNCHRONIZED) {
						// set incoming marker for web tasks 
						task.setSynchronizationState(RepositoryTaskSyncState.INCOMING);
					}
				} else {
					// new tasks are marked stale by default
					task = hit;
					task.setStale(true);
					task.setSynchronizationState(RepositoryTaskSyncState.INCOMING);
				}
				
				taskList.addTask(task, repositoryQuery);
				if (synchronizeChangedTasks && task.isStale()) {
					tasksToBeSynchronized.add(task);
					task.setSynchronizing(true);
				}
			}

			repositoryQuery.setLastSynchronizedStamp(DateUtil.getFormattedDate(new Date(), "MMM d, H:mm:ss"));
		} else {
			repositoryQuery.setSynchronizationStatus(resultingStatus);
			if (isForced()) {
				PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
					public void run() {
						StatusHandler.displayStatus("Query Synchronization Failed", resultingStatus);
					}
				});
			}
		}
	}

}

Back to the top