PlayerProfile.h

/*
 * Copyright (C) 2014 Google Inc.
 *
 * 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.
 */

#ifndef PLAYERPROFILE_H
#define PLAYERPROFILE_H

#include <QJsonArray>
#include <QJsonDocument>
#include <QMap>
#include <QObject>
#include <QSet>
#include <QSharedPointer>

class Achievement;
class Environment;
class LevelInfo;
class LevelProgression;
class LevelProgressionList;

class PlayerProfile : public QObject {
    Q_OBJECT
public:
    enum LoadState {
        UNLOADED,
        LOADING,
        LOADED
    };

    LoadState getLoadState() const { return mLoadState; }
    LevelInfo* getLastPlayedLevelInfo(const QString& progressionName) const;
    bool isEnvironmentUnlocked(const QString& progressionName,
            const QString& environmentName) const;
    bool isLevelUnlocked(const QString& progressionName, const QString& levelName) const;
    int getCurrentPlayerScore(int playerId = 0) const;
    const QMap<int, int>& getCurrentPlayerScores() const { return mCurrentScores; }
    int updatePlayerScore(int playerId, int amountChanged);
    int getNumStars(const QString& progressionName, const QString& levelName) const;
    bool hasMinStars(const QString& progressionName, int minStars) const;
    bool hasMinStars(const QString& progressionName, const QString& environmentName,
            int minStars) const;

    void unlockAchievement(const QString& name, bool immediately);
    void incrementAchievement(const QString& name, int numSteps, bool immediately);
    void setAchievementSteps(const QString& name, int minSteps, bool immediately);
    void revealAchievement(const QString& name, bool immediately);
    void showAchievements();

    void startLoad();
    bool tryFinishLoad();
    void save();
    void saveAchievementsToCloud();
    void reset(bool permanently);

    bool hasCloudSave() const;
    bool isSignedIntoCloud() const;
    bool cloudSignInFailed() const;
    void signIntoCloud();
    void signOutOfCloud();

    QJsonDocument toJsonDocument();

signals:
    void newDataMerged();

private slots:
    void onCloudDataLoaded(int statusCode, const QString& data);
    QString onCloudDataConflict(const QString& localData, const QString& serverData);
    void onCurrentLevelAbandoned();
    bool onCurrentLevelCompleted(const QString& progressionName, int numStars = -1);
    void onLevelSelected(const QString& progressionName, const QString& levelName,
            bool forceUnlock);

private:
    enum CloudLoadStatus {
        STATUS_OK = 0x0,
        STATUS_INTERNAL_ERROR = 0x01,
        STATUS_CLIENT_RECONNECT_REQUIRED = 0x02,
        STATUS_NETWORK_ERROR_STALE_DATA = 0x03,
        STATUS_NETWORK_ERROR_NO_DATA = 0x04,
        STATUS_NETWORK_ERROR_OPERATION_DEFERRED = 0x05,
        STATUS_NETWORK_ERROR_OPERATION_FAILED = 0x06,
        STATUS_DEVELOPER_ERROR = 0x07,
        STATUS_WRITE_OUT_OF_DATE_VERSION = 0x7d0,
        STATUS_WRITE_SIZE_EXCEEDED = 0x7d1,
        STATUS_STATE_KEY_NOT_FOUND = 0x7d2,
        STATUS_STATE_KEY_LIMIT_EXCEEDED = 0x7d3,
    };

    // This class is exclusively a helper for Game, and can only be construted by it.
    friend class Game;

    explicit PlayerProfile(QObject* parent = nullptr);
    PlayerProfile(const QJsonDocument& doc, const LevelProgressionList* progressionList);

    void setLevelProgressionList(const LevelProgressionList* value);
    void init();
    void merge(const PlayerProfile& other);
    int getValidPlayerStarScore(int starScore) const;
    bool startLoadFromCloud();
    bool tryFinishLoadFromCloud();
    void loadFromLocal();
    void saveToCloud();
    void saveToLocal();
    void clearCloud();
    void clearLocal();
    void clearAchievements();
    QJsonArray getAchievementsAsJsonArray() const;
    QSharedPointer<Achievement>& getAchievement(const QString& name);

    LoadState mLoadState = UNLOADED;
    bool mHasCloudData = false;

    const LevelProgressionList* mLevelProgressionList = nullptr;

    QMap<QString, QString> mLastPlayedLevels;
    QMap<QString, QSet<QString>> mUnlockedLevels;
    QMap<int, int> mCurrentScores;
    QMap<QString, QMap<QString, int>> mNumStars;
    // Achievement updates / actions.
    // NOTE: Using a QSharedPointer because regular smart pointers do not work in Qt Containers
    QMap<QString, QSharedPointer<Achievement> > mAchievements;
};
Q_DECLARE_METATYPE(PlayerProfile*)

#endif // PLAYERPROFILE_H