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

Last change on this file since 8390 was 8384, checked in by Don-vip, 9 years ago

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