FREE NoHarvestJunk : 1.0.0 1.0.0

/*
 * Copyright (C) 2025 Game4Freak.io
 * This mod is provided under the Game4Freak EULA.
 * Full legal terms can be found at https://game4freak.io/eula/
 */

using Newtonsoft.Json;
using Oxide.Core;
using System.Collections.Generic;
using UnityEngine;

namespace Oxide.Plugins
{
    [Info("No Harvest Junk", "VisEntities", "1.0.0")]
    [Description("Prevents unwanted junk items (grubs, worms, seeds) from being given when harvesting growables.")]
    public class NoHarvestJunk : RustPlugin
    {
        #region Fields

        private static NoHarvestJunk _plugin;
        private static Configuration _config;
        private StoredData _storedData;
        private HashSet<string> _blockedItemsSet;

        #endregion Fields

        #region Configuration

        private class Configuration
        {
            [JsonProperty("Version")]
            public string Version { get; set; }

            [JsonProperty("Chat Command")]
            public string ChatCommand { get; set; }

            [JsonProperty("Blocked Items (shortnames)")]
            public List<string> BlockedItems { get; set; }

            [JsonProperty("Default Enabled For New Players")]
            public bool DefaultEnabledForNewPlayers { get; set; }

            [JsonProperty("Show Blocked Message")]
            public bool ShowBlockedMessage { get; set; }

            [JsonProperty("Use Toast Notification (false = chat message)")]
            public bool UseToastNotification { get; set; }
        }

        protected override void LoadConfig()
        {
            base.LoadConfig();
            _config = Config.ReadObject<Configuration>();

            if (string.Compare(_config.Version, Version.ToString()) < 0)
                UpdateConfig();

            SaveConfig();
        }

        protected override void LoadDefaultConfig()
        {
            _config = GetDefaultConfig();
        }

        protected override void SaveConfig()
        {
            Config.WriteObject(_config, true);
        }

        private void UpdateConfig()
        {
            PrintWarning("Config changes detected! Updating...");

            Configuration defaultConfig = GetDefaultConfig();

            if (string.Compare(_config.Version, "1.0.0") < 0)
                _config = defaultConfig;

            PrintWarning("Config update complete! Updated from version " + _config.Version + " to " + Version.ToString());
            _config.Version = Version.ToString();
        }

        private Configuration GetDefaultConfig()
        {
            return new Configuration
            {
                Version = Version.ToString(),
                ChatCommand = "nhj",
                BlockedItems = new List<string>
                {
                    "grub",
                    "worm",
                    "seed.hemp",
                    "seed.corn",
                    "seed.potato",
                    "seed.pumpkin",
                    "seed.berry.blue",
                    "seed.berry.green",
                    "seed.berry.red",
                    "seed.berry.white",
                    "seed.berry.yellow"
                },
                DefaultEnabledForNewPlayers = true,
                ShowBlockedMessage = true,
                UseToastNotification = true
            };
        }

        #endregion Configuration

        #region Stored Data

        public class StoredData
        {
            [JsonProperty("Player Preferences")]
            public Dictionary<ulong, bool> PlayerPreferences { get; set; } = new Dictionary<ulong, bool>();
        }

        private void LoadData()
        {
            _storedData = Interface.Oxide.DataFileSystem.ReadObject<StoredData>(Name);
            if (_storedData == null)
                _storedData = new StoredData();
        }

        private void SaveData()
        {
            Interface.Oxide.DataFileSystem.WriteObject(Name, _storedData);
        }

        #endregion Stored Data

        #region Oxide Hooks

        private void Init()
        {
            _plugin = this;
            PermissionUtil.RegisterPermissions();
            LoadData();
            BuildBlockedItemsSet();
            cmd.AddChatCommand(_config.ChatCommand, this, nameof(cmdToggle));
        }

        private void Unload()
        {
            SaveData();
            _config = null;
            _plugin = null;
        }

        private object OnRandomItemAward(RandomItemDispenser dispenser, RandomItemDispenser.RandomItemChance itemChance, BasePlayer player, Vector3 position)
        {
            if (player == null)
                return null;

            if (!IsEnabledForPlayer(player))
                return null;

            string shortname = itemChance.Item.shortname;

            if (_blockedItemsSet.Contains(shortname))
            {
                if (_config.ShowBlockedMessage)
                    NotifyBlocked(player, itemChance.Item.displayName.english);

                return true;
            }

            return null;
        }

        #endregion Oxide Hooks

        #region Helper Functions

        private void BuildBlockedItemsSet()
        {
            _blockedItemsSet = new HashSet<string>();
            foreach (string item in _config.BlockedItems)
            {
                _blockedItemsSet.Add(item);
            }
        }

        private bool IsEnabledForPlayer(BasePlayer player)
        {
            if (_storedData.PlayerPreferences.TryGetValue(player.userID, out bool enabled))
                return enabled;

            return _config.DefaultEnabledForNewPlayers;
        }

        private void SetEnabledForPlayer(BasePlayer player, bool enabled)
        {
            _storedData.PlayerPreferences[player.userID] = enabled;
            SaveData();
        }

        private void NotifyBlocked(BasePlayer player, string itemName)
        {
            string message = GetMessage(player, Lang.Item_Blocked, itemName);

            if (_config.UseToastNotification)
                player.SendConsoleCommand("gametip.showtoast", (int)GameTip.Styles.Blue_Normal, message);
            else
                SendReply(player, message);
        }

        #endregion Helper Functions

        #region Permissions

        private static class PermissionUtil
        {
            public const string USE = "noharvestjunk.use";

            private static readonly List<string> _permissions = new List<string>
            {
                USE,
            };

            public static void RegisterPermissions()
            {
                foreach (string perm in _permissions)
                    _plugin.permission.RegisterPermission(perm, _plugin);
            }

            public static bool HasPermission(BasePlayer player, string permission)
            {
                return _plugin.permission.UserHasPermission(player.UserIDString, permission);
            }
        }

        #endregion Permissions

        #region Commands
        
        private void cmdToggle(BasePlayer player, string cmd, string[] args)
        {
            if (player == null)
                return;

            if (!PermissionUtil.HasPermission(player, PermissionUtil.USE))
            {
                SendReplyLocalized(player, Lang.Error_NoPermission);
                return;
            }

            bool currentState = IsEnabledForPlayer(player);
            bool newState = !currentState;

            SetEnabledForPlayer(player, newState);

            if (newState)
                SendReplyLocalized(player, Lang.Filter_Enabled);
            else
                SendReplyLocalized(player, Lang.Filter_Disabled);
        }

        #endregion Commands

        #region Localization

        private class Lang
        {
            public const string Error_NoPermission = "Error.NoPermission";
            public const string Filter_Enabled = "Filter.Enabled";
            public const string Filter_Disabled = "Filter.Disabled";
            public const string Item_Blocked = "Item.Blocked";
        }

        protected override void LoadDefaultMessages()
        {
            lang.RegisterMessages(new Dictionary<string, string>
            {
                [Lang.Error_NoPermission] = "You do not have permission to use this command.",
                [Lang.Filter_Enabled] = "Harvest junk filter <color=#8BC34A>enabled</color>. You will no longer receive junk items.",
                [Lang.Filter_Disabled] = "Harvest junk filter <color=#F44336>disabled</color>. You will now receive all harvest items.",
                [Lang.Item_Blocked] = "Blocked: {0}"
            }, this, "en");
        }

        private static string GetMessage(BasePlayer player, string messageKey, params object[] args)
        {
            string userId;
            if (player != null)
                userId = player.UserIDString;
            else
                userId = null;

            string message = _plugin.lang.GetMessage(messageKey, _plugin, userId);

            if (args.Length > 0)
                message = string.Format(message, args);

            return message;
        }

        public static void SendReplyLocalized(BasePlayer player, string messageKey, params object[] args)
        {
            string message = GetMessage(player, messageKey, args);

            if (!string.IsNullOrWhiteSpace(message))
                _plugin.SendReply(player, message);
        }

        #endregion Localization
    }
}