summaryrefslogtreecommitdiffstats
path: root/api/logic/minecraft/auth/MojangAccount.h
blob: 7006435e6595c6ade54aab89370304105873ac42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/* Copyright 2013-2019 MultiMC Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <QObject>
#include <QString>
#include <QList>
#include <QJsonObject>
#include <QPair>
#include <QMap>

#include <memory>
#include "AuthSession.h"
#include "Usable.h"

#include "multimc_logic_export.h"

class Task;
class YggdrasilTask;
class MojangAccount;

typedef std::shared_ptr<MojangAccount> MojangAccountPtr;
Q_DECLARE_METATYPE(MojangAccountPtr)

/**
 * A profile within someone's Mojang account.
 *
 * Currently, the profile system has not been implemented by Mojang yet,
 * but we might as well add some things for it in MultiMC right now so
 * we don't have to rip the code to pieces to add it later.
 */
struct AccountProfile
{
    QString id;
    QString name;
    bool legacy;
};

enum AccountStatus
{
    NotVerified,
    Verified
};

/**
 * Object that stores information about a certain Mojang account.
 *
 * Said information may include things such as that account's username, client token, and access
 * token if the user chose to stay logged in.
 */
class MULTIMC_LOGIC_EXPORT MojangAccount :
    public QObject,
    public Usable,
    public std::enable_shared_from_this<MojangAccount>
{
    Q_OBJECT
public: /* construction */
    //! Do not copy accounts. ever.
    explicit MojangAccount(const MojangAccount &other, QObject *parent) = delete;

    //! Default constructor
    explicit MojangAccount(QObject *parent = 0) : QObject(parent) {};

    //! Creates an empty account for the specified user name.
    static MojangAccountPtr createFromUsername(const QString &username);

    //! Loads a MojangAccount from the given JSON object.
    static MojangAccountPtr loadFromJson(const QJsonObject &json);

    //! Saves a MojangAccount to a JSON object and returns it.
    QJsonObject saveToJson() const;

public: /* manipulation */
        /**
     * Sets the currently selected profile to the profile with the given ID string.
     * If profileId is not in the list of available profiles, the function will simply return
     * false.
     */
    bool setCurrentProfile(const QString &profileId);

    /**
     * Attempt to login. Empty password means we use the token.
     * If the attempt fails because we already are performing some task, it returns false.
     */
    std::shared_ptr<YggdrasilTask> login(AuthSessionPtr session, QString password = QString());
    void invalidateClientToken();

public: /* queries */
    const QString &username() const
    {
        return m_username;
    }

    const QString &clientToken() const
    {
        return m_clientToken;
    }

    const QString &accessToken() const
    {
        return m_accessToken;
    }

    const QList<AccountProfile> &profiles() const
    {
        return m_profiles;
    }

    const User &user()
    {
        return m_user;
    }

    //! Returns the currently selected profile (if none, returns nullptr)
    const AccountProfile *currentProfile() const;

    //! Returns whether the account is NotVerified, Verified or Online
    AccountStatus accountStatus() const;

signals:
    /**
     * This signal is emitted when the account changes
     */
    void changed();

    // TODO: better signalling for the various possible state changes - especially errors

protected: /* variables */
    QString m_username;

    // Used to identify the client - the user can have multiple clients for the same account
    // Think: different launchers, all connecting to the same account/profile
    QString m_clientToken;

    // Blank if not logged in.
    QString m_accessToken;

    // Index of the selected profile within the list of available
    // profiles. -1 if nothing is selected.
    int m_currentProfile = -1;

    // List of available profiles.
    QList<AccountProfile> m_profiles;

    // the user structure, whatever it is.
    User m_user;

    // current task we are executing here
    std::shared_ptr<YggdrasilTask> m_currentTask;

protected: /* methods */

    void incrementUses() override;
    void decrementUses() override;

private
slots:
    void authSucceeded();
    void authFailed(QString reason);

private:
    void fillSession(AuthSessionPtr session);

public:
    friend class YggdrasilTask;
    friend class AuthenticateTask;
    friend class ValidateTask;
    friend class RefreshTask;
};