OD Drug Detection

.gitignore

@@ -93,3 +93,5 @@ wsgi.py
 
 # Docs
 docs/build/
+
+.tool-versions

application/controllers/api/v1/__init__.py

@@ -360,6 +360,7 @@
 mod.add_url_rule("/api/v1/user/guilds", view_func=user.get_admin_guilds, methods=["GET"])
 mod.add_url_rule("/api/v1/user/settings/cpr", view_func=user_settings.toggle_cpr, methods=["PUT"])
 mod.add_url_rule("/api/v1/user/settings/stat-db", view_func=user_settings.toggle_stat_db, methods=["PUT"])
+mod.add_url_rule("/api/v1/user/settings/od-drug", view_func=user_settings.toggle_od_drug, methods=["PUT"])
 mod.add_url_rule("/api/v1/user/<int:tid>", view_func=user.get_specific_user, methods=["GET"])
 mod.add_url_rule(
     "/api/v1/user/estimate/<int:tid>",

application/controllers/api/v1/user_settings/__init__.py

@@ -52,3 +52,19 @@ def toggle_stat_db(*args, **kwargs):
     settings = UserSettings.create_or_update(kwargs["user"].tid, stat_db_enabled=enabled)
 
     return jsonify(settings.to_dict()), api_ratelimit_response(key)
+
+
+@session_required
+@ratelimit
+def toggle_od_drug(*args, **kwargs):
+    data = json.loads(request.get_data().decode("utf-8"))
+    key = f"tornium:ratelimit:{kwargs['user'].tid}"
+
+    enabled = data.get("enabled")
+
+    if not isinstance(enabled, bool):
+        return make_exception_response("0000", key)
+
+    settings = UserSettings.create_or_update(kwargs["user"].tid, od_drug_enabled=enabled)
+
+    return jsonify(settings.to_dict()), api_ratelimit_response(key)

application/static/settings/settings.js

@@ -131,6 +131,13 @@ ready(() => {
         toggleSetting("stat-db", false);
     });
 
+    document.getElementById("od-drug-toggle-enable").addEventListener("click", (event) => {
+        toggleSetting("od-drug", true);
+    });
+    document.getElementById("od-drug-toggle-disable").addEventListener("click", (event) => {
+        toggleSetting("od-drug", false);
+    });
+
     Array.from(document.getElementsByClassName("revoke-client")).forEach((button) => {
         button.addEventListener("click", revokeClient);
     });

application/templates/settings/settings.html

@@ -146,13 +146,15 @@ <h5 class="card-title">Tornium API Key Settings</h5>
                 <div class="list-group list-group-flush">
                     <li class="list-group-item">
                         <label for="cpr-toggle" class="form-label">Share CPR:</label>
+                        <p><small>Collect and share your CPR data for all available organized crimes for the <a href="/faction/crimes/cpr">faction CPR viewer</a>.</small></p>
 
                         <input type="radio" class="btn-check" name="cpr-toggle" id="cpr-toggle-enable" autocomplete="off" {% if current_user.settings is not none and current_user.settings.cpr_enabled %} checked {% endif %}>
                         <label class="btn" for="cpr-toggle-enable">Enable</label>
 
                         <input type="radio" class="btn-check" name="cpr-toggle" id="cpr-toggle-disable" autocomplete="off" {% if current_user.settings is none or not current_user.settings.cpr_enabled %} checked {% endif %}>
                         <label class="btn" for="cpr-toggle-disable">Disable</label>
                     </li>
+
                     <li class="list-group-item">
                         <label for="cpr-toggle" class="form-label mb-0">Share opponent stats:</label>
                         <p><small>Collect and share your opponents' stats via fair fight for the <a href="/stats/db">stat database</a>.</small></p>
@@ -163,6 +165,17 @@ <h5 class="card-title">Tornium API Key Settings</h5>
                         <input type="radio" class="btn-check" name="stat-db-toggle" id="stat-db-toggle-disable" autocomplete="off" {% if current_user.settings is none or not current_user.settings.stat_db_enabled %} checked {% endif %}>
                         <label class="btn" for="stat-db-toggle-disable">Disable</label>
                     </li>
+
+                    <li class="list-group-item">
+                        <label for="od-drug-toggle" class="form-label mb-0">Share overdosed drug:</label>
+                        <p><small>Collect and share the drug you've overdosed on from your logs.</small></p>
+
+                        <input type="radio" class="btn-check" name="od-drug-toggle" id="od-drug-toggle-enable" autocomplete="off" {% if current_user.settings is not none and current_user.settings.od_drug_enabled %} checked {% endif %}>
+                        <label class="btn" for="od-drug-toggle-enable">Enable</label>
+
+                        <input type="radio" class="btn-check" name="od-drug-toggle" id="od-drug-toggle-disable" autocomplete="off" {% if current_user.settings is none or not current_user.settings.od_drug_enabled %} checked {% endif %}>
+                        <label class="btn" for="od-drug-toggle-disable">Disable</label>
+                    </li>
                 </div>
             </div>
         </div>

commons/tornium_commons/models/user_settings.py

@@ -31,6 +31,7 @@ class Meta:
 
     cpr_enabled = BooleanField(default=True, null=False)
     stat_db_enabled = BooleanField(default=True, null=False)
+    od_drug_enabled = BooleanField(default=False, null=False)
 
     def create_or_update(user_id: int, **kwargs: dict):
         """

worker/.iex.exs

@@ -0,0 +1 @@
+IEx.configure(auto_reload: true)

worker/config/config.exs

@@ -80,8 +80,9 @@ config :tornium, Oban,
         {"*/5 * * * *", Tornium.Workers.OCUpdateScheduler},
         {"0 12 * * *", Tornium.Workers.OCCPRUpdateScheduler},
         {"0 0 * * *", Tornium.Workers.OAuthRevocation},
-        {"*/30 * * * *", Tornium.Workers.OverdoseUpdateScheduler},
-        {"10 0 * * *", Tornium.Workers.OverdoseDailyReport}
+        {"7,37 * * * *", Tornium.Workers.OverdoseUpdateScheduler},
+        {"15 0 * * *", Tornium.Workers.OverdoseDailyReport},
+        {"*/15 * * * *", Tornium.Workers.ArmoryNewsUpdateScheduler}
       ]
     },
     {Oban.Plugins.Pruner, max_age: 60 * 60 * 24},

worker/lib/application.ex

@@ -54,7 +54,8 @@ defmodule Tornium.Application do
       Tornex.HTTP.FinchClient,
       Tornex.Scheduler.Supervisor,
       {Oban, Application.fetch_env!(:tornium, Oban)},
-      Tornium.Web.Endpoint
+      Tornium.Web.Endpoint,
+      Tornium.Item.NameCache
     ]
 
     Supervisor.start_link(children, strategy: :one_for_one, name: Tornium.Supervisor)

worker/lib/faction/news/armory_action.ex

@@ -0,0 +1,174 @@
+# Copyright (C) 2021-2025 tiksan
+# 
+# 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.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+defmodule Tornium.Faction.News.ArmoryAction do
+  @moduledoc """
+  Struct containing parsed `armoryAction` news.
+  """
+
+  @behaviour Tornium.Faction.News
+
+  defstruct [:timestamp, :id, :action, :user_id, :item_id, :quantity]
+
+  @typedoc """
+  The item ID of the item used from the armory or the type of refill used.
+  """
+  @type armory_item :: non_neg_integer() | :energy_refill | :nerve_refill
+
+  @type t :: %__MODULE__{
+          timestamp: DateTime.t(),
+          id: String.t(),
+          action: Tornium.Schema.ArmoryUsage.actions(),
+          user_id: non_neg_integer(),
+          item_id: armory_item(),
+          quantity: non_neg_integer()
+        }
+
+  @impl Tornium.Faction.News
+  def parse(%Torngen.Client.Schema.FactionNews{timestamp: timestamp, text: text, id: id} = _news) do
+    %{
+      user_id: user_id,
+      action: action,
+      item_id: item_id,
+      quantity: quantity
+    } =
+      text
+      |> Floki.parse_fragment!()
+      |> do_parse_text()
+
+    %__MODULE__{
+      timestamp: DateTime.from_unix!(timestamp),
+      id: id,
+      action: action,
+      user_id: user_id,
+      item_id: item_id,
+      quantity: quantity
+    }
+  end
+
+  @spec do_parse_text(tree :: Floki.html_tree()) :: %{
+          user_id: non_neg_integer(),
+          action: Tornium.Schema.ArmoryUsage.actions(),
+          item_id: armory_item(),
+          quantity: non_neg_integer()
+        }
+  defp do_parse_text([{"a", [{"href", faction_member_link}], [_faction_member_name]}, text_remainder] = _tree) do
+    # e.g. for "<a href = \"http://www.torn.com/profiles.php?XID=3870167\">Kagat</a> used one of the faction's Blood Bag : O+ items"
+    # faction_member_link = http://www.torn.com/profiles.php?XID=3870167
+    # faction_member_name = Kagat
+    # text_remainder = " used one of the faction's Blood Bag : O+ items"
+
+    user_id =
+      faction_member_link
+      |> URI.parse()
+      |> Map.get(:query)
+      |> URI.decode_query()
+      |> Map.get("XID")
+      |> String.to_integer()
+
+    %{
+      action: action,
+      quantity: quantity,
+      item_name: item_name
+    } =
+      text_remainder
+      |> String.trim()
+      |> text_action_item()
+
+    item_id =
+      case item_name do
+        :energy_refill ->
+          :energy_refill
+
+        :nerve_refill ->
+          :nerve_refill
+
+        _ when is_binary(item_name) ->
+          Tornium.Item.NameCache.get_by_name(item_name)
+      end
+
+    %{user_id: user_id, action: action, item_id: item_id, quantity: quantity}
+  end
+
+  @spec text_action_item(text :: String.t()) ::
+          %{
+            action: Tornium.Schema.ArmoryUsage.actions(),
+            quantity: non_neg_integer(),
+            item_name: armory_item() | String.t()
+          }
+          | nil
+  defp text_action_item("used " <> suffixed_item_string = text) when is_binary(text) do
+    split_item_string =
+      String.split(suffixed_item_string, [" of the faction's ", " items", " to refill their "], trim: true)
+
+    case split_item_string do
+      ["one", item_name] ->
+        %{
+          action: :use,
+          quantity: 1,
+          item_name: item_name
+        }
+
+      [count, "points", "energy"] ->
+        %{
+          action: :use,
+          quantity: String.to_integer(count),
+          item_name: :energy_refill
+        }
+
+      [count, "points", "nerve"] ->
+        # eg: "<a href = \"http://www.torn.com/profiles.php?XID=2383326\">tiksan</a> used 30 of the faction's points to refill their nerve"
+        %{
+          action: :use,
+          quantity: String.to_integer(count),
+          item_name: :nerve_refill
+        }
+    end
+  end
+
+  defp text_action_item("filled one of the faction's " <> suffixed_item_string = text) when is_binary(text) do
+    [item_name] = String.split(suffixed_item_string, " items", trim: true)
+
+    %{
+      action: :fill,
+      quantity: 1,
+      item_name: item_name
+    }
+  end
+
+  defp text_action_item("loaned " <> suffixed_item_string = text) when is_binary(text) do
+    [item_name_quantity, _recipient] =
+      String.split(suffixed_item_string, [" to ", " from the faction armory"], trim: true)
+
+    # loaned 1x Thompson to themselves from the faction armory
+    [item_quantity, item_name] = String.split(item_name_quantity, "x ", trim: true)
+
+    %{
+      action: :loan,
+      quantity: String.to_integer(item_quantity),
+      item_name: item_name
+    }
+  end
+
+  defp text_action_item("returned " <> item_name_quantity = text) when is_binary(text) do
+    [item_quantity, item_name] = String.split(item_name_quantity, "x ", trim: true)
+
+    %{
+      action: :return,
+      quantity: String.to_integer(item_quantity),
+      item_name: item_name
+    }
+  end
+end

worker/lib/faction/news/news.ex

@@ -0,0 +1,40 @@
+# Copyright (C) 2021-2025 tiksan
+# 
+# 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.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+defmodule Tornium.Faction.News do
+  @moduledoc """
+  Parser for faction news data from `faction/news`.
+  """
+
+  @doc """
+  Parse a faction news for a specific category.
+  """
+  @spec parse(
+          category :: Torngen.Client.Schema.FactionNewsCategory.t(),
+          news_data :: [Torngen.Client.Schema.FactionNews.t()]
+        ) :: [struct()]
+  def parse("armoryAction", [%Torngen.Client.Schema.FactionNews{} | _] = news_data) do
+    Enum.map(news_data, &Tornium.Faction.News.ArmoryAction.parse/1)
+  end
+
+  def parse(_category, [] = _news_data) do
+    []
+  end
+
+  @doc """
+  Parse a faction news struct from Torn for a specific category.
+  """
+  @callback parse(news :: Torngen.Client.Schema.FactionNews.t()) :: struct()
+end