Changeset 6349 in josm

Timestamp:

2013-10-31T22:52:58+01:00 (10 years ago)

Author:

Don-vip

Message:

fix #9234 - For identified users, notifies periodically (every 5 minutes by default) of new OSM messages he/she has received. All of this is configurable in server access preferences.

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/osm/UserInfo.java (modified) (2 diffs)
• gui/ExceptionDialogUtil.java (modified) (4 diffs)
• gui/JosmUserIdentityManager.java (modified) (3 diffs)
• gui/MainApplication.java (modified) (2 diffs)
• gui/preferences/server/AuthenticationPreferencesPanel.java (modified) (7 diffs)
• gui/preferences/server/MessagesNotifierPanel.java (added)
• io/MessageNotifier.java (added)
• io/OsmApi.java (modified) (1 diff)
• io/OsmServerUserInfoReader.java (modified) (3 diffs)
• io/auth/CredentialsManager.java (modified) (3 diffs)
• io/auth/DefaultAuthenticator.java (modified) (2 diffs)

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

@@ -22 +22 @@
     /** the list of preferred languages */
     private List<String> languages;
+    /** the number of unread messages */
+    private int unreadMessages;
 
+    /**
+     * Constructs a new {@code UserInfo}.
+     */
     public UserInfo() {
         id = 0;
@@ -71 +76 @@
         this.homeZoom = homeZoom;
     }
+
+    /**
+     * Replies the number of unread messages
+     * @return the number of unread messages
+     * @since 6349
+     */
+    public final int getUnreadMessages() {
+        return unreadMessages;
+    }
+
+    /**
+     * Sets the number of unread messages
+     * @param unreadMessages the number of unread messages
+     * @since 6349
+     */
+    public final void setUnreadMessages(int unreadMessages) {
+        this.unreadMessages = unreadMessages;
+    }
 }

trunk/src/org/openstreetmap/josm/gui/ExceptionDialogUtil.java

@@ -20 +20 @@
 import org.openstreetmap.josm.io.IllegalDataException;
 import org.openstreetmap.josm.io.MissingOAuthAccessTokenException;
+import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.io.OsmApiException;
 import org.openstreetmap.josm.io.OsmApiInitializationException;
@@ -244 +245 @@
     }
 
-    private static boolean isOAuth() {
-        return Main.pref.get("osm-server.auth-method", "basic").equals("oauth");
-    }
-
     /**
      * Explains a {@link OsmApiException} which was thrown because the authentication at
@@ -256 +253 @@
     public static void explainAuthenticationFailed(OsmApiException e) {
         String msg;
-        if (isOAuth()) {
+        if (OsmApi.isUsingOAuth()) {
             msg = ExceptionUtil.explainFailedOAuthAuthentication(e);
         } else {
@@ -293 +290 @@
             msg = tr("Access to redacted version ''{0}'' of {1} {2} is forbidden.",
                     version, tr(type), id);
-        } else if (isOAuth()) {
+        } else if (OsmApi.isUsingOAuth()) {
             msg = ExceptionUtil.explainFailedOAuthAuthorisation(e);
         } else {

trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java

@@ -14 +14 @@
 import org.openstreetmap.josm.gui.preferences.server.OAuthAccessTokenHolder;
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
+import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.io.OsmServerUserInfoReader;
 import org.openstreetmap.josm.io.OsmTransferException;
@@ -60 +61 @@
         if (instance == null) {
             instance = new JosmUserIdentityManager();
-            if (Main.pref.get("osm-server.auth-method").equals("oauth") && OAuthAccessTokenHolder.getInstance().containsAccessToken()) {
+            if (OsmApi.isUsingOAuth() && OAuthAccessTokenHolder.getInstance().containsAccessToken()) {
                 try {
                     instance.initFromOAuth(Main.parent);
@@ -272 +273 @@
             accessTokenKeyChanged = false;
             accessTokenSecretChanged = false;
-            if (Main.pref.get("osm-server.auth-method").equals("oauth")) {
+            if (OsmApi.isUsingOAuth()) {
                 try {
                     instance.initFromOAuth(Main.parent);

trunk/src/org/openstreetmap/josm/gui/MainApplication.java

@@ -42 +42 @@
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.io.DefaultProxySelector;
+import org.openstreetmap.josm.io.MessageNotifier;
 import org.openstreetmap.josm.io.auth.CredentialsManager;
 import org.openstreetmap.josm.io.auth.DefaultAuthenticator;
@@ -443 +444 @@
             RemoteControl.start();
         }
+        
+        if (MessageNotifier.PROP_NOTIFIER_ENABLED.get()) {
+            MessageNotifier.start();
+        }
 
         if (Main.pref.getBoolean("debug.edt-checker.enable", Version.getInstance().isLocalBuild())) {

trunk/src/org/openstreetmap/josm/gui/preferences/server/AuthenticationPreferencesPanel.java

@@ -41 +41 @@
     /** the panel for the OAuth authentication parameters */
     private OAuthAuthenticationPreferencesPanel pnlOAuthPreferences;
+    /** the panel for messages notifier preferences */
+    private MessagesNotifierPanel pnlMessagesPreferences;
 
     /**
@@ -74 +76 @@
         bg.add(rbOAuth);
 
-        //-- add the panel which will hld the authentication parameters
+        //-- add the panel which will hold the authentication parameters
         gc.gridx = 0;
         gc.gridy = 1;
@@ -84 +86 @@
         pnlAuthenticationParameteters.setLayout(new BorderLayout());
 
-        //-- the two panel for authentication parameters
+        //-- the two panels for authentication parameters
         pnlBasicAuthPreferences = new BasicAuthenticationPreferencesPanel();
         pnlOAuthPreferences = new OAuthAuthenticationPreferencesPanel();
@@ -90 +92 @@
         rbBasicAuthentication.setSelected(true);
         pnlAuthenticationParameteters.add(pnlBasicAuthPreferences, BorderLayout.CENTER);
+        
+        //-- the panel for messages preferences
+        gc.gridy = 2;
+        gc.fill = GridBagConstraints.NONE;
+        add(pnlMessagesPreferences = new MessagesNotifierPanel(), gc);
     }
 
+    /**
+     * Constructs a new {@code AuthenticationPreferencesPanel}.
+     */
     public AuthenticationPreferencesPanel() {
         build();
@@ -97 +107 @@
     }
 
+    /**
+     * Initializes the panel from preferences
+     */
     public void initFromPreferences() {
         String authMethod = Main.pref.get("osm-server.auth-method", "basic");
@@ -109 +122 @@
         pnlBasicAuthPreferences.initFromPreferences();
         pnlOAuthPreferences.initFromPreferences();
+        pnlMessagesPreferences.initFromPreferences();
     }
 
+    /**
+     * Saves the current values to preferences
+     */
     public void saveToPreferences() {
         // save the authentication method
@@ -131 +148 @@
             pnlOAuthPreferences.saveToPreferences();
         }
+        // save message notifications preferences. To be done after authentication preferences.
+        pnlMessagesPreferences.saveToPreferences();
     }
 

trunk/src/org/openstreetmap/josm/io/OsmApi.java

@@ -564 +564 @@
     }
 
-    protected boolean isUsingOAuth() {
-        String authMethod = Main.pref.get("osm-server.auth-method", "basic");
-        return authMethod.equals("oauth");
+    /**
+     * Determines if JOSM is configured to access OSM API via OAuth
+     * @return {@code true} if JOSM is configured to access OSM API via OAuth, {@code false} otherwise
+     * @since 6349
+     */
+    public static final boolean isUsingOAuth() {
+        return "oauth".equals(Main.pref.get("osm-server.auth-method", "basic"));
     }
 

trunk/src/org/openstreetmap/josm/io/OsmServerUserInfoReader.java

@@ -29 +29 @@
     }
 
-    static public  UserInfo buildFromXML(Document document) throws OsmDataParsingException{
+    /**
+     * Parses the given XML data and returns the associated user info.
+     * @param document The XML contents
+     * @return The user info
+     * @throws OsmDataParsingException if parsing goes wrong
+     */
+    static public UserInfo buildFromXML(Document document) throws OsmDataParsingException {
         try {
             XPathFactory factory = XPathFactory.newInstance();
@@ -105 +111 @@
                 userInfo.setLanguages(languages);
             }
+            
+            // -- messages
+            xmlNode = (Node)xpath.compile("/osm/user[1]/messages/received").evaluate(document, XPathConstants.NODE);
+            if (xmlNode != null) {
+                v = getAttribute(xmlNode, "unread");
+                if (v == null)
+                    throw new OsmDataParsingException(tr("Missing attribute ''{0}'' on XML tag ''{1}''.", "unread", "received"));
+                try {
+                    userInfo.setUnreadMessages(Integer.parseInt(v));
+                } catch(NumberFormatException e) {
+                    throw new OsmDataParsingException(tr("Illegal value for attribute ''{0}'' on XML tag ''{1}''. Got {2}.", "unread", "received", v));
+                }
+            }
+            
             return userInfo;
         } catch(XPathException e) {
@@ -111 +131 @@
     }
 
+    /**
+     * Constructs a new {@code OsmServerUserInfoReader}.
+     */
     public OsmServerUserInfoReader() {
         setDoAuthenticate(true);

trunk/src/org/openstreetmap/josm/io/auth/CredentialsManager.java

@@ -9 +9 @@
 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
 import org.openstreetmap.josm.io.OsmApi;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.Utils;
 
@@ -15 +16 @@
  *
  * Currently, it defaults to replying an instance of {@link JosmPreferencesCredentialAgent}.
- *
+ * @since 2641
  */
 public class CredentialsManager implements CredentialsAgent {
@@ -56 +57 @@
     }
 
-    /*****
-     * non-static fields and methods
+    /* non-static fields and methods */
+
+    /**
+     * The credentials agent doing the real stuff
      */
-
     private CredentialsAgent delegate;
 
+    /**
+     * Constructs a new {@code CredentialsManager}.
+     * @param delegate The credentials agent backing this credential manager. Must not be {@code null}
+     */
     public CredentialsManager(CredentialsAgent delegate) {
+        CheckParameterUtil.ensureParameterNotNull(delegate, "delegate");
         this.delegate = delegate;
     }
+    
+    /**
+     * Returns type of credentials agent backing this credentials manager.
+     * @return The type of credentials agent
+     */
+    public final Class<? extends CredentialsAgent> getCredentialsAgentClass () {
+        return delegate.getClass();
+    }
 
+    /**
+     * Returns the username for OSM API
+     * @return the username for OSM API
+     */
     public String getUsername() {
         return getUsername(OsmApi.getOsmApi().getHost());
     }
 
+    /**
+     * Returns the username for a given host
+     * @param host The host for which username is wanted
+     * @return The username for {@code host}
+     */
     public String getUsername(String host) {
         String username = null;

trunk/src/org/openstreetmap/josm/io/auth/DefaultAuthenticator.java

@@ -7 +7 @@
 import java.util.Map;
 
-import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.io.OsmApi;
 
 /**
@@ -43 +43 @@
             if (getRequestorType().equals(Authenticator.RequestorType.SERVER)) {
                 // if we are working with OAuth we don't prompt for a password
-                //
-                String authMethod = Main.pref.get("osm-server.auth-method", "basic");
-                if (authMethod.equals("oauth"))
+                if (OsmApi.isUsingOAuth())
                     return null;
             }