[Patch] OSM username in titlebar

[Allroads]

I have two osm usernames, one special for a import, I get mixed up using them, because I do not see which authentication is used on the main screen.

Could this made be visible.

[Allroads]

Example titlebar OSM username

[Don-vip]

We could even implement something similar to Chrome's profile button:

---

[simon04]

When implementing the profile button, one could also take #2710 into account.

[simon04]

Ticket #14106 has been marked as a duplicate of this ticket.

[Allroads]

Switch person is even better!

I like that.

[anonymous]

While creating a new ticket, I was checking for potential open one. I found it :-)

JOSM main windows - osm multi user account management / transparency
Add/Show current logged in OSM username in title bar (or status bar)

I can't estimate about time consumption for this implementation. But if it's easier to put the name of the active OSM user to title bar, I would appreciate please start with this enhancement.

The mentioned comfortable user switch function could be integrated later (independently).

Thanks a lot

[Klumbumbus]

a bit related: #15013

[GerdP]

It is easy to display the username but I don't know how to format it.

[simon04]

Maybe follow the Twitter & Co @ syntax, such as Java OpenStreetMap Editor (@GerdP)?

[GerdP]

Yes, looks better than the prefix "OSM username:"

[GerdP]

use @

[simon04]

I favour the @ variant, but this is just my personal taste.

Some remarks:

1. We use tr(" ({0})", string) in a few other places to allow addressing different spacing styles around parenthesis
2. The title does not update after setting/changing the OSM user in the preferences. (Implementing this might be out of scope since UserIdentityManager cannot notify listeners at the moment.)

[GerdP]

1. Thanks for the hint, will use that
2. Hmm, yes, the missing listener is not nice. I assumed that a mapper would have different configurations for his user names. In that case the user would not change within a session.

[stoecker]

3. Add a option to disable this in the prefs. I can think of situations where this is really unwanted (e.g. when making screenshots).
4. Remember that username may be non-existing.

[GerdP]

Replying to stoecker:

3. Add a option to disable this in the prefs. I can think of situations where this is really unwanted (e.g. when making screenshots).

OK, good point. Should go into the "look and feel" dialog, right?

4. Remember that username may be non-existing.

Does that mean that UserIdentityManager.getInstance() might return null?

[stoecker]

Replying to GerdP:

Replying to stoecker:

3. Add a option to disable this in the prefs. I can think of situations where this is really unwanted (e.g. when making screenshots).

OK, good point. Should go into the "look and feel" dialog, right?

I'd say so.

4. Remember that username may be non-existing.

Does that mean that UserIdentityManager.getInstance() might return null?

Don't know. But I do know that username is optional. You can run josm completely without OSM and I e.g. also do this.

[GerdP]

Replying to stoecker:

Replying to GerdP:

Replying to stoecker:

3. Add a option to disable this in the prefs. I can think of situations where this is really unwanted (e.g. when making screenshots).

OK, good point. Should go into the "look and feel" dialog, right?

I'd say so.

OK, will add a checkbox "display user name in title" with default set to off.

4. Remember that username may be non-existing.

Does that mean that UserIdentityManager.getInstance() might return null?

Don't know. But I do know that username is optional. You can run josm completely without OSM and I e.g. also do this.

OK, I think the null test already handles this but I'll make sure that it works. Might take a few days as I am busy with another project.

[GerdP]

• use tr(" ({0})", string)

[GerdP]

v3 also implements

• add PreferenceChangedListener
• add new checkbox in "look and feel" dialog (below the "Show splash screen at startup" checkbox)

I just noticed a typo. It should be "Show user name in title", not "Show user name in tile".
The listener calls refreshTitle if either the user or the preference draw.show-user was changed.

[GerdP]

fix typo tile -> title

[GerdP]

Two thoughts:
1) the patch relies on the order in which listeners are notified. I am not sure if it is guaranteed that UserIdentityManager
is updated before MainFrame asked for the user name.
2) Maybe I should better evaluate the content of preference osm-server.username instead of calling UserIdentityManager.getInstance().getUserName()?

[GerdP]

Hmm, this is quite complicated. I tested only the case that the username is changed in the preferences dialog.
If I got that right v4 will work fine in this case because UserIdentityManager is updated by org.openstreetmap.josm.io.auth.CredentialsManager.store() before any PreferenceChangeEvent is created.
What confused me was that UserIdentityManager also evaluates the PreferenceChangeEvent.

Still, there seem to be other ways to change the field UserIdentityManager.userName. For example, ChangesetQueryTask may show its own dialog to set user + password and directly updates UserIdentityManager without changing a preference.
This happens e.g. when you click "My changesets" in the "Changeset Management Dialog" in a fresh JOSM installation or if the given combination of user + password is not authenticated. Not sure why this is done.
I hope it is OK to ignore those special cases.

[simon04]

Only listening to osm-server.username also neglects login via OAuth (which uses oauth.access-token.key).

Maybe the cleanest solution would be to maintain a ListenerList in UserIdentityManager, and register the listener in MainFrame on UserIdentityManager. Something like this:

src/org/openstreetmap/josm/data/UserIdentityManager.java

@@ -21 +21 @@
 import org.openstreetmap.josm.spi.preferences.StringSetting;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.JosmRuntimeException;
+import org.openstreetmap.josm.tools.ListenerList;
 import org.openstreetmap.josm.tools.Logging;
 
 /**
@@ -56 +57 @@
 public final class UserIdentityManager implements PreferenceChangedListener {
 
     private static UserIdentityManager instance;
+    private final ListenerList<UserIdentityListener> listeners = ListenerList.create();
 
     /**
      * Replies the unique instance of the JOSM user identity manager
@@ -96 +98 @@
     public void setAnonymous() {
         userName = null;
         userInfo = null;
+        fireUserIdentityChanged();
     }
 
     /**
@@ -114 +117 @@
                     MessageFormat.format("Expected non-empty value for parameter ''{0}'', got ''{1}''", "userName", userName));
         this.userName = trimmedUserName;
         userInfo = null;
+        fireUserIdentityChanged();
     }
 
     /**
@@ -134 +138 @@
         CheckParameterUtil.ensureParameterNotNull(userInfo, "userInfo");
         this.userName = trimmedUserName;
         this.userInfo = userInfo;
+        fireUserIdentityChanged();
     }
 
     /**
@@ -311 +316 @@
             }
         }
     }
+
+    @FunctionalInterface
+    public interface UserIdentityListener {
+        void userIdentityChanged();
+    }
+
+    public void addListener(UserIdentityListener listener) {
+        listeners.addListener(listener);
+    }
+
+    private void fireUserIdentityChanged() {
+        listeners.fireEvent(UserIdentityListener::userIdentityChanged);
+    }
 }

src/org/openstreetmap/josm/gui/MainFrame.java

@@ -102 +104 @@
         // This listener is never removed, since the main frame exists forever.
         MainApplication.getLayerManager().addActiveLayerChangeListener(e -> refreshTitle());
         MainApplication.getLayerManager().addAndFireLayerChangeListener(new ManageLayerListeners());
+        UserIdentityManager.getInstance().addListener(this::refreshTitle);
+        Config.getPref().addKeyPreferenceChangeListener("draw.show-user", event -> this.refreshTitle());
 
         refreshTitle();
 

[GerdP]

Yes, thanks, much better :)

[GerdP]

In 15725/josm:

fix #11914: Allow to show user name in titlebar

• implement UserIdentityListener in UserIdentityManager
• add new checkbox "Show user name in title" in "Look and Feel" preference dialog
• if enabled and not anonymous, show current user prefixed with "@" in titlebar of main window

[GerdP]

It is possible to change the user stored in the CredentialsManager while uploading data.

[GerdP]

Seems the approach was wrong. The user that is really in use may be stored in AbstractCredentialsAgent.memoryCredentialsCache.
I don't yet understand if this is an error or a feature. The user changes but UserIdentityManager is not aware of this.

[GerdP]

Solution or hack?

[GerdP]

It seems the value in AbstractCredentialsAgent.memoryCredentialsCache is not even changed when I use the preferences dialog to set a different user. This really looks like an error.

[GerdP]

improve comments

[GerdP]

Patch 11914.4.patch fixes the problems mentioned in comment:27 and comment:29 as long as no plugin uses
CredentialsManager.registerCredentialsAgentFactory(CredentialsAgentFactory agentFactory)
Changes:

• update UserIdentityManager when CredentialsManager is updated.
• call purgeCredentialsCache() when user is changed so that we don't use previously user when the new user+password combination is bad.

@Dirk, Vincent:
I wonder why we allow a plugin to change such a basic security part. If I got that right every plugin can achive control here and send secret information to a third party? Maybe open a new ticket for this?

[Don-vip]

Plugins can do anything. We do not have particular security layer restricting what they can do. Remember the "no more mapping" plugin.

[GerdP]

In 15757/josm:

fix #11914: show OSM username in titlebar

• update UserIdentityManager when CredentialsManager is updated.
• call purgeCredentialsCache() when user is changed so that we don't use previously user when the new user+password combination is bad.

[GerdP]

Just for clarification: I changed the status to critical because JOSM sometimes ignored a change of the user name made in the preference dialog. I was too lazy to open a new ticket for that. Probably not a good idea...

[Don-vip]

Even that would not justify a critical issue to my eyes. Who really changes often its username? It's not a common scenario.

[GerdP]

OK, it's unliky to happen but when it happens its effect may be that you upload a changeset with the wrong user. I consider this critical, esp. when JOSM shows that you work with user abc and in fact you upload as user xyz.

[stoecker]

Well for JOSM the states are:

• normal - all
• major - more important issue affecting a group of users
• critical - a large number of users is affected (we're getting a lot of duplicate reports), usually results in a hotfix and manual latest compilation
• blocker - JOSM doesn't work at all for a majority of users

[GerdP]

OK, thanks, I'll save a link to this list.

[Klumbumbus]

I created wiki:/DevelopersGuide/Tickets