sneedmc/launcher/minecraft/auth/MinecraftAccount.h

234 lines
5.9 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 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>
2013-11-18 18:58:03 +00:00
#include <QJsonObject>
#include <QPair>
#include <QMap>
#include <QPixmap>
#include <memory>
#include "AuthSession.h"
#include "Usable.h"
#include "AccountData.h"
2021-11-20 15:22:22 +00:00
#include "QObjectPtr.h"
class Task;
class AccountTask;
class MinecraftAccount;
2013-11-18 18:58:03 +00:00
2021-11-20 15:22:22 +00:00
typedef shared_qobject_ptr<MinecraftAccount> MinecraftAccountPtr;
Q_DECLARE_METATYPE(MinecraftAccountPtr)
2013-11-18 18:58:03 +00:00
/**
* 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 PolyMC right now so
* we don't have to rip the code to pieces to add it later.
*/
struct AccountProfile
{
2018-07-15 12:51:05 +00:00
QString id;
QString name;
bool legacy;
};
/**
* 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 MinecraftAccount :
2018-07-15 12:51:05 +00:00
public QObject,
2021-11-20 15:22:22 +00:00
public Usable
{
2018-07-15 12:51:05 +00:00
Q_OBJECT
public: /* construction */
2018-07-15 12:51:05 +00:00
//! Do not copy accounts. ever.
explicit MinecraftAccount(const MinecraftAccount &other, QObject *parent) = delete;
2018-07-15 12:51:05 +00:00
//! Default constructor
explicit MinecraftAccount(QObject *parent = 0);
static MinecraftAccountPtr createFromUsername(const QString &username);
static MinecraftAccountPtr createBlankMSA();
2013-11-18 18:58:03 +00:00
2022-01-17 11:08:10 +00:00
static MinecraftAccountPtr createOffline(const QString &username);
static MinecraftAccountPtr loadFromJsonV2(const QJsonObject &json);
static MinecraftAccountPtr loadFromJsonV3(const QJsonObject &json);
//! Saves a MinecraftAccount to a JSON object and returns it.
2018-07-15 12:51:05 +00:00
QJsonObject saveToJson() const;
2013-11-18 18:58:03 +00:00
public: /* manipulation */
2018-07-15 12:51:05 +00:00
/**
* Attempt to login. Empty password means we use the token.
* If the attempt fails because we already are performing some task, it returns false.
*/
shared_qobject_ptr<AccountTask> login(QString password);
shared_qobject_ptr<AccountTask> loginMSA();
2022-01-17 11:08:10 +00:00
shared_qobject_ptr<AccountTask> loginOffline();
shared_qobject_ptr<AccountTask> refresh();
shared_qobject_ptr<AccountTask> currentTask();
public: /* queries */
QString internalId() const {
return data.internalId;
}
QString accountDisplayString() const {
return data.accountDisplayString();
2018-07-15 12:51:05 +00:00
}
QString mojangUserName() const {
return data.userName();
2018-07-15 12:51:05 +00:00
}
QString accessToken() const {
return data.accessToken();
2018-07-15 12:51:05 +00:00
}
QString profileId() const {
return data.profileId();
2018-07-15 12:51:05 +00:00
}
QString profileName() const {
return data.profileName();
2018-07-15 12:51:05 +00:00
}
2013-12-14 00:18:54 +00:00
2021-11-20 15:22:22 +00:00
bool isActive() const;
bool canMigrate() const {
return data.canMigrateToMSA;
}
bool isMSA() const {
return data.type == AccountType::MSA;
}
2022-01-17 11:08:10 +00:00
bool isOffline() const {
return data.type == AccountType::Offline;
}
bool ownsMinecraft() const {
return data.minecraftEntitlement.ownsMinecraft;
}
bool hasProfile() const {
return data.profileId().size() != 0;
}
QString typeString() const {
switch(data.type) {
case AccountType::Mojang: {
if(data.legacy) {
return "legacy";
}
return "mojang";
}
break;
case AccountType::MSA: {
return "msa";
}
break;
2022-01-17 11:08:10 +00:00
case AccountType::Offline: {
return "offline";
}
break;
default: {
return "unknown";
}
}
}
QPixmap getFace() const;
//! Returns the current state of the account
AccountState accountState() const;
AccountData * accountData() {
return &data;
}
2021-11-20 15:22:22 +00:00
bool shouldRefresh() const;
void fillSession(AuthSessionPtr session);
2021-12-08 00:22:57 +00:00
QString lastError() const {
return data.lastError();
}
signals:
2018-07-15 12:51:05 +00:00
/**
* This signal is emitted when the account changes
*/
void changed();
2021-11-20 15:22:22 +00:00
void activityChanged(bool active);
2018-07-15 12:51:05 +00:00
// TODO: better signalling for the various possible state changes - especially errors
protected: /* variables */
AccountData data;
2018-07-15 12:51:05 +00:00
// current task we are executing here
2021-11-20 15:22:22 +00:00
shared_qobject_ptr<AccountTask> m_currentTask;
protected: /* methods */
2018-07-15 12:51:05 +00:00
void incrementUses() override;
void decrementUses() override;
private
slots:
2018-07-15 12:51:05 +00:00
void authSucceeded();
void authFailed(QString reason);
};