source: josm/trunk/src/org/openstreetmap/josm/io/OsmServerWriter.java@ 10817

Last change on this file since 10817 was 10217, checked in by Don-vip, 8 years ago

findbugs - SF_SWITCH_NO_DEFAULT + various sonar fixes
  • Property svn:eol-style set to native
File size: 11.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.io;
3
4import static org.openstreetmap.josm.tools.I18n.marktr;
5import static org.openstreetmap.josm.tools.I18n.tr;
6import static org.openstreetmap.josm.tools.I18n.trn;
7
8import java.util.ArrayList;
9import java.util.Collection;
10import java.util.Iterator;
11import java.util.LinkedList;
12import java.util.List;
13
14import org.openstreetmap.josm.data.osm.Changeset;
15import org.openstreetmap.josm.data.osm.OsmPrimitive;
16import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
17import org.openstreetmap.josm.gui.JosmUserIdentityManager;
18import org.openstreetmap.josm.gui.io.UploadStrategySpecification;
19import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
20import org.openstreetmap.josm.gui.progress.ProgressMonitor;
21import org.openstreetmap.josm.tools.CheckParameterUtil;
22
23/**
24 * Class that uploads all changes to the osm server.
25 *
26 * This is done like this: - All objects with id = 0 are uploaded as new, except
27 * those in deleted, which are ignored - All objects in deleted list are
28 * deleted. - All remaining objects with modified flag set are updated.
29 */
30public class OsmServerWriter {
31 /**
32 * This list contains all successfully processed objects. The caller of
33 * upload* has to check this after the call and update its dataset.
34 *
35 * If a server connection error occurs, this may contain fewer entries
36 * than where passed in the list to upload*.
37 */
38 private Collection<OsmPrimitive> processed;
39
40 private static volatile List<OsmServerWritePostprocessor> postprocessors;
41
42 /**
43 * Registers a post-processor.
44 * @param pp post-processor to register
45 */
46 public static void registerPostprocessor(OsmServerWritePostprocessor pp) {
47 if (postprocessors == null) {
48 postprocessors = new ArrayList<>();
49 }
50 postprocessors.add(pp);
51 }
52
53 /**
54 * Unregisters a post-processor.
55 * @param pp post-processor to unregister
56 */
57 public static void unregisterPostprocessor(OsmServerWritePostprocessor pp) {
58 if (postprocessors != null) {
59 postprocessors.remove(pp);
60 }
61 }
62
63 private final OsmApi api = OsmApi.getOsmApi();
64 private boolean canceled;
65
66 private static final int MSECS_PER_SECOND = 1000;
67 private static final int SECONDS_PER_MINUTE = 60;
68 private static final int MSECS_PER_MINUTE = MSECS_PER_SECOND * SECONDS_PER_MINUTE;
69
70 private long uploadStartTime;
71
72 protected String timeLeft(int progress, int listSize) {
73 long now = System.currentTimeMillis();
74 long elapsed = now - uploadStartTime;
75 if (elapsed == 0) {
76 elapsed = 1;
77 }
78 double uploadsPerMs = (double) progress / elapsed;
79 double uploadsLeft = (double) listSize - progress;
80 long msLeft = (long) (uploadsLeft / uploadsPerMs);
81 long minutesLeft = msLeft / MSECS_PER_MINUTE;
82 long secondsLeft = (msLeft / MSECS_PER_SECOND) % SECONDS_PER_MINUTE;
83 StringBuilder timeLeftStr = new StringBuilder().append(minutesLeft).append(':');
84 if (secondsLeft < 10) {
85 timeLeftStr.append('0');
86 }
87 return timeLeftStr.append(secondsLeft).toString();
88 }
89
90 /**
91 * Uploads the changes individually. Invokes one API call per uploaded primitmive.
92 *
93 * @param primitives the collection of primitives to upload
94 * @param progressMonitor the progress monitor
95 * @throws OsmTransferException if an exception occurs
96 */
97 protected void uploadChangesIndividually(Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor)
98 throws OsmTransferException {
99 try {
100 progressMonitor.beginTask(tr("Starting to upload with one request per primitive ..."));
101 progressMonitor.setTicksCount(primitives.size());
102 uploadStartTime = System.currentTimeMillis();
103 for (OsmPrimitive osm : primitives) {
104 String msg;
105 switch(OsmPrimitiveType.from(osm)) {
106 case NODE: msg = marktr("{0}% ({1}/{2}), {3} left. Uploading node ''{4}'' (id: {5})"); break;
107 case WAY: msg = marktr("{0}% ({1}/{2}), {3} left. Uploading way ''{4}'' (id: {5})"); break;
108 case RELATION: msg = marktr("{0}% ({1}/{2}), {3} left. Uploading relation ''{4}'' (id: {5})"); break;
109 default: throw new AssertionError();
110 }
111 int progress = progressMonitor.getTicks();
112 progressMonitor.subTask(
113 tr(msg,
114 Math.round(100.0*progress/primitives.size()),
115 progress,
116 primitives.size(),
117 timeLeft(progress, primitives.size()),
118 osm.getName() == null ? osm.getId() : osm.getName(), osm.getId()));
119 makeApiRequest(osm, progressMonitor);
120 processed.add(osm);
121 progressMonitor.worked(1);
122 }
123 } catch (OsmTransferException e) {
124 throw e;
125 } catch (Exception e) {
126 throw new OsmTransferException(e);
127 } finally {
128 progressMonitor.finishTask();
129 }
130 }
131
132 /**
133 * Upload all changes in one diff upload
134 *
135 * @param primitives the collection of primitives to upload
136 * @param progressMonitor the progress monitor
137 * @throws OsmTransferException if an exception occurs
138 */
139 protected void uploadChangesAsDiffUpload(Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor)
140 throws OsmTransferException {
141 try {
142 progressMonitor.beginTask(tr("Starting to upload in one request ..."));
143 processed.addAll(api.uploadDiff(primitives, progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false)));
144 } finally {
145 progressMonitor.finishTask();
146 }
147 }
148
149 /**
150 * Upload all changes in one diff upload
151 *
152 * @param primitives the collection of primitives to upload
153 * @param progressMonitor the progress monitor
154 * @param chunkSize the size of the individual upload chunks. &gt; 0 required.
155 * @throws IllegalArgumentException if chunkSize &lt;= 0
156 * @throws OsmTransferException if an exception occurs
157 */
158 protected void uploadChangesInChunks(Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor, int chunkSize)
159 throws OsmTransferException {
160 if (chunkSize <= 0)
161 throw new IllegalArgumentException(tr("Value >0 expected for parameter ''{0}'', got {1}", "chunkSize", chunkSize));
162 try {
163 progressMonitor.beginTask(tr("Starting to upload in chunks..."));
164 List<OsmPrimitive> chunk = new ArrayList<>(chunkSize);
165 Iterator<? extends OsmPrimitive> it = primitives.iterator();
166 int numChunks = (int) Math.ceil((double) primitives.size() / (double) chunkSize);
167 int i = 0;
168 while (it.hasNext()) {
169 i++;
170 if (canceled) return;
171 int j = 0;
172 chunk.clear();
173 while (it.hasNext() && j < chunkSize) {
174 if (canceled) return;
175 j++;
176 chunk.add(it.next());
177 }
178 progressMonitor.setCustomText(
179 trn("({0}/{1}) Uploading {2} object...",
180 "({0}/{1}) Uploading {2} objects...",
181 chunk.size(), i, numChunks, chunk.size()));
182 processed.addAll(api.uploadDiff(chunk, progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false)));
183 }
184 } finally {
185 progressMonitor.finishTask();
186 }
187 }
188
189 /**
190 * Send the dataset to the server.
191 *
192 * @param strategy the upload strategy. Must not be null.
193 * @param primitives list of objects to send
194 * @param changeset the changeset the data is uploaded to. Must not be null.
195 * @param monitor the progress monitor. If null, assumes {@link NullProgressMonitor#INSTANCE}
196 * @throws IllegalArgumentException if changeset is null
197 * @throws IllegalArgumentException if strategy is null
198 * @throws OsmTransferException if something goes wrong
199 */
200 public void uploadOsm(UploadStrategySpecification strategy, Collection<? extends OsmPrimitive> primitives,
201 Changeset changeset, ProgressMonitor monitor) throws OsmTransferException {
202 CheckParameterUtil.ensureParameterNotNull(changeset, "changeset");
203 processed = new LinkedList<>();
204 monitor = monitor == null ? NullProgressMonitor.INSTANCE : monitor;
205 monitor.beginTask(tr("Uploading data ..."));
206 try {
207 api.initialize(monitor);
208 // check whether we can use diff upload
209 if (changeset.getId() == 0) {
210 api.openChangeset(changeset, monitor.createSubTaskMonitor(0, false));
211 // update the user information
212 changeset.setUser(JosmUserIdentityManager.getInstance().asUser());
213 } else {
214 api.updateChangeset(changeset, monitor.createSubTaskMonitor(0, false));
215 }
216 api.setChangeset(changeset);
217 switch(strategy.getStrategy()) {
218 case SINGLE_REQUEST_STRATEGY:
219 uploadChangesAsDiffUpload(primitives, monitor.createSubTaskMonitor(0, false));
220 break;
221 case INDIVIDUAL_OBJECTS_STRATEGY:
222 uploadChangesIndividually(primitives, monitor.createSubTaskMonitor(0, false));
223 break;
224 case CHUNKED_DATASET_STRATEGY:
225 default:
226 uploadChangesInChunks(primitives, monitor.createSubTaskMonitor(0, false), strategy.getChunkSize());
227 break;
228 }
229 } finally {
230 executePostprocessors(monitor);
231 monitor.finishTask();
232 api.setChangeset(null);
233 }
234 }
235
236 void makeApiRequest(OsmPrimitive osm, ProgressMonitor progressMonitor) throws OsmTransferException {
237 if (osm.isDeleted()) {
238 api.deletePrimitive(osm, progressMonitor);
239 } else if (osm.isNew()) {
240 api.createPrimitive(osm, progressMonitor);
241 } else {
242 api.modifyPrimitive(osm, progressMonitor);
243 }
244 }
245
246 /**
247 * Cancel operation.
248 */
249 public void cancel() {
250 this.canceled = true;
251 if (api != null) {
252 api.cancel();
253 }
254 }
255
256 /**
257 * Replies the collection of successfully processed primitives
258 *
259 * @return the collection of successfully processed primitives
260 */
261 public Collection<OsmPrimitive> getProcessedPrimitives() {
262 return processed;
263 }
264
265 /**
266 * Calls all registered upload postprocessors.
267 * @param pm progress monitor
268 */
269 public void executePostprocessors(ProgressMonitor pm) {
270 if (postprocessors != null) {
271 for (OsmServerWritePostprocessor pp : postprocessors) {
272 pp.postprocessUploadedPrimitives(processed, pm);
273 }
274 }
275 }
276}
Note: See TracBrowser for help on using the repository browser.