cdnutter
/
pokerogue
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Implement client session and re-implement hybrid saving (#888) 

* Implement client session and re-implement hybrid saving (WiP)

* Fixes for hybrid saving

* Add local data clears where applicable

* Include client session ID in system update

* Change save threshold from 5 waves to 10 waves or 5 minutes
pull/895/head
Samuel H 2024-05-15 00:52:06 -04:00 committed by GitHub
parent 835b00d457
commit 67c18a15e2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 231 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/account.ts
View File

@ -7,13 +7,14 @@ export interface UserInfo {
}
export let loggedInUser: UserInfo = null;
export const clientSessionId = Utils.randomString(32);
export function updateUserInfo(): Promise<[boolean, integer]> {
return new Promise<[boolean, integer]>(resolve => {
if (bypassLogin) {
let lastSessionSlot = -1;
for (let s = 0; s < 2; s++) {
if (localStorage.getItem(`sessionData${s ? s : ''}`)) {
if (localStorage.getItem(`sessionData${s ? s : ''}_${loggedInUser.username}`)) {
lastSessionSlot = s;
break;
}

5
src/battle-scene.ts
View File

@ -88,6 +88,7 @@ export default class BattleScene extends SceneBase {
public uiInputs: UiInputs;
public sessionPlayTime: integer = null;
public lastSavePlayTime: integer = null;
public masterVolume: number = 0.5;
public bgmVolume: number = 1;
public seVolume: number = 1;
@ -452,6 +453,8 @@ export default class BattleScene extends SceneBase {
initSession(): void {
if (this.sessionPlayTime === null)
this.sessionPlayTime = 0;
if (this.lastSavePlayTime === null)
this.lastSavePlayTime = 0;
if (this.playTimeTimer)
this.playTimeTimer.destroy();
@ -464,6 +467,8 @@ export default class BattleScene extends SceneBase {
this.gameData.gameStats.playTime++;
if (this.sessionPlayTime !== null)
this.sessionPlayTime++;
if (this.lastSavePlayTime !== null)
this.lastSavePlayTime++;
}
});

16
src/phases.ts
View File

@ -330,6 +330,7 @@ export class TitlePhase extends Phase {
this.scene.newBattle();
this.scene.arena.init();
this.scene.sessionPlayTime = 0;
this.scene.lastSavePlayTime = 0;
this.end();
});
};
@ -393,8 +394,12 @@ export class UnavailablePhase extends Phase {
}
export class ReloadSessionPhase extends Phase {
constructor(scene: BattleScene) {
private systemDataStr: string;
constructor(scene: BattleScene, systemDataStr?: string) {
super(scene);
this.systemDataStr = systemDataStr;
}
start(): void {
@ -410,7 +415,9 @@ export class ReloadSessionPhase extends Phase {
delayElapsed = true;
});
this.scene.gameData.loadSystem().then(() => {
this.scene.gameData.clearLocalData();
(this.systemDataStr ? this.scene.gameData.initSystem(this.systemDataStr) : this.scene.gameData.loadSystem()).then(() => {
if (delayElapsed)
this.end();
else
@ -531,6 +538,7 @@ export class SelectStarterPhase extends Phase {
this.scene.newBattle();
this.scene.arena.init();
this.scene.sessionPlayTime = 0;
this.scene.lastSavePlayTime = 0;
this.end();
});
});
@ -784,7 +792,7 @@ export class EncounterPhase extends BattlePhase {
this.scene.ui.setMode(Mode.MESSAGE).then(() => {
if (!this.loaded) {
this.scene.gameData.saveAll(this.scene, true).then(success => {
this.scene.gameData.saveAll(this.scene, true, battle.waveIndex % 10 === 1 || this.scene.lastSavePlayTime >= 10).then(success => {
this.scene.disableMenu = false;
if (!success)
return this.scene.reset(true);
@ -3692,7 +3700,7 @@ export class PostGameOverPhase extends Phase {
start() {
super.start();
this.scene.gameData.saveSystem().then(success => {
this.scene.gameData.saveAll(this.scene, true, true, true).then(success => {
if (!success)
return this.scene.reset(true);
this.scene.gameData.tryClearSession(this.scene, this.scene.sessionSlotId).then((success: boolean | [boolean, boolean]) => {

217
src/system/game-data.ts
View File

@ -20,7 +20,7 @@ import { Egg } from "../data/egg";
import { VoucherType, vouchers } from "./voucher";
import { AES, enc } from "crypto-js";
import { Mode } from "../ui/ui";
import { loggedInUser, updateUserInfo } from "../account";
import { clientSessionId, loggedInUser, updateUserInfo } from "../account";
import { Nature } from "../data/nature";
import { GameStats } from "./game-stats";
import { Tutorial } from "../tutorial";
@ -67,6 +67,18 @@ export function getDataTypeKey(dataType: GameDataType, slotId: integer = 0): str
}
}
function encrypt(data: string, bypassLogin: boolean): string {
return (bypassLogin
? (data: string) => btoa(data)
: (data: string) => AES.encrypt(data, saveKey))(data);
}
function decrypt(data: string, bypassLogin: boolean): string {
return (bypassLogin
? (data: string) => atob(data)
: (data: string) => AES.decrypt(data, saveKey).toString(enc.Utf8))(data);
}
interface SystemSaveData {
trainerId: integer;
secretId: integer;
@ -277,8 +289,10 @@ export class GameData {
const maxIntAttrValue = Math.pow(2, 31);
const systemData = JSON.stringify(data, (k: any, v: any) => typeof v === 'bigint' ? v <= maxIntAttrValue ? Number(v) : v.toString() : v);
localStorage.setItem(`data_${loggedInUser.username}`, encrypt(systemData, bypassLogin));
if (!bypassLogin) {
Utils.apiPost(`savedata/update?datatype=${GameDataType.SYSTEM}`, systemData, undefined, true)
Utils.apiPost(`savedata/update?datatype=${GameDataType.SYSTEM}&clientSessionId=${clientSessionId}`, systemData, undefined, true)
.then(response => response.text())
.then(error => {
this.scene.ui.savingIcon.hide();
@ -296,10 +310,6 @@ export class GameData {
resolve(true);
});
} else {
localStorage.setItem('data_bak', localStorage.getItem('data'));
localStorage.setItem('data', btoa(systemData));
this.scene.ui.savingIcon.hide();
resolve(true);
@ -309,12 +319,49 @@ export class GameData {
public loadSystem(): Promise<boolean> {
return new Promise<boolean>(resolve => {
if (bypassLogin && !localStorage.hasOwnProperty('data'))
console.log('Client Session:', clientSessionId);
if (bypassLogin && !localStorage.getItem(`data_${loggedInUser.username}`))
return resolve(false);
const handleSystemData = (systemDataStr: string) => {
if (!bypassLogin) {
Utils.apiFetch(`savedata/system?clientSessionId=${clientSessionId}`, true)
.then(response => response.text())
.then(response => {
if (!response.length || response[0] !== '{') {
if (response.startsWith('sql: no rows in result set')) {
this.scene.queueMessage('Save data could not be found. If this is a new account, you can safely ignore this message.', null, true);
return resolve(true);
} else if (response.indexOf('Too many connections') > -1) {
this.scene.queueMessage('Too many people are trying to connect and the server is overloaded. Please try again later.', null, true);
return resolve(false);
}
console.error(response);
return resolve(false);
}
const cachedSystem = localStorage.getItem(`data_${loggedInUser.username}`);
this.initSystem(response, cachedSystem ? AES.decrypt(cachedSystem, saveKey).toString(enc.Utf8) : null).then(resolve);
});
} else
this.initSystem(decrypt(localStorage.getItem(`data_${loggedInUser.username}`), bypassLogin)).then(resolve);
});
}
public initSystem(systemDataStr: string, cachedSystemDataStr?: string): Promise<boolean> {
return new Promise<boolean>(resolve => {
try {
const systemData = this.parseSystemData(systemDataStr);
let systemData = this.parseSystemData(systemDataStr);
if (cachedSystemDataStr) {
let cachedSystemData = this.parseSystemData(cachedSystemDataStr);
console.log(cachedSystemData.timestamp, systemData.timestamp)
if (cachedSystemData.timestamp > systemData.timestamp) {
console.debug('Use cached system');
systemData = cachedSystemData;
} else
this.clearLocalData();
}
console.debug(systemData);
@ -419,28 +466,6 @@ export class GameData {
console.error(err);
resolve(false);
}
}
if (!bypassLogin) {
Utils.apiFetch(`savedata/get?datatype=${GameDataType.SYSTEM}`, true)
.then(response => response.text())
.then(response => {
if (!response.length || response[0] !== '{') {
if (response.startsWith('sql: no rows in result set')) {
this.scene.queueMessage('Save data could not be found. If this is a new account, you can safely ignore this message.', null, true);
return resolve(true);
} else if (response.indexOf('Too many connections') > -1) {
this.scene.queueMessage('Too many people are trying to connect and the server is overloaded. Please try again later.', null, true);
return resolve(false);
}
console.error(response);
return resolve(false);
}
handleSystemData(response);
});
} else
handleSystemData(atob(localStorage.getItem('data')));
});
}
@ -474,6 +499,29 @@ export class GameData {
return dataStr;
}
public async verify(): Promise<boolean> {
if (bypassLogin)
return true;
const response = await Utils.apiPost(`savedata/system/verify`, JSON.stringify({ clientSessionId: clientSessionId }), undefined, true)
.then(response => response.json());
if (!response.valid) {
this.scene.clearPhaseQueue();
this.scene.unshiftPhase(new ReloadSessionPhase(this.scene, JSON.stringify(response.systemData)));
this.clearLocalData();
return false;
}
return true;
}
public clearLocalData(): void {
localStorage.removeItem(`data_${loggedInUser.username}`);
for (let s = 0; s < 5; s++)
localStorage.removeItem(`sessionData${s ? s : ''}_${loggedInUser.username}`);
}
public saveSetting(setting: Setting, valueIndex: integer): boolean {
let settings: object = {};
if (localStorage.hasOwnProperty('settings'))
@ -557,40 +605,6 @@ export class GameData {
} as SessionSaveData;
}
saveSession(scene: BattleScene, skipVerification?: boolean): Promise<boolean> {
return new Promise<boolean>(resolve => {
Utils.executeIf(!skipVerification, updateUserInfo).then(success => {
if (success !== null && !success)
return resolve(false);
const sessionData = this.getSessionSaveData(scene);
if (!bypassLogin) {
Utils.apiPost(`savedata/update?datatype=${GameDataType.SESSION}&slot=${scene.sessionSlotId}&trainerId=${this.trainerId}&secretId=${this.secretId}`, JSON.stringify(sessionData), undefined, true)
.then(response => response.text())
.then(error => {
if (error) {
if (error.startsWith('session out of date')) {
this.scene.clearPhaseQueue();
this.scene.unshiftPhase(new ReloadSessionPhase(this.scene));
}
console.error(error);
return resolve(false);
}
console.debug('Session data saved');
resolve(true);
});
} else {
localStorage.setItem(`sessionData${scene.sessionSlotId ? scene.sessionSlotId : ''}`, btoa(JSON.stringify(sessionData)));
console.debug('Session data saved');
resolve(true);
}
});
});
}
getSession(slotId: integer): Promise<SessionSaveData> {
return new Promise(async (resolve, reject) => {
if (slotId < 0)
@ -605,8 +619,8 @@ export class GameData {
}
};
if (!bypassLogin) {
Utils.apiFetch(`savedata/get?datatype=${GameDataType.SESSION}&slot=${slotId}`, true)
if (!bypassLogin && !localStorage.getItem(`sessionData${slotId ? slotId : ''}_${loggedInUser.username}`)) {
Utils.apiFetch(`savedata/session?slot=${slotId}&clientSessionId=${clientSessionId}`, true)
.then(response => response.text())
.then(async response => {
if (!response.length || response[0] !== '{') {
@ -614,12 +628,14 @@ export class GameData {
return resolve(null);
}
localStorage.setItem(`sessionData${slotId ? slotId : ''}_${loggedInUser.username}`, encrypt(response, bypassLogin));
await handleSessionData(response);
});
} else {
const sessionData = localStorage.getItem(`sessionData${slotId ? slotId : ''}`);
const sessionData = localStorage.getItem(`sessionData${slotId ? slotId : ''}_${loggedInUser.username}`);
if (sessionData)
await handleSessionData(atob(sessionData));
await handleSessionData(decrypt(sessionData, bypassLogin));
else
return resolve(null);
}
@ -640,6 +656,7 @@ export class GameData {
console.log('Seed:', scene.seed);
scene.sessionPlayTime = sessionData.playTime || 0;
scene.lastSavePlayTime = 0;
const loadPokemonAssets: Promise<void>[] = [];
@ -731,16 +748,17 @@ export class GameData {
deleteSession(slotId: integer): Promise<boolean> {
return new Promise<boolean>(resolve => {
if (bypassLogin) {
localStorage.removeItem('sessionData');
localStorage.removeItem(`sessionData${this.scene.sessionSlotId ? this.scene.sessionSlotId : ''}_${loggedInUser.username}`);
return resolve(true);
}
updateUserInfo().then(success => {
if (success !== null && !success)
return resolve(false);
Utils.apiFetch(`savedata/delete?datatype=${GameDataType.SESSION}&slot=${slotId}`, true).then(response => {
Utils.apiFetch(`savedata/delete?datatype=${GameDataType.SESSION}&slot=${slotId}&clientSessionId=${clientSessionId}`, true).then(response => {
if (response.ok) {
loggedInUser.lastSessionSlot = -1;
localStorage.removeItem(`sessionData${this.scene.sessionSlotId ? this.scene.sessionSlotId : ''}_${loggedInUser.username}`);
resolve(true);
}
return response.text();
@ -792,7 +810,7 @@ export class GameData {
tryClearSession(scene: BattleScene, slotId: integer): Promise<[success: boolean, newClear: boolean]> {
return new Promise<[boolean, boolean]>(resolve => {
if (bypassLogin) {
localStorage.removeItem(`sessionData${slotId ? slotId : ''}`);
localStorage.removeItem(`sessionData${slotId ? slotId : ''}_${loggedInUser.username}`);
return resolve([true, true]);
}
@ -800,9 +818,11 @@ export class GameData {
if (success !== null && !success)
return resolve([false, false]);
const sessionData = this.getSessionSaveData(scene);
Utils.apiPost(`savedata/clear?slot=${slotId}&trainerId=${this.trainerId}&secretId=${this.secretId}`, JSON.stringify(sessionData), undefined, true).then(response => {
if (response.ok)
Utils.apiPost(`savedata/clear?slot=${slotId}&trainerId=${this.trainerId}&secretId=${this.secretId}&clientSessionId=${clientSessionId}`, JSON.stringify(sessionData), undefined, true).then(response => {
if (response.ok) {
loggedInUser.lastSessionSlot = -1;
localStorage.removeItem(`sessionData${this.scene.sessionSlotId ? this.scene.sessionSlotId : ''}_${loggedInUser.username}`);
}
return response.json();
}).then(jsonResponse => {
if (!jsonResponse.error)
@ -855,14 +875,14 @@ export class GameData {
}) as SessionSaveData;
}
saveAll(scene: BattleScene, skipVerification?: boolean): Promise<boolean> {
saveAll(scene: BattleScene, skipVerification: boolean = false, sync: boolean = false, useCachedSession: boolean = false): Promise<boolean> {
return new Promise<boolean>(resolve => {
Utils.executeIf(!skipVerification, updateUserInfo).then(success => {
if (success !== null && !success)
return resolve(false);
if (sync)
this.scene.ui.savingIcon.show();
const data = this.getSystemSaveData();
const sessionData = this.getSessionSaveData(scene);
const sessionData = useCachedSession ? this.parseSessionData(decrypt(localStorage.getItem(`sessionData${scene.sessionSlotId ? scene.sessionSlotId : ''}_${loggedInUser.username}`), bypassLogin)) : this.getSessionSaveData(scene);
const maxIntAttrValue = Math.pow(2, 31);
const systemData = this.getSystemSaveData();
@ -870,14 +890,24 @@ export class GameData {
const request = {
system: systemData,
session: sessionData,
sessionSlotId: scene.sessionSlotId
sessionSlotId: scene.sessionSlotId,
clientSessionId: clientSessionId
};
if (!bypassLogin) {
localStorage.setItem(`data_${loggedInUser.username}`, encrypt(JSON.stringify(systemData, (k: any, v: any) => typeof v === 'bigint' ? v <= maxIntAttrValue ? Number(v) : v.toString() : v), bypassLogin));
localStorage.setItem(`sessionData${scene.sessionSlotId ? scene.sessionSlotId : ''}_${loggedInUser.username}`, encrypt(JSON.stringify(sessionData), bypassLogin));
console.debug('Session data saved');
if (!bypassLogin && sync) {
Utils.apiPost('savedata/updateall', JSON.stringify(request, (k: any, v: any) => typeof v === 'bigint' ? v <= maxIntAttrValue ? Number(v) : v.toString() : v), undefined, true)
.then(response => response.text())
.then(error => {
if (sync) {
this.scene.lastSavePlayTime = 0;
this.scene.ui.savingIcon.hide();
}
if (error) {
if (error.startsWith('client version out of date')) {
this.scene.clearPhaseQueue();
@ -892,17 +922,10 @@ export class GameData {
resolve(true);
});
} else {
localStorage.setItem('data_bak', localStorage.getItem('data'));
localStorage.setItem('data', btoa(JSON.stringify(systemData, (k: any, v: any) => typeof v === 'bigint' ? v <= maxIntAttrValue ? Number(v) : v.toString() : v)));
localStorage.setItem(`sessionData${scene.sessionSlotId ? scene.sessionSlotId : ''}`, btoa(JSON.stringify(sessionData)));
console.debug('Session data saved');
this.verify().then(success => {
this.scene.ui.savingIcon.hide();
resolve(true);
resolve(success);
});
}
});
});
@ -910,7 +933,7 @@ export class GameData {
public tryExportData(dataType: GameDataType, slotId: integer = 0): Promise<boolean> {
return new Promise<boolean>(resolve => {
const dataKey: string = getDataTypeKey(dataType, slotId);
const dataKey: string = `${getDataTypeKey(dataType, slotId)}_${loggedInUser.username}`;
const handleData = (dataStr: string) => {
switch (dataType) {
case GameDataType.SYSTEM:
@ -926,7 +949,7 @@ export class GameData {
link.remove();
};
if (!bypassLogin && dataType < GameDataType.SETTINGS) {
Utils.apiFetch(`savedata/get?datatype=${dataType}${dataType === GameDataType.SESSION ? `&slot=${slotId}` : ''}`, true)
Utils.apiFetch(`savedata/${dataType === GameDataType.SYSTEM ? 'system' : 'session'}${dataType === GameDataType.SESSION ? `&slot=${slotId}` : ''}&clientSessionId=${clientSessionId}`, true)
.then(response => response.text())
.then(response => {
if (!response.length || response[0] !== '{') {
@ -941,14 +964,14 @@ export class GameData {
} else {
const data = localStorage.getItem(dataKey);
if (data)
handleData(atob(data));
handleData(decrypt(data, bypassLogin));
resolve(!!data);
}
});
}
public importData(dataType: GameDataType, slotId: integer = 0): void {
const dataKey = getDataTypeKey(dataType, slotId);
const dataKey = `${getDataTypeKey(dataType, slotId)}_${loggedInUser.username}`;
let saveFile: any = document.getElementById('saveFile');
if (saveFile)
@ -1009,11 +1032,13 @@ export class GameData {
return this.scene.ui.showText(`Your ${dataName} data could not be loaded. It may be corrupted.`, null, () => this.scene.ui.showText(null, 0), Utils.fixedInt(1500));
this.scene.ui.showText(`Your ${dataName} data will be overridden and the page will reload. Proceed?`, null, () => {
this.scene.ui.setOverlayMode(Mode.CONFIRM, () => {
localStorage.setItem(dataKey, encrypt(dataStr, bypassLogin));
if (!bypassLogin && dataType < GameDataType.SETTINGS) {
updateUserInfo().then(success => {
if (!success)
return displayError(`Could not contact the server. Your ${dataName} data could not be imported.`);
Utils.apiPost(`savedata/update?datatype=${dataType}${dataType === GameDataType.SESSION ? `&slot=${slotId}` : ''}&trainerId=${this.trainerId}&secretId=${this.secretId}`, dataStr, undefined, true)
Utils.apiPost(`savedata/update?datatype=${dataType}${dataType === GameDataType.SESSION ? `&slot=${slotId}` : ''}&trainerId=${this.trainerId}&secretId=${this.secretId}&clientSessionId=${clientSessionId}`, dataStr, undefined, true)
.then(response => response.text())
.then(error => {
if (error) {
@ -1023,10 +1048,8 @@ export class GameData {
window.location = window.location;
});
});
} else {
localStorage.setItem(dataKey, btoa(dataStr));
} else
window.location = window.location;
}
}, () => {
this.scene.ui.revertMode();
this.scene.ui.showText(null, 0);

2
src/ui/egg-gacha-ui-handler.ts
View File

@ -372,7 +372,7 @@ export default class EggGachaUiHandler extends MessageUiHandler {
this.scene.gameData.gameStats.eggsPulled++;
}
this.scene.gameData.saveSystem().then(success => {
this.scene.gameData.saveAll(this.scene, true, true, true).then(success => {
if (!success)
return this.scene.reset(true);
doPull();