Ignore:
Timestamp:
2017-09-05T21:13:21+02:00 (4 years ago)
Author:
Don-vip
Message:

see #15229 - see #15182 - deprecate gui.JosmUserIdentityManager - replaced by data.UserIdentityManager

Location:
trunk/src/org/openstreetmap/josm/gui
Files:
9 edited

Legend:

Unmodified
Added
Removed

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

    r12686 r12743  
    22package org.openstreetmap.josm.gui;
    33
    4 import static org.openstreetmap.josm.tools.I18n.tr;
    5 
    6 import java.text.MessageFormat;
    7 
    8 import org.openstreetmap.josm.Main;
    94import org.openstreetmap.josm.data.Preferences.PreferenceChangeEvent;
    10 import org.openstreetmap.josm.data.Preferences.PreferenceChangedListener;
    11 import org.openstreetmap.josm.data.oauth.OAuthAccessTokenHolder;
     5import org.openstreetmap.josm.data.UserIdentityManager;
    126import org.openstreetmap.josm.data.osm.User;
    137import org.openstreetmap.josm.data.osm.UserInfo;
    14 import org.openstreetmap.josm.data.preferences.StringSetting;
    15 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
    16 import org.openstreetmap.josm.io.OnlineResource;
    17 import org.openstreetmap.josm.io.OsmApi;
    18 import org.openstreetmap.josm.io.OsmServerUserInfoReader;
    19 import org.openstreetmap.josm.io.OsmTransferException;
    20 import org.openstreetmap.josm.io.auth.CredentialsManager;
    21 import org.openstreetmap.josm.tools.CheckParameterUtil;
    22 import org.openstreetmap.josm.tools.JosmRuntimeException;
    23 import org.openstreetmap.josm.tools.Logging;
    248
    259/**
    … …  
    5034 *   <li>safely search for objects last touched by the current user based on its user id, not on its user name</li>
    5135 * </ul>
    52  *
     36 * @since 2689 (creation)
     37 * @deprecated to be removed end of 2017. Use {@link UserIdentityManager} instead
    5338 */
    54 public final class JosmUserIdentityManager implements PreferenceChangedListener {
     39@Deprecated
     40public final class JosmUserIdentityManager {
    5541
    5642    private static JosmUserIdentityManager instance;
    … …  
    6450        if (instance == null) {
    6551            instance = new JosmUserIdentityManager();
    66             if (OsmApi.isUsingOAuth() && OAuthAccessTokenHolder.getInstance().containsAccessToken() &&
    67                     !Main.isOffline(OnlineResource.OSM_API)) {
    68                 try {
    69                     instance.initFromOAuth();
    70                 } catch (JosmRuntimeException | IllegalArgumentException | IllegalStateException e) {
    71                     Logging.error(e);
    72                     // Fall back to preferences if OAuth identification fails for any reason
    73                     instance.initFromPreferences();
    74                 }
    75             } else {
    76                 instance.initFromPreferences();
    77             }
    78             Main.pref.addPreferenceChangeListener(instance);
     52            UserIdentityManager.getInstance();
    7953        }
    8054        return instance;
    8155    }
    82 
    83     private String userName;
    84     private UserInfo userInfo;
    85     private boolean accessTokenKeyChanged;
    86     private boolean accessTokenSecretChanged;
    8756
    8857    private JosmUserIdentityManager() {
    … …  
    9362     */
    9463    public void setAnonymous() {
    95         userName = null;
    96         userInfo = null;
     64        UserIdentityManager.getInstance().setAnonymous();
    9765    }
    9866
    … …  
    10674     */
    10775    public void setPartiallyIdentified(String userName) {
    108         CheckParameterUtil.ensureParameterNotNull(userName, "userName");
    109         String trimmedUserName = userName.trim();
    110         if (trimmedUserName.isEmpty())
    111             throw new IllegalArgumentException(
    112                     MessageFormat.format("Expected non-empty value for parameter ''{0}'', got ''{1}''", "userName", userName));
    113         this.userName = trimmedUserName;
    114         userInfo = null;
     76        UserIdentityManager.getInstance().setPartiallyIdentified(userName);
    11577    }
    11678
    … …  
    12688     */
    12789    public void setFullyIdentified(String userName, UserInfo userInfo) {
    128         CheckParameterUtil.ensureParameterNotNull(userName, "userName");
    129         String trimmedUserName = userName.trim();
    130         if (trimmedUserName.isEmpty())
    131             throw new IllegalArgumentException(tr("Expected non-empty value for parameter ''{0}'', got ''{1}''", "userName", userName));
    132         CheckParameterUtil.ensureParameterNotNull(userInfo, "userInfo");
    133         this.userName = trimmedUserName;
    134         this.userInfo = userInfo;
     90        UserIdentityManager.getInstance().setFullyIdentified(userName, userInfo);
    13591    }
    13692
    … …  
    14197     */
    14298    public boolean isAnonymous() {
    143         return userName == null && userInfo == null;
     99        return UserIdentityManager.getInstance().isAnonymous();
    144100    }
    145101
    … …  
    150106     */
    151107    public boolean isPartiallyIdentified() {
    152         return userName != null && userInfo == null;
     108        return UserIdentityManager.getInstance().isPartiallyIdentified();
    153109    }
    154110
    … …  
    159115     */
    160116    public boolean isFullyIdentified() {
    161         return userName != null && userInfo != null;
     117        return UserIdentityManager.getInstance().isFullyIdentified();
    162118    }
    163119
    … …  
    168124     */
    169125    public String getUserName() {
    170         return userName;
     126        return UserIdentityManager.getInstance().getUserName();
    171127    }
    172128
    … …  
    178134     */
    179135    public int getUserId() {
    180         if (userInfo == null) return 0;
    181         return userInfo.getId();
     136        return UserIdentityManager.getInstance().getUserId();
    182137    }
    183138
    … …  
    189144     */
    190145    public UserInfo getUserInfo() {
    191         return userInfo;
     146        return UserIdentityManager.getInstance().getUserInfo();
    192147    }
    193148
    … …  
    198153     */
    199154    public User asUser() {
    200         return isAnonymous() ? User.getAnonymous() : User.createOsmUser(userInfo != null ? userInfo.getId() : 0, userName);
     155        return UserIdentityManager.getInstance().asUser();
    201156    }
    202157
    … …  
    207162     */
    208163    public void initFromPreferences() {
    209         String userName = CredentialsManager.getInstance().getUsername();
    210         if (isAnonymous()) {
    211             if (userName != null && !userName.trim().isEmpty()) {
    212                 setPartiallyIdentified(userName);
    213             }
    214         } else {
    215             if (userName != null && !userName.equals(this.userName)) {
    216                 setPartiallyIdentified(userName);
    217             }
    218             // else: same name in the preferences as JOSM already knows about.
    219             // keep the state, be it partially or fully identified
    220         }
     164        UserIdentityManager.getInstance().initFromPreferences();
    221165    }
    222166
    … …  
    228172     */
    229173    public void initFromOAuth() {
    230         try {
    231             UserInfo info = new OsmServerUserInfoReader().fetchUserInfo(NullProgressMonitor.INSTANCE);
    232             setFullyIdentified(info.getDisplayName(), info);
    233         } catch (IllegalArgumentException | OsmTransferException e) {
    234             Logging.error(e);
    235         }
     174        UserIdentityManager.getInstance().initFromOAuth();
    236175    }
    237176
    … …  
    243182     */
    244183    public boolean isCurrentUser(String username) {
    245         return this.userName != null && this.userName.equals(username);
     184        return UserIdentityManager.getInstance().isCurrentUser(username);
    246185    }
    247186
    248187    /**
    249188     * Replies true if the current user is {@link #isFullyIdentified() fully identified} and the {@link #getUserId() user ids} match,
    250      * or if the current user is not {@link #isFullyIdentified() fully identified} and the {@link #userName user names} match.
     189     * or if the current user is not {@link #isFullyIdentified() fully identified} and the {@link #getUserName() user names} match.
    251190     *
    252191     * @param user the user to test
    … …  
    254193     */
    255194    public boolean isCurrentUser(User user) {
    256         if (user == null) {
    257             return false;
    258         } else if (isFullyIdentified()) {
    259             return getUserId() == user.getId();
    260         } else {
    261             return isCurrentUser(user.getName());
    262         }
    263     }
    264 
    265     /* ------------------------------------------------------------------- */
    266     /* interface PreferenceChangeListener                                  */
    267     /* ------------------------------------------------------------------- */
    268     @Override
    269     public void preferenceChanged(PreferenceChangeEvent evt) {
    270         switch (evt.getKey()) {
    271         case "osm-server.username":
    272             String newUserName = null;
    273             if (evt.getNewValue() instanceof StringSetting) {
    274                 newUserName = ((StringSetting) evt.getNewValue()).getValue();
    275             }
    276             if (newUserName == null || newUserName.trim().isEmpty()) {
    277                 setAnonymous();
    278             } else {
    279                 if (!newUserName.equals(userName)) {
    280                     setPartiallyIdentified(newUserName);
    281                 }
    282             }
    283             return;
    284         case "osm-server.url":
    285             String newUrl = null;
    286             if (evt.getNewValue() instanceof StringSetting) {
    287                 newUrl = ((StringSetting) evt.getNewValue()).getValue();
    288             }
    289             if (newUrl == null || newUrl.trim().isEmpty()) {
    290                 setAnonymous();
    291             } else if (isFullyIdentified()) {
    292                 setPartiallyIdentified(getUserName());
    293             }
    294             break;
    295         case "oauth.access-token.key":
    296             accessTokenKeyChanged = true;
    297             break;
    298         case "oauth.access-token.secret":
    299             accessTokenSecretChanged = true;
    300             break;
    301         default: // Do nothing
    302         }
    303 
    304         if (accessTokenKeyChanged && accessTokenSecretChanged) {
    305             accessTokenKeyChanged = false;
    306             accessTokenSecretChanged = false;
    307             if (OsmApi.isUsingOAuth()) {
    308                 getInstance().initFromOAuth();
    309             }
    310         }
     195        return UserIdentityManager.getInstance().isCurrentUser(user);
    311196    }
    312197}

  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetCacheManager.java

    r12678 r12743  
    4747import org.openstreetmap.josm.actions.downloadtasks.ChangesetQueryTask;
    4848import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler;
     49import org.openstreetmap.josm.data.UserIdentityManager;
    4950import org.openstreetmap.josm.data.osm.Changeset;
    5051import org.openstreetmap.josm.data.osm.ChangesetCache;
    … …  
    5354import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
    5455import org.openstreetmap.josm.gui.HelpAwareOptionPane;
    55 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    5656import org.openstreetmap.josm.gui.MainApplication;
    5757import org.openstreetmap.josm.gui.dialogs.changeset.query.ChangesetQueryDialog;
    … …  
    465465        protected void updateEnabledState() {
    466466            List<Changeset> selected = model.getSelectedChangesets();
    467             JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     467            UserIdentityManager im = UserIdentityManager.getInstance();
    468468            for (Changeset cs: selected) {
    469469                if (cs.isOpen()) {

  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/BasicChangesetQueryPanel.java

    r12630 r12743  
    2121import org.openstreetmap.josm.Main;
    2222import org.openstreetmap.josm.data.Bounds;
    23 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
     23import org.openstreetmap.josm.data.UserIdentityManager;
    2424import org.openstreetmap.josm.gui.MainApplication;
    2525import org.openstreetmap.josm.gui.MapView;
    … …  
    158158        // partially identified
    159159        lbl = lblQueries.get(BasicQuery.MY_OPEN_CHANGESETS);
    160         if (JosmUserIdentityManager.getInstance().isAnonymous()) {
     160        if (UserIdentityManager.getInstance().isAnonymous()) {
    161161            rbQueries.get(BasicQuery.MY_OPEN_CHANGESETS).setEnabled(false);
    162162            lbl.setText(tr("<html>Download my open changesets<br><em>Disabled. " +
    … …  
    232232        BasicQuery q = getSelectedQuery();
    233233        ChangesetQuery query = new ChangesetQuery();
    234         JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     234        UserIdentityManager im = UserIdentityManager.getInstance();
    235235        if (q == null)
    236236            return query;

  • trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/UserRestrictionPanel.java

    r11330 r12743  
    1919
    2020import org.openstreetmap.josm.Main;
     21import org.openstreetmap.josm.data.UserIdentityManager;
    2122import org.openstreetmap.josm.gui.HelpAwareOptionPane;
    22 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    2323import org.openstreetmap.josm.gui.help.HelpUtil;
    2424import org.openstreetmap.josm.gui.preferences.server.UserNameValidator;
    … …  
    163163     */
    164164    public void startUserInput() {
    165         if (JosmUserIdentityManager.getInstance().isAnonymous()) {
     165        if (UserIdentityManager.getInstance().isAnonymous()) {
    166166            lblRestrictedToMyself.setText(tr("Only changesets owned by myself (disabled. JOSM is currently run by an anonymous user)"));
    167167            rbRestrictToMyself.setEnabled(false);
    … …  
    188188        CheckParameterUtil.ensureParameterNotNull(query, "query");
    189189        if (rbRestrictToMyself.isSelected()) {
    190             JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     190            UserIdentityManager im = UserIdentityManager.getInstance();
    191191            if (im.isPartiallyIdentified()) {
    192192                query.forUser(im.getUserName());
    … …  
    277277        String v = Main.pref.get(PREF_QUERY_TYPE, "mine");
    278278        if ("mine".equals(v)) {
    279             JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     279            UserIdentityManager im = UserIdentityManager.getInstance();
    280280            if (im.isAnonymous()) {
    281281                rbRestrictToUid.setSelected(true);

  • trunk/src/org/openstreetmap/josm/gui/download/BookmarkList.java

    r12634 r12743  
    2626import org.openstreetmap.josm.actions.downloadtasks.ChangesetQueryTask;
    2727import org.openstreetmap.josm.data.Bounds;
     28import org.openstreetmap.josm.data.UserIdentityManager;
    2829import org.openstreetmap.josm.data.coor.LatLon;
    2930import org.openstreetmap.josm.data.osm.Changeset;
    … …  
    3233import org.openstreetmap.josm.data.projection.Projection;
    3334import org.openstreetmap.josm.data.projection.Projections;
    34 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    3535import org.openstreetmap.josm.gui.MainApplication;
    3636import org.openstreetmap.josm.gui.MapViewState;
    … …  
    193193            setName(tr("Home location"));
    194194            setIcon(ImageProvider.get("help", "home", ImageSizes.SMALLICON));
    195             UserInfo info = JosmUserIdentityManager.getInstance().getUserInfo();
     195            UserInfo info = UserIdentityManager.getInstance().getUserInfo();
    196196            if (info == null) {
    197197                throw new IllegalStateException("User not identified");
    … …  
    251251        final DefaultListModel<Bookmark> model = (DefaultListModel<Bookmark>) getModel();
    252252        model.removeAllElements();
    253         JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     253        UserIdentityManager im = UserIdentityManager.getInstance();
    254254        // Add home location bookmark first, if user fully identified
    255255        if (im.isFullyIdentified()) {

  • trunk/src/org/openstreetmap/josm/gui/download/BookmarkSelection.java

    r12495 r12743  
    2424import org.openstreetmap.josm.Main;
    2525import org.openstreetmap.josm.data.Bounds;
    26 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
     26import org.openstreetmap.josm.data.UserIdentityManager;
    2727import org.openstreetmap.josm.gui.download.BookmarkList.Bookmark;
    2828import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
    … …  
    290290            putValue(SMALL_ICON, ImageProvider.get("dialogs/changeset", "downloadchangeset"));
    291291            putValue(SHORT_DESCRIPTION, tr("Download bookmarks for my {0} last changesets", BookmarkList.MAX_CHANGESET_BOOKMARKS.get()));
    292             setEnabled(!JosmUserIdentityManager.getInstance().isAnonymous());
     292            setEnabled(!UserIdentityManager.getInstance().isAnonymous());
    293293        }
    294294

  • trunk/src/org/openstreetmap/josm/gui/history/HistoryBrowserModel.java

    r12636 r12743  
    1111
    1212import org.openstreetmap.josm.Main;
     13import org.openstreetmap.josm.data.UserIdentityManager;
    1314import org.openstreetmap.josm.data.osm.Node;
    1415import org.openstreetmap.josm.data.osm.OsmPrimitive;
    … …  
    3536import org.openstreetmap.josm.data.osm.history.HistoryWay;
    3637import org.openstreetmap.josm.data.osm.visitor.AbstractVisitor;
    37 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    3838import org.openstreetmap.josm.gui.MainApplication;
    3939import org.openstreetmap.josm.gui.layer.Layer;
    … …  
    674674
    675675        private static User getCurrentUser() {
    676             UserInfo info = JosmUserIdentityManager.getInstance().getUserInfo();
     676            UserInfo info = UserIdentityManager.getInstance().getUserInfo();
    677677            return info == null ? User.getAnonymous() : User.createOsmUser(info.getId(), info.getDisplayName());
    678678        }

  • trunk/src/org/openstreetmap/josm/gui/history/VersionInfoPanel.java

    r12636 r12743  
    2525
    2626import org.openstreetmap.josm.Main;
     27import org.openstreetmap.josm.data.UserIdentityManager;
    2728import org.openstreetmap.josm.data.osm.Changeset;
    2829import org.openstreetmap.josm.data.osm.OsmPrimitive;
    2930import org.openstreetmap.josm.data.osm.User;
    3031import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
    31 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    3232import org.openstreetmap.josm.gui.MainApplication;
    3333import org.openstreetmap.josm.gui.dialogs.ChangesetDialog;
    … …  
    256256            }
    257257        } else {
    258             String username = JosmUserIdentityManager.getInstance().getUserName();
     258            String username = UserIdentityManager.getInstance().getUserName();
    259259            if (username == null) {
    260260                lblUser.setDescription(tr("anonymous"));

  • trunk/src/org/openstreetmap/josm/gui/io/DownloadOpenChangesetsTask.java

    r12620 r12743  
    1414
    1515import org.openstreetmap.josm.Main;
     16import org.openstreetmap.josm.data.UserIdentityManager;
    1617import org.openstreetmap.josm.data.osm.Changeset;
    1718import org.openstreetmap.josm.data.osm.ChangesetCache;
    1819import org.openstreetmap.josm.data.osm.UserInfo;
    1920import org.openstreetmap.josm.gui.ExceptionDialogUtil;
    20 import org.openstreetmap.josm.gui.JosmUserIdentityManager;
    2121import org.openstreetmap.josm.gui.PleaseWaitRunnable;
    2222import org.openstreetmap.josm.gui.util.GuiHelper;
    … …  
    6161    @Override
    6262    protected void finish() {
    63         if (JosmUserIdentityManager.getInstance().isAnonymous()) {
     63        if (UserIdentityManager.getInstance().isAnonymous()) {
    6464            String msg = tr("Could not retrieve the list of your open changesets because<br>"
    6565                    + "JOSM does not know your identity.<br>"
    … …  
    9696     */
    9797    protected void refreshUserIdentity() {
    98         JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     98        UserIdentityManager im = UserIdentityManager.getInstance();
    9999        try {
    100100            OsmServerUserInfoReader infoReader = new OsmServerUserInfoReader();
    … …  
    122122    protected void realRun() throws SAXException, IOException, OsmTransferException {
    123123        try {
    124             JosmUserIdentityManager im = JosmUserIdentityManager.getInstance();
     124            UserIdentityManager im = UserIdentityManager.getInstance();
    125125            if (im.isAnonymous()) {
    126126                refreshUserIdentity();
Note: See TracChangeset for help on using the changeset viewer.