free-games-claimer/playstation-plus.js

268 lines
9.8 KiB
JavaScript

import { firefox } from "playwright-firefox"; // stealth plugin needs no outdated playwright-extra
import { authenticator } from "otplib";
import {
datetime,
handleSIGINT,
html_game_list,
jsonDb,
notify,
prompt,
retryOnError,
} from "./util.js";
import path from "path";
import { existsSync, writeFileSync } from "fs";
import { cfg } from "./config.js";
// ### SETUP
const URL_CLAIM = "https://www.playstation.com/en-us/ps-plus/whats-new";
console.log(datetime(), "started checking playstation plus");
const db = await jsonDb("playstation-plus.json");
db.data ||= {};
handleSIGINT();
// https://playwright.dev/docs/auth#multi-factor-authentication
const context = await firefox.launchPersistentContext(cfg.dir.browser, {
headless: cfg.headless,
viewport: { width: cfg.width, height: cfg.height },
locale: "en-US", // ignore OS locale to be sure to have english text for locators -> done via /en in URL
});
if (!cfg.debug) context.setDefaultTimeout(cfg.timeout);
const page = context.pages().length
? context.pages()[0]
: await context.newPage(); // should always exist
const notify_games = [];
let user;
main();
async function main() {
try {
await performLogin();
await getAndSaveUser();
await redeemFreeGames();
} catch (error) {
console.error(error);
process.exitCode ||= 1;
if (error.message && process.exitCode != 130)
notify(`playstation-plus failed: ${error.message.split("\n")[0]}`);
} finally {
await db.write(); // write out json db
if (notify_games.filter((g) => g.status != "existed").length) {
// don't notify if all were already claimed
notify(
`playstation-plus (${user}):<br>${html_game_list(notify_games)}`
);
}
await context.close();
}
}
async function performLogin() {
// the page gets stuck sometimes and requires a reload
await retryOnError(() => page.goto(URL_CLAIM, { timeout: 20_000, waitUntil: "networkidle" }));
const signInLocator = page.locator('span:has-text("Sign in")').first();
const profileIconLocator = page.locator(".profile-icon").first();
const mainPageBaseUrl = "https://playstation.com";
const loginPageBaseUrl = "https://my.account.sony.com";
async function isSignedIn() {
await Promise.any([
signInLocator.waitFor(),
profileIconLocator.waitFor(),
]);
return !(await signInLocator.isVisible());
}
if (!(await isSignedIn())) {
await signInLocator.click();
await page.waitForLoadState("networkidle");
if (page.url().indexOf(mainPageBaseUrl) === 0) {
if (await isSignedIn()) {
return; // logged in using saved cookie
} else {
console.error("stuck in login loop, try clearing cookies");
}
} else if (page.url().indexOf(loginPageBaseUrl) === 0) {
console.error("Not signed in anymore.");
await signInToPSN();
} else {
console.error("lost! where am i?");
}
}
}
async function signInToPSN() {
await page.waitForSelector("#kekka-main");
if (!cfg.debug) context.setDefaultTimeout(cfg.login_timeout); // give user some extra time to log in
console.info(`Login timeout is ${cfg.login_timeout / 1000} seconds!`);
// ### FETCH EMAIL/PASS
if (cfg.psp_email && cfg.psp_password)
console.info("Using email and password from environment.");
else
console.info(
"Press ESC to skip the prompts if you want to login in the browser (not possible in headless mode)."
);
const email = cfg.psp_email || (await prompt({ message: "Enter email" }));
const password =
email &&
(cfg.psp_password ||
(await prompt({
type: "password",
message: "Enter password",
})));
// ### FILL IN EMAIL/PASS
if (email && password) {
await page.locator("#signin-entrance-input-signinId").fill(email);
await page.locator("#signin-entrance-button").click(); // Next button
await page.waitForSelector("#signin-password-input-password");
await page.locator("#signin-password-input-password").fill(password);
await page.locator("#signin-password-button").click();
// ### CHECK FOR CAPTCHA
page.frameLocator('iframe[title="Verification challenge"]').locator("#FunCaptcha")
.waitFor()
.then(() => {
console.error(
"Got a captcha during login (likely due to too many attempts)! You may solve it in the browser, get a new IP or try again in a few hours."
);
notify(
"playstation-plus: got captcha during login. Please check."
);
})
.catch((_) => { });
// handle MFA, but don't await it
page.locator('input[title="Enter Code"]')
.waitFor()
.then(async () => {
console.log("Two-Step Verification - Enter security code");
console.log(
await page.locator(".description-regular").innerText()
);
const otp =
(cfg.psp_otpkey &&
authenticator.generate(cfg.psp_otpkey)) ||
(await prompt({
type: "text",
message: "Enter two-factor sign in code",
validate: (n) =>
n.toString().length == 6 ||
"The code must be 6 digits!",
})); // can't use type: 'number' since it strips away leading zeros and codes sometimes have them
await page.type('input[title="Enter Code"]', otp.toString());
await page
.locator(".checkbox-container")
.locator("button")
.first()
.click(); // Trust this Browser
await page.click("button.primary-button");
})
.catch((_) => { });
} else {
console.log("Waiting for you to login in the browser.");
await notify(
"playstation-plus: no longer signed in and not enough options set for automatic login."
);
if (cfg.headless) {
console.log(
"Run `SHOW=1 node playstation-plus` to login in the opened browser."
);
await context.close();
process.exit(1);
}
}
// ### VERIFY SIGNED IN
await page.waitForURL(`${URL_CLAIM}**`);
if (!cfg.debug) context.setDefaultTimeout(cfg.timeout);
}
async function getAndSaveUser() {
user = await page.locator(".psw-c-secondary").innerText();
console.log(`Signed in as '${user}'`);
db.data[user] ||= {};
}
async function redeemFreeGames() {
// ### GET LIST OF FREE GAMES
const monthlyGamesBlock = await page.locator(
".cmp-experiencefragment--your-latest-monthly-games"
);
const monthlyGamesLocator = await monthlyGamesBlock.locator(".box").all();
const monthlyGamesPageLinks = await Promise.all(
monthlyGamesLocator.map(async (el) => {
const urlSlug = await el
.locator(".cta__primary")
.getAttribute("href");
// standardize URLs
return (urlSlug.charAt(0) === "/"
? `https://www.playstation.com${urlSlug}` // base url may not be present, add it back
: urlSlug)
.split('#').shift(); // url may have anchor tag, remove it
})
);
console.log("Free games:", monthlyGamesPageLinks);
for (const url of monthlyGamesPageLinks) {
await page.goto(url);
const gameCard = page.locator(".content-grid").first();
await gameCard.waitFor();
const title = await gameCard.locator("h1").first().innerText();
const game_id = page
.url()
.split("/")
.filter((x) => !!x)
.pop();
db.data[user][game_id] ||= { title, time: datetime(), url: page.url() }; // this will be set on the initial run only!
console.log("Current free game:", title);
const notify_game = { title, url, status: "failed" };
notify_games.push(notify_game); // status is updated below
// SELECTORS
const inLibrary = gameCard
.locator('span:has-text("In library")')
.first();
const purchased = gameCard
.locator('span:has-text("Purchased")')
.first();
const addToLibrary = gameCard
.locator('span:has-text("Add to Library")')
.nth(1);
await Promise.any([addToLibrary.waitFor(), purchased.waitFor(), inLibrary.waitFor()]);
if (await inLibrary.isVisible() || await purchased.isVisible()) {
console.log(" Already in library! Nothing to claim.");
notify_game.status = "existed";
db.data[user][game_id].status ||= "existed"; // does not overwrite claimed or failed
} else if (await addToLibrary.isVisible()) {
console.log(" Not in library yet! Click ADD TO LIBRARY.");
await addToLibrary.click();
await inLibrary.waitFor();
notify_game.status = "claimed";
db.data[user][game_id].status = "claimed";
db.data[user][game_id].time = datetime(); // claimed time overwrites failed/dryrun time
console.log(" Claimed successfully!");
}
// notify_game.status = db.data[user][game_id].status; // claimed or failed
// const p = path.resolve(cfg.dir.screenshots, playstation-plus', `${game_id}.png`);
// if (!existsSync(p)) await page.screenshot({ path: p, fullPage: false }); // fullPage is quite long...
}
}