Steam Community - Leave Banned Groups

Add a button to leave invisble banned groups on steam

当前为 2019-10-27 提交的版本,查看 最新版本

您需要先安装一个扩展,例如 篡改猴Greasemonkey暴力猴,之后才能安装此脚本。

You will need to install an extension such as Tampermonkey to install this script.

您需要先安装一个扩展,例如 篡改猴暴力猴,之后才能安装此脚本。

您需要先安装一个扩展,例如 篡改猴Userscripts ,之后才能安装此脚本。

您需要先安装一款用户脚本管理器扩展,例如 Tampermonkey,才能安装此脚本。

您需要先安装用户脚本管理器扩展后才能安装此脚本。

(我已经安装了用户脚本管理器,让我安装!)

您需要先安装一款用户样式管理器扩展,比如 Stylus,才能安装此样式。

您需要先安装一款用户样式管理器扩展,比如 Stylus,才能安装此样式。

您需要先安装一款用户样式管理器扩展,比如 Stylus,才能安装此样式。

您需要先安装一款用户样式管理器扩展后才能安装此样式。

您需要先安装一款用户样式管理器扩展后才能安装此样式。

您需要先安装一款用户样式管理器扩展后才能安装此样式。

(我已经安装了用户样式管理器,让我安装!)

// ==UserScript==
// @name         Steam Community - Leave Banned Groups
// @icon         https://store.steampowered.com/favicon.ico
// @namespace    https://github.com/tkhquang
// @version      0.50
// @description  Add a button to leave invisble banned groups on steam
// @author       Quang Trinh
// @license      MIT; https://raw.githubusercontent.com/tkhquang/userscripts/master/LICENSE
// @include      /^https?:\/\/steamcommunity\.com\/(?:id|profiles)\/[\w-_]+\/groups\/?$/
// @run-at       document-idle
// @require      https://code.jquery.com/jquery-3.4.1.min.js
// @grant        none
// ==/UserScript==

// ==Configuration==
const STEAM_WEB_API = ""; // Required, get from here: https://steamcommunity.com/dev/apikey
// ==Configuration==

(function($) {
  "use strict";

  if (!STEAM_WEB_API.trim()) {
    alert("Steam Leave Banned Group Userscript\nSteam Web API is required");
    return;
  }

  const steamId = window.g_steamID;
  const sessionId = window.g_sessionID;

  // On not logged in, exit
  if (!steamId || !sessionId) {
    return;
  }

  // On someone else's profile, exit
  if (window.g_rgProfileData.steamid !== steamId ) {
    return;
  }

  const doAjax = async(opts) => {
    try {
      const data = await $.ajax({
        ...opts
      });
      return data;
    } catch (response) {
      if (response instanceof Error) {
        return Promise.reject(response);
      }
      // is jqXHR
      const error = new Error;
      error.message = response.statusText;
    }
  };

  // Get all groups which the user is in
  const getAllGroups = async() => {
    try {
      // This return the id [g:1:${id}]
      const { response } = await doAjax({
        type: "GET",
        url: "https://api.steampowered.com/ISteamUser/GetUserGroupList/v1/",
        data: {
          key: STEAM_WEB_API,
          steamid: steamId
        },
        dataType: "json",
      });

      // Turn the results into groupID64
      // const groupID64s = await Promise.all(response.groups.map(async group => {
      //   const xml = await doAjax({
      //     url: `https://steamcommunity.com/gid/[g:1:${group.gid}]/memberslistxml/`,
      //     data: {
      //       xml: 1
      //     },
      //     type: "GET",
      //     dataType: "xml"
      //   });
      //   return $(xml).find("groupID64").html();
      // }));
      // return groupID64s;
      return response.groups.map(groups => groups.gid);
    } catch (error) {
      console.log("Get all groups using Steam API failed", error);
      return Promise.reject(error);
    }
  };

  // This doesn't return banned groups and other types (offcial game groups, .etc)
  // const getVisibleGroups = async() => {
  //   try {
  //     const xml = await doAjax({
  //       url: `https://steamcommunity.com/profiles/${steamId}`,
  //       data: {
  //         xml: 1
  //       },
  //       type: "GET",
  //       dataType: "xml"
  //     });

  //     const groupID64s = $(xml).find("groupID64").map(function() {
  //       return $(this).html();
  //     }).get();

  //     return groupID64s;
  //   } catch (error) {
  //     console.log("Get all visible groups failed", error);
  //     return Promise.reject(error);
  //   }
  // };

  const getVisibleGroups = () => {
    const pattern = /group_(\d+)/;
    const visibleGroups = $("#search_results")
      .find("div[id^='group_']")
      .toArray()
      .map(item => pattern.exec($(item).attr("id"))[1]);
    return visibleGroups;
  };

  // Filter out other types of groups (offcial game groups, .etc)
  const filterOutNotBanned = async(groupIds) => {
    try {
      const results = await Promise.all(groupIds.map(async groupId => {
        const html = await doAjax({
          url: `https://steamcommunity.com/gid/[g:1:${groupId}]`,
          type: "get",
          dataType: "html"
        });
        return /This group has been removed for violating/.test(html) ? groupId : null;
      }));
      return results.filter(result => result !== null);
    } catch (error) {
      console.log("Filter banned groups failed", error);
    }
  };

  const getBannedGroupInfo = async(groupIds) => {
    const pattern = /<!\[CDATA\[(.*)]]>/;
    const groupInfo = await Promise.all(groupIds.map(async groupId => {
      const xml = await doAjax({
        url: `https://steamcommunity.com/gid/[g:1:${groupId}]/memberslistxml/`,
        data: {
          xml: 1
        },
        type: "GET",
        dataType: "xml"
      });
      return {
        groupID64: $(xml).find("groupID64").html(),
        groupName: pattern.exec($(xml).find("groupName").html())[1]
      };
    }));
    return groupInfo;
  };

  $(function() {
    $("<button />", {
      id: "userscript_leave_banned_groups",
      title: "Click to leave banned groups",
      text: "Leave banned groups",
      type: "button"
    }).appendTo(".friends_nav");

    $("<style>")
      .prop("type", "text/css")
      .html(`
        #userscript_leave_banned_groups {
          width: 100%;
          background-color: #015e80;
          border-radius: 5px;
          border: 1px solid #015e80;
          display: inline-block;
          cursor: pointer;
          color: #ffffff;
          padding: 8px 16px;
          text-decoration: none;
          text-shadow: 0px 1px 0px #2f6627;
        }
        #userscript_leave_banned_groups:hover:enabled {
          background-color: #004a50;
        }
        #userscript_leave_banned_groups:active {
          position: relative;
          top: 1px;
        }
        #userscript_leave_banned_groups:disabled {
          cursor: not-allowed;
        }`
      )
      .appendTo("head");

    const btn = $("#userscript_leave_banned_groups");
    const originalText = btn.text();
    let timer;

    const setText = (el, text) => {
      const $this = el;
      clearTimeout(timer);

      $this.text(text);
      timer = setTimeout(() => {
        $this.text(originalText);
      }, 5000);
    };

    const setPermText = (el, text) => {
      const $this = el;
      $this.text(text);
    };

    const initialize = async() => {
      btn.attr("disabled", true);
      setPermText(btn, "Checking...");

      const allGroups = await getAllGroups();
      const visibleGroups = await getVisibleGroups();

      // This may be offical game groups or banned groups, .etc
      const unknownGroups = $(allGroups).not(visibleGroups).get();

      const bannedGroups = await filterOutNotBanned(unknownGroups);

      if (!bannedGroups.length) {
        setText(btn, "No banned groups to leave");
        console.log("No banned groups to leave");
        alert("No banned groups to leave");
        return;
      }

      const bannedGroupWithInfo = await getBannedGroupInfo(bannedGroups);

      setPermText(btn, `Leaving ${bannedGroupWithInfo.length} groups...`);

      const sendLeaveRequest = async(groupInfo) => {
        const data = {
          action: "leave_group",
          sessionid: sessionId,
          ajax: 1,
          steamid: steamId,
          steamids: [groupInfo.groupID64]
        };
        try {
          const response = await doAjax({
            url: `https://steamcommunity.com/profiles/${steamId}/friends/action`,
            type: "POST",
            dataType: "json",
            data
          });
          console.log(`Left ${groupInfo.groupName}`, response);
          return response;
        } catch (error) {
          console.log(`Error leaving ${groupInfo.groupName}`, error);
          return Promise.reject(error);
        }
      };

      await Promise.all(bannedGroupWithInfo.map(groupInfo => {
        return sendLeaveRequest(groupInfo);
      }));

      console.log(`Left ${bannedGroupWithInfo.length} Steam Groups successfully`);
      console.log("Groups", bannedGroupWithInfo);

      setText(btn, `Left ${bannedGroupWithInfo.length} groups`);
      alert(`Left ${bannedGroupWithInfo.length} groups\nCheck the browser console for more information`);
    };

    btn.click(
      async function(e) {
        e.preventDefault();
        try {
          await initialize();
        } catch (error) {
          console.log("An error occured", error);
          alert("An error occured");
          setText(btn, "An error occured");
        } finally {
          btn.removeAttr("disabled");
        }
      }
    );
  });

})(window.jQuery.noConflict(true));