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
|
/*******************************************************************************
* Copyright (c) 2003, 2004 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.internal.ui.synchronize;
import java.text.DateFormat;
import java.util.Date;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.osgi.util.NLS;
import org.eclipse.team.internal.ui.TeamUIMessages;
import org.eclipse.team.internal.ui.TeamUIPlugin;
import org.eclipse.team.ui.synchronize.ISynchronizeParticipant;
import org.eclipse.ui.IMemento;
import org.eclipse.ui.actions.ActionFactory;
/**
* Schedule to refresh a subscriber at a specified interval. The schedule can be disabled or enabled
* and will create the refresh job.
*
* @since 3.0
*/
public class SubscriberRefreshSchedule {
private long refreshInterval = 3600; // 1 hour default
private boolean enabled = false;
private RefreshParticipantJob job;
private IRefreshable refreshable;
private IRefreshEvent lastRefreshEvent;
/**
* Key for settings in memento
*/
private static final String CTX_REFRESHSCHEDULE_INTERVAL = TeamUIPlugin.ID + ".CTX_REFRESHSCHEDULE_INTERVAL"; //$NON-NLS-1$
/**
* Key for schedule in memento
*/
private static final String CTX_REFRESHSCHEDULE_ENABLED = TeamUIPlugin.ID + ".CTX_REFRESHSCHEDULE_ENABLED"; //$NON-NLS-1$
private IRefreshSubscriberListener refreshSubscriberListener = new IRefreshSubscriberListener() {
public void refreshStarted(IRefreshEvent event) {
}
public ActionFactory.IWorkbenchAction refreshDone(final IRefreshEvent event) {
if (event.getParticipant() == refreshable) {
lastRefreshEvent = event;
if(enabled && event.getRefreshType() == IRefreshEvent.SCHEDULED_REFRESH) {
RefreshUserNotificationPolicy policy = new RefreshUserNotificationPolicy(refreshable.getParticipant());
policy.refreshDone(event);
}
}
return null;
}
};
public SubscriberRefreshSchedule(IRefreshable refreshable) {
this.refreshable = refreshable;
RefreshParticipantJob.addRefreshListener(refreshSubscriberListener);
}
/**
* @return Returns the enabled.
*/
public boolean isEnabled() {
return enabled;
}
/**
* @param enabled The enabled to set.
*/
public void setEnabled(boolean enabled, boolean allowedToStart) {
boolean wasEnabled = isEnabled();
this.enabled = enabled;
if(enabled && ! wasEnabled) {
if(allowedToStart) {
startJob();
}
} else {
stopJob();
}
}
/**
* @return Returns the refreshInterval in seconds.
*/
public long getRefreshInterval() {
return refreshInterval;
}
public ISynchronizeParticipant getParticipant() {
return refreshable.getParticipant();
}
/**
* @param refreshInterval The refreshInterval to set.
*/
public void setRefreshInterval(long refreshInterval) {
if(refreshInterval != getRefreshInterval()) {
stopJob();
this.refreshInterval = refreshInterval;
if(isEnabled()) {
startJob();
}
}
}
public void startJob() {
if(job == null) {
job = refreshable.createJob(getRefreshIntervalAsString());
job.setUser(false);
} else if(job.getState() != Job.NONE){
stopJob();
}
job.setRefreshInterval(getRefreshInterval());
job.setRestartOnCancel(true);
job.setReschedule(true);
// Schedule delay is in mills.
job.schedule(getRefreshInterval() * 1000);
}
protected void stopJob() {
if(job != null) {
job.setRestartOnCancel(false /* don't restart the job */);
job.setReschedule(false);
job.cancel();
job = null;
}
}
public void dispose() {
stopJob();
RefreshParticipantJob.removeRefreshListener(refreshSubscriberListener);
}
public void saveState(IMemento memento) {
memento.putString(CTX_REFRESHSCHEDULE_ENABLED, Boolean.toString(enabled));
memento.putInteger(CTX_REFRESHSCHEDULE_INTERVAL, (int)refreshInterval);
}
public static SubscriberRefreshSchedule init(IMemento memento, IRefreshable refreshable) {
SubscriberRefreshSchedule schedule = new SubscriberRefreshSchedule(refreshable);
if(memento != null) {
String enabled = memento.getString(CTX_REFRESHSCHEDULE_ENABLED);
int interval = memento.getInteger(CTX_REFRESHSCHEDULE_INTERVAL).intValue();
schedule.setRefreshInterval(interval);
schedule.setEnabled("true".equals(enabled) ? true : false, false /* don't start job */); //$NON-NLS-1$
}
// Use the defaults if a schedule hasn't been saved or can't be found.
return schedule;
}
public static String refreshEventAsString(IRefreshEvent event) {
if(event == null) {
return TeamUIMessages.SyncViewPreferencePage_lastRefreshRunNever;
}
long stopMills = event.getStopTime();
StringBuffer text = new StringBuffer();
if(stopMills <= 0) {
text.append(TeamUIMessages.SyncViewPreferencePage_lastRefreshRunNever);
} else {
Date lastTimeRun = new Date(stopMills);
text.append(DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT).format(lastTimeRun));
}
int changeCount = event.getChangeDescription().getChangeCount();
if (changeCount == 0) {
text.append(TeamUIMessages.RefreshSchedule_7);
} else if (changeCount == 1) {
text.append(NLS.bind(TeamUIMessages.RefreshSchedule_changesSingular, new String[] { Integer.toString(changeCount) }));
} else {
text.append(NLS.bind(TeamUIMessages.RefreshSchedule_changesPlural, new String[] { Integer.toString(changeCount) }));
}
return text.toString();
}
public IRefreshEvent getLastRefreshEvent() {
return lastRefreshEvent;
}
private String getRefreshIntervalAsString() {
boolean hours = false;
long seconds = getRefreshInterval();
if(seconds <= 60) {
seconds = 60;
}
long minutes = seconds / 60;
if(minutes >= 60) {
minutes = minutes / 60;
hours = true;
}
String unit;
if(minutes >= 1) {
unit = (hours ? TeamUIMessages.RefreshSchedule_9 : TeamUIMessages.RefreshSchedule_10); //
} else {
unit = (hours ? TeamUIMessages.RefreshSchedule_11 : TeamUIMessages.RefreshSchedule_12); //
}
return NLS.bind(TeamUIMessages.RefreshSchedule_13, new String[] { Long.toString(minutes), unit });
}
public IRefreshable getRefreshable() {
return refreshable;
}
}
|
