Skip to content

Commit

Permalink
feat: Implement subscribing to workshop item into !follow cmd #244
Browse files Browse the repository at this point in the history
  • Loading branch information
@3urobeat
3urobeat committed Jan 6, 2025
1 parent 624dd0d commit 8bc3305
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 29 deletions.
116 changes: 92 additions & 24 deletions src/commands/core/follow.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
* Created Date: 2023-09-24 15:04:33
* Author: 3urobeat
*
* Last Modified: 2024-10-10 18:24:12
* Last Modified: 2025-01-06 19:48:16
* Modified By: 3urobeat
*
* Copyright (c) 2023 - 2024 3urobeat <https://github.com/3urobeat>
* Copyright (c) 2023 - 2025 3urobeat <https://github.com/3urobeat>
*
* 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, either version 3 of the License, or (at your option) any later version.
* 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.
Expand All @@ -25,7 +25,7 @@ const { handleIterationSkip } = require("../helpers/handleRequestSkips.js");

module.exports.follow = {
names: ["follow"],
description: "Follows a user with all bot accounts that haven't yet done so",
description: "Follows a user/curator/workshop item with all bot accounts that haven't yet done so",
args: [
{
name: "amount",
Expand All @@ -36,7 +36,7 @@ module.exports.follow = {
},
{
name: "ID",
description: "The link, steamID64 or vanity of the profile to follow",
description: "The link, steamID64 or vanity of the profile/curator/workshop item to follow",
type: "string",
isOptional: true,
ownersOnly: true
Expand Down Expand Up @@ -128,6 +128,48 @@ module.exports.follow = {
const activeReqEntry = commandHandler.controller.activeRequests[id]; // Make using the obj shorter


// Get the correct followFunc function based on type
let followFunc;
let followArgs = {};

switch (activeReqEntry.type) {
case "sharedfileFollow": // We assume the user provided a follow-able game workshop item like https://steamcommunity.com/sharedfiles/filedetails/?id=3236615060
followFunc = commandHandler.controller.main.community.subscribeWorkshopSharedFile; // Context of the correct bot account is applied later
followArgs = { sharedFileId: null, appid: null };

// Get sharedFileId & appid by scraping sharedfile DOM - Quick hack to await function that only supports callbacks
await (() => {
return new Promise((resolve) => {
commandHandler.controller.main.community.getSteamSharedFile(id, (err, obj) => { // ReceiverSteamID64 is a URL in this case
if (err) {
logger("error", "Couldn't get workshop sharedfile even though it exists?! Aborting!\n" + err.stack);
respond("Error: Couldn't get workshop sharedfile even though it exists?! Aborting!\n" + err);
return;
}

followArgs.sharedFileId = obj.id;
followArgs.appid = obj.appID;
resolve();
});
});
})();
break;
case "curatorFollow":
followFunc = commandHandler.controller.main.community.followCurator; // Context of the correct bot account is applied later
followArgs = { id: id };
break;
default:
followFunc = commandHandler.controller.main.community.followUser; // Context of the correct bot account is applied later
followArgs = { id: id };
}

// Overwrite followFunc with pure *nothingness* if debug mode is enabled
if (commandHandler.data.advancedconfig.disableSendingRequests) {
logger("warn", "Replacing followFunc with nothingness because 'disableSendingRequests' is enabled in 'advancedconfig.json'!");
followFunc = (a, callback) => callback(null);
}


// Log request start and give user cooldown on the first iteration
if (activeReqEntry.thisIteration == -1) {
logger("info", `${logger.colors.fggreen}[${commandHandler.controller.main.logPrefix}] ${activeReqEntry.amount} Follow(s) requested. Starting to follow ${idType} ${id}...`);
Expand Down Expand Up @@ -155,15 +197,7 @@ module.exports.follow = {
if (!handleIterationSkip(commandHandler, loop, bot, id)) return; // Skip iteration if false was returned

/* --------- Try to follow --------- */
let followFunc = activeReqEntry.type == "curatorFollow" ? bot.community.followCurator : bot.community.followUser; // Get the correct function, depending on if the user provided a curator id or a user id

// Overwrite followFunc with pure *nothingness* if debug mode is enabled
if (commandHandler.data.advancedconfig.disableSendingRequests) {
logger("warn", "Replacing followFunc with nothingness because 'disableSendingRequests' is enabled in 'advancedconfig.json'!");
followFunc = (a, callback) => callback(null);
}

followFunc.call(bot.community, id, (error) => { // Very important! Using call() and passing the bot's community instance will keep context (this.) as it was lost by our postComment variable assignment!
followFunc.call(bot.community, ...Object.values(followArgs), (error) => { // Very important! Using call() and passing the bot's community instance will keep context (this.) as it was lost by our postComment variable assignment!

/* --------- Handle errors thrown by this follow attempt or update ratingHistory db and log success message --------- */
if (error) {
Expand Down Expand Up @@ -221,7 +255,7 @@ module.exports.follow = {

module.exports.unfollow = {
names: ["unfollow"],
description: "Unfollows a user with all bot accounts that have followed them",
description: "Unfollows a user/curator/workshop item with all bot accounts that have followed them",
args: [
{
name: "amount",
Expand All @@ -232,7 +266,7 @@ module.exports.unfollow = {
},
{
name: "ID",
description: "The link, steamID64 or vanity of the profile to unfollow",
description: "The link, steamID64 or vanity of the profile/curator/workshop item to unfollow",
type: "string",
isOptional: true,
ownersOnly: true
Expand Down Expand Up @@ -324,6 +358,48 @@ module.exports.unfollow = {
const activeReqEntry = commandHandler.controller.activeRequests[id]; // Make using the obj shorter


// Get the correct followFunc function based on type
let followFunc;
let followArgs = {};

switch (activeReqEntry.type) {
case "sharedfileUnfollow": // We assume the user provided a follow-able game workshop item like https://steamcommunity.com/sharedfiles/filedetails/?id=3236615060
followFunc = commandHandler.controller.main.community.unsubscribeWorkshopSharedFile; // Context of the correct bot account is applied later
followArgs = { sharedFileId: null, appid: null };

// Get sharedFileId & appid by scraping sharedfile DOM - Quick hack to await function that only supports callbacks
await (() => {
return new Promise((resolve) => {
commandHandler.controller.main.community.getSteamSharedFile(id, (err, obj) => { // ReceiverSteamID64 is a URL in this case
if (err) {
logger("error", "Couldn't get workshop sharedfile even though it exists?! Aborting!\n" + err.stack);
respond("Error: Couldn't get workshop sharedfile even though it exists?! Aborting!\n" + err);
return;
}

followArgs.sharedFileId = obj.id;
followArgs.appid = obj.appID;
resolve();
});
});
})();
break;
case "curatorUnfollow":
followFunc = commandHandler.controller.main.community.unfollowCurator; // Context of the correct bot account is applied later
followArgs = { id: id };
break;
default:
followFunc = commandHandler.controller.main.community.unfollowUser; // Context of the correct bot account is applied later
followArgs = { id: id };
}

// Overwrite followFunc with pure *nothingness* if debug mode is enabled
if (commandHandler.data.advancedconfig.disableSendingRequests) {
logger("warn", "Replacing followFunc with nothingness because 'disableSendingRequests' is enabled in 'advancedconfig.json'!");
followFunc = (a, callback) => callback(null);
}


// Log request start and give user cooldown on the first iteration
if (activeReqEntry.thisIteration == -1) {
logger("info", `${logger.colors.fggreen}[${commandHandler.controller.main.logPrefix}] ${activeReqEntry.amount} Unfollow(s) requested. Starting to unfollow ${idType} ${id}...`);
Expand Down Expand Up @@ -351,15 +427,7 @@ module.exports.unfollow = {
if (!handleIterationSkip(commandHandler, loop, bot, id)) return; // Skip iteration if false was returned

/* --------- Try to unfollow --------- */
let followFunc = activeReqEntry.type == "curatorUnfollow" ? bot.community.unfollowCurator : bot.community.unfollowUser; // Get the correct function, depending on if the user provided a curator id or a user id

// Overwrite followFunc with pure *nothingness* if debug mode is enabled
if (commandHandler.data.advancedconfig.disableSendingRequests) {
logger("warn", "Replacing followFunc with nothingness because 'disableSendingRequests' is enabled in 'advancedconfig.json'!");
followFunc = (a, callback) => callback(null);
}

followFunc.call(bot.community, id, (error) => { // Very important! Using call() and passing the bot's community instance will keep context (this.) as it was lost by our postComment variable assignment!
followFunc.call(bot.community, ...Object.values(followArgs), (error) => { // Very important! Using call() and passing the bot's community instance will keep context (this.) as it was lost by our postComment variable assignment!

/* --------- Handle errors thrown by this unfollow attempt or update ratingHistory db and log success message --------- */
if (error) {
Expand Down
6 changes: 3 additions & 3 deletions src/commands/helpers/getFollowArgs.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
* Created Date: 2023-09-24 16:10:36
* Author: 3urobeat
*
* Last Modified: 2024-02-23 16:22:52
* Last Modified: 2025-01-06 19:27:25
* Modified By: 3urobeat
*
* Copyright (c) 2023 - 2024 3urobeat <https://github.com/3urobeat>
* Copyright (c) 2023 - 2025 3urobeat <https://github.com/3urobeat>
*
* 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, either version 3 of the License, or (at your option) any later version.
* 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.
Expand Down Expand Up @@ -71,7 +71,7 @@ module.exports.getFollowArgs = (commandHandler, args, cmd, resInfo, respond) =>
const arg = args[1];

commandHandler.controller.handleSteamIdResolving(arg, null, async (err, res, idType) => {
if (err || (idType != "profile" && idType != "curator")) {
if (err || (!["profile", "curator", "sharedfile"].includes(idType))) {
respond((await commandHandler.data.getLang("invalidprofileid", null, requesterID)) + "\n\nError: " + err);
return resolve({});
}
Expand Down
4 changes: 2 additions & 2 deletions src/data/fileStructure.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
{
"path": "src/commands/core/follow.js",
"url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/src/commands/core/follow.js",
"checksum": "a9e974895dd7c9e2a67e1914cccce158"
"checksum": "5f1f07fd3ff58d90f6801c76b0c7d3e2"
},
{
"path": "src/commands/core/friend.js",
Expand Down Expand Up @@ -233,7 +233,7 @@
{
"path": "src/commands/helpers/getFollowArgs.js",
"url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/src/commands/helpers/getFollowArgs.js",
"checksum": "0dbb185c9a4b22691e60dffdf5d1160c"
"checksum": "5d4a9849c373602c0bf2b30f82bf0fea"
},
{
"path": "src/commands/helpers/getFollowBots.js",
Expand Down

0 comments on commit 8bc3305

Please sign in to comment.