Changeset 13453 in josm for trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

Timestamp:

2018-02-24T18:58:28+01:00 (7 years ago)

Author:

Don-vip

Message:

fix #8039, fix #10456: final fixes for the read-only/locked layers:

• rename "read-only" to "locked" (in XML and Java classes/interfaces)
• add a new download policy (true/never) to allow private layers forbidding only to download data, but allowing everything else

This leads to:

• normal layers: download allowed, modifications allowed, upload allowed
• private layers: download allowed or not (download=true/never), modifications allowed, upload allowed or not (upload=true/discouraged/never)
• locked layers: nothing allowed, the data cannot be modified in any way

File:

• trunk/src/org/openstreetmap/josm/data/osm/DataSet.java (modified) (22 diffs)

trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

@@ -104 +104 @@
  * @author imi
  */
-public final class DataSet extends QuadBucketPrimitiveStore implements Data, ProjectionChangeListener, ReadOnly {
+public final class DataSet extends QuadBucketPrimitiveStore implements Data, ProjectionChangeListener, Lockable {
+
+    /**
+     * Download policy.
+     *
+     * Determines if download from the OSM server is intended, discouraged, or disabled / blocked.
+     * @see UploadPolicy
+     * @since 13453
+     */
+    public enum DownloadPolicy {
+        /**
+         * Normal dataset, download intended.
+         */
+        NORMAL("true"),
+        /**
+         * Download blocked.
+         * Download options completely disabled. Intended for private layers, see #8039.
+         */
+        BLOCKED("never");
+
+        final String xmlFlag;
+
+        DownloadPolicy(String xmlFlag) {
+            this.xmlFlag = xmlFlag;
+        }
+
+        /**
+         * Get the corresponding value of the <code>upload='...'</code> XML-attribute
+         * in the .osm file.
+         * @return value of the <code>download</code> attribute
+         */
+        public String getXmlFlag() {
+            return xmlFlag;
+        }
+
+        /**
+         * Returns the {@code DownloadPolicy} for the given <code>upload='...'</code> XML-attribute
+         * @param xmlFlag <code>download='...'</code> XML-attribute to convert
+         * @return {@code DownloadPolicy} value
+         * @throws IllegalArgumentException for invalid values
+         */
+        public static DownloadPolicy of(String xmlFlag) {
+            for (DownloadPolicy policy : values()) {
+                if (policy.getXmlFlag().equalsIgnoreCase(xmlFlag)) {
+                    return policy;
+                }
+            }
+            throw new IllegalArgumentException(xmlFlag);
+        }
+    }
 
     /**
      * Upload policy.
      *
-     * Determines if upload to the OSM server is intended, discouraged, or
-     * disabled / blocked.
+     * Determines if upload to the OSM server is intended, discouraged, or disabled / blocked.
+     * @see DownloadPolicy
      */
     public enum UploadPolicy {
@@ -173 +222 @@
 
     private final Storage<OsmPrimitive> allPrimitives = new Storage<>(new Storage.PrimitiveIdHash(), true);
-    private final Map<PrimitiveId, OsmPrimitive> primitivesMap = allPrimitives.foreignKey(new Storage.PrimitiveIdHash());
+    private final Map<PrimitiveId, OsmPrimitive> primitivesMap = allPrimitives
+            .foreignKey(new Storage.PrimitiveIdHash());
     private final CopyOnWriteArrayList<DataSetListener> listeners = new CopyOnWriteArrayList<>();
 
@@ -187 +237 @@
 
     private String name;
+    private DownloadPolicy downloadPolicy;
     private UploadPolicy uploadPolicy;
     /** Flag used to know if the dataset should not be editable */
@@ -250 +301 @@
                 primMap.put(w, newWay);
                 List<Node> newNodes = new ArrayList<>();
-                for (Node n: w.getNodes()) {
+                for (Node n : w.getNodes()) {
                     newNodes.add((Node) primMap.get(n));
                 }
@@ -268 +319 @@
                 Relation newRelation = (Relation) primMap.get(r);
                 List<RelationMember> newMembers = new ArrayList<>();
-                for (RelationMember rm: r.getMembers()) {
+                for (RelationMember rm : r.getMembers()) {
                     newMembers.add(new RelationMember(rm.getRole(), primMap.get(rm.getMember())));
                 }
@@ -378 +429 @@
         checkModifiable();
         this.version = version;
+    }
+
+    /**
+     * Get the download policy.
+     * @return the download policy
+     * @see #setDownloadPolicy(DownloadPolicy)
+     * @since 13453
+     */
+    public DownloadPolicy getDownloadPolicy() {
+        return this.downloadPolicy;
+    }
+
+    /**
+     * Sets the download policy.
+     * @param downloadPolicy the download policy
+     * @see #getUploadPolicy()
+     * @since 13453
+     */
+    public void setDownloadPolicy(DownloadPolicy downloadPolicy) {
+        this.downloadPolicy = downloadPolicy;
     }
 
@@ -529 +600 @@
      */
     public Collection<OsmPrimitive> allNonDeletedPhysicalPrimitives() {
-        return getPrimitives(primitive -> !primitive.isDeleted() && !primitive.isIncomplete() && !(primitive instanceof Relation));
+        return getPrimitives(
+                primitive -> !primitive.isDeleted() && !primitive.isIncomplete() && !(primitive instanceof Relation));
     }
 
@@ -565 +637 @@
             if (getPrimitiveById(primitive) != null)
                 throw new DataIntegrityProblemException(
-                        tr("Unable to add primitive {0} to the dataset because it is already included", primitive.toString()));
+                        tr("Unable to add primitive {0} to the dataset because it is already included",
+                                primitive.toString()));
 
             allPrimitives.add(primitive);
@@ -690 +763 @@
      */
     public Collection<OsmPrimitive> getSelectedNodesAndWays() {
-        return new SubclassFilteredCollection<>(getSelected(), primitive -> primitive instanceof Node || primitive instanceof Way);
+        return new SubclassFilteredCollection<>(getSelected(),
+                primitive -> primitive instanceof Node || primitive instanceof Way);
     }
 
@@ -1006 +1080 @@
         OsmPrimitive result = getPrimitiveById(primitiveId);
         if (result == null && primitiveId != null) {
-            Logging.warn(tr("JOSM expected to find primitive [{0} {1}] in dataset but it is not there. Please report this "
-                    + "at {2}. This is not a critical error, it should be safe to continue in your work.",
+            Logging.warn(tr(
+                    "JOSM expected to find primitive [{0} {1}] in dataset but it is not there. Please report this "
+                            + "at {2}. This is not a critical error, it should be safe to continue in your work.",
                     primitiveId.getType(), Long.toString(primitiveId.getUniqueId()), Main.getJOSMWebsite()));
             Logging.error(new Exception());
@@ -1115 +1190 @@
      */
     public boolean isModified() {
-        for (OsmPrimitive p: allPrimitives) {
+        for (OsmPrimitive p : allPrimitives) {
             if (p.isModified())
                 return true;
@@ -1128 +1203 @@
      */
     public boolean requiresUploadToServer() {
-        for (OsmPrimitive p: allPrimitives) {
+        for (OsmPrimitive p : allPrimitives) {
             if (APIOperation.of(p) != null)
                 return true;
@@ -1199 +1274 @@
                 try {
                     if (eventsToFire.size() < MAX_SINGLE_EVENTS) {
-                        for (AbstractDatasetChangedEvent event: eventsToFire) {
+                        for (AbstractDatasetChangedEvent event : eventsToFire) {
                             fireEventToListeners(event);
                         }
@@ -1219 +1294 @@
 
     private void fireEventToListeners(AbstractDatasetChangedEvent event) {
-        for (DataSetListener listener: listeners) {
+        for (DataSetListener listener : listeners) {
             event.fire(listener);
         }
@@ -1260 +1335 @@
 
     void fireChangesetIdChanged(OsmPrimitive primitive, int oldChangesetId, int newChangesetId) {
-        fireEvent(new ChangesetIdChangedEvent(this, Collections.singletonList(primitive), oldChangesetId, newChangesetId));
+        fireEvent(new ChangesetIdChangedEvent(this, Collections.singletonList(primitive), oldChangesetId,
+                newChangesetId));
     }
 
@@ -1283 +1359 @@
      */
     public void invalidateEastNorthCache() {
-        if (Main.getProjection() == null) return; // sanity check
+        if (Main.getProjection() == null)
+            return; // sanity check
         beginUpdate();
         try {
-            for (Node n: getNodes()) {
+            for (Node n : getNodes()) {
                 n.invalidateEastNorthCache();
             }
@@ -1326 +1403 @@
         try {
             clearSelection();
-            for (OsmPrimitive primitive:allPrimitives) {
+            for (OsmPrimitive primitive : allPrimitives) {
                 primitive.setDataset(null);
             }
@@ -1343 +1420 @@
     public void deleteInvisible() {
         checkModifiable();
-        for (OsmPrimitive primitive:allPrimitives) {
+        for (OsmPrimitive primitive : allPrimitives) {
             if (!primitive.isVisible()) {
                 primitive.setDeleted(true);
@@ -1454 +1531 @@
 
     @Override
-    public void setReadOnly() {
+    public void lock() {
         if (!isReadOnly.compareAndSet(false, true)) {
             Logging.warn("Trying to set readOnly flag on a readOnly dataset ", getName());
@@ -1461 +1538 @@
 
     @Override
-    public void unsetReadOnly() {
+    public void unlock() {
         if (!isReadOnly.compareAndSet(true, false)) {
             Logging.warn("Trying to unset readOnly flag on a non-readOnly dataset ", getName());
@@ -1468 +1545 @@
 
     @Override
-    public boolean isReadOnly() {
+    public boolean isLocked() {
         return isReadOnly.get();
     }
@@ -1477 +1554 @@
      */
     private void checkModifiable() {
-        if (isReadOnly()) {
+        if (isLocked()) {
             throw new IllegalStateException("DataSet is read-only");
         }