Rules.cpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  1. /*
  2. EQ2Emulator: Everquest II Server Emulator
  3. Copyright (C) 2007 EQ2EMulator Development Team (http://www.eq2emulator.net)
  4. This file is part of EQ2Emulator.
  5. EQ2Emulator is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 3 of the License, or
  8. (at your option) any later version.
  9. EQ2Emulator is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with EQ2Emulator. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #include <assert.h>
  17. #include "../../common/debug.h"
  18. #include "../../common/Log.h"
  19. #include "../../common/database.h"
  20. #include "Rules.h"
  21. extern RuleManager rule_manager;
  22. Rule::Rule() {
  23. category = 0;
  24. type = 0;
  25. strncpy(value, "", sizeof(value));
  26. strncpy(combined, "NONE", sizeof(combined));
  27. }
  28. Rule::Rule(int32 category, int32 type, const char *value, const char *combined) {
  29. this->category = category;
  30. this->type = type;
  31. strncpy(this->value, value, sizeof(this->value));
  32. strncpy(this->combined, combined, sizeof(this->combined));
  33. }
  34. Rule::Rule (Rule *rule_in) {
  35. category = rule_in->GetCategory();
  36. type = rule_in->GetType();
  37. strncpy(value, rule_in->GetValue(), sizeof(value));
  38. strncpy(combined, rule_in->GetCombined(), sizeof(combined));
  39. }
  40. Rule::~Rule() {
  41. }
  42. RuleSet::RuleSet() {
  43. id = 0;
  44. memset(name, 0, sizeof(name));
  45. m_rules.SetName("RuleSet::rules");
  46. }
  47. RuleSet::RuleSet(RuleSet *in_rule_set) {
  48. assert(in_rule_set);
  49. map<int32, map<int32, Rule *> > * in_rules = in_rule_set->GetRules();
  50. map<int32, map<int32, Rule *> >::iterator itr;
  51. map<int32, Rule *>::iterator itr2;
  52. Rule * rule;
  53. m_rules.SetName("RuleSet::rules");
  54. id = in_rule_set->GetID();
  55. strncpy(name, in_rule_set->GetName(), sizeof(name));
  56. for (itr = in_rules->begin(); itr != in_rules->end(); itr++) {
  57. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++) {
  58. rule = itr2->second;
  59. rules[rule->GetCategory()][rule->GetType()] = new Rule(rule);
  60. }
  61. }
  62. }
  63. RuleSet::~RuleSet() {
  64. ClearRules();
  65. }
  66. void RuleSet::CopyRulesInto(RuleSet *in_rule_set) {
  67. assert(in_rule_set);
  68. map<int32, map<int32, Rule *> > * in_rules = in_rule_set->GetRules();
  69. map<int32, map<int32, Rule *> >::iterator itr;
  70. map<int32, Rule *>::iterator itr2;
  71. Rule * rule;
  72. ClearRules();
  73. m_rules.writelock(__FUNCTION__, __LINE__);
  74. for (itr = in_rules->begin(); itr != in_rules->end(); itr++) {
  75. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++) {
  76. rule = itr2->second;
  77. rules[rule->GetCategory()][rule->GetType()] = new Rule(rule);
  78. }
  79. }
  80. m_rules.releasewritelock(__FUNCTION__, __LINE__);
  81. }
  82. void RuleSet::AddRule(Rule *rule) {
  83. int32 category, type;
  84. assert(rule);
  85. category = rule->GetCategory();
  86. type = rule->GetType();
  87. m_rules.writelock(__FUNCTION__, __LINE__);
  88. if (rules[category].count(type) == 0)
  89. rules[category][type] = rule;
  90. else
  91. rules[category][type]->SetValue(rule->GetValue());
  92. m_rules.releasewritelock(__FUNCTION__, __LINE__);
  93. }
  94. Rule * RuleSet::GetRule(int32 category, int32 type) {
  95. Rule *ret = 0;
  96. m_rules.readlock(__FUNCTION__, __LINE__);
  97. if (rules[category].count(type) > 0)
  98. ret = rules[category][type];
  99. m_rules.releasereadlock(__FUNCTION__, __LINE__);
  100. if (!ret)
  101. ret = rule_manager.GetBlankRule();
  102. LogWrite(RULESYS__DEBUG, 5, "Rules", "Rule: %s, Value: %s", ret->GetCombined(), ret->GetValue());
  103. return ret;
  104. }
  105. Rule * RuleSet::GetRule(const char *category, const char *type) {
  106. map<int32, map<int32, Rule *> >::iterator itr;
  107. map<int32, Rule *>::iterator itr2;
  108. char combined[256];
  109. Rule *ret = 0;
  110. snprintf(combined, sizeof(combined), "%s:%s", category, type);
  111. // Zero terminate ([max - 1] = 0) to prevent a warning/error
  112. combined[255] = 0;
  113. m_rules.readlock(__FUNCTION__, __LINE__);
  114. for (itr = rules.begin(); itr != rules.end(); itr++) {
  115. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++) {
  116. if (!strcmp(itr2->second->GetCombined(), combined)) {
  117. ret = itr2->second;
  118. break;
  119. }
  120. }
  121. }
  122. m_rules.releasereadlock(__FUNCTION__, __LINE__);
  123. return ret;
  124. }
  125. void RuleSet::ClearRules() {
  126. map<int32, map<int32, Rule *> >::iterator itr;
  127. map<int32, Rule *>::iterator itr2;
  128. m_rules.writelock(__FUNCTION__, __LINE__);
  129. for (itr = rules.begin(); itr != rules.end(); itr++) {
  130. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++)
  131. safe_delete(itr2->second);
  132. }
  133. rules.clear();
  134. m_rules.releasewritelock(__FUNCTION__, __LINE__);
  135. }
  136. RuleManager::RuleManager() {
  137. m_rule_sets.SetName("RuleManager::rule_sets");
  138. m_global_rule_set.SetName("RuleManager::global_rule_set");
  139. m_zone_rule_sets.SetName("RuleManager::zone_rule_sets");
  140. Init();
  141. }
  142. RuleManager::~RuleManager() {
  143. Flush();
  144. }
  145. void RuleManager::Init()
  146. {
  147. #define RULE_INIT(category, type, value) rules[category][type] = new Rule(category, type, value, #category ":" #type)
  148. /* CLIENT */
  149. RULE_INIT(R_Client, ShowWelcomeScreen, "0");
  150. RULE_INIT(R_Client, GroupSpellsTimer, "1000");
  151. /* FACTION */
  152. RULE_INIT(R_Faction, AllowFactionBasedCombat, "1");
  153. /* GUILD */
  154. RULE_INIT(R_Guild, MaxLevel, "50");
  155. RULE_INIT(R_Guild, MaxPlayers, "-1");
  156. /* PLAYER */
  157. RULE_INIT(R_Player, MaxLevel, "50");
  158. RULE_INIT(R_Player, MaxLevelOverrideStatus, "100");
  159. RULE_INIT(R_Player, VitalityAmount, ".5");
  160. RULE_INIT(R_Player, VitalityFrequency, "3600");
  161. RULE_INIT(R_Player, XPMultiplier, "1.0");
  162. RULE_INIT(R_Player, TSXPMultiplier, "1.0");
  163. RULE_INIT(R_Player, MaxAA, "320");
  164. RULE_INIT(R_Player, MaxClassAA, "100");
  165. RULE_INIT(R_Player, MaxSubclassAA, "100");
  166. RULE_INIT(R_Player, MaxShadowsAA, "70");
  167. RULE_INIT(R_Player, MaxHeroicAA, "50");
  168. RULE_INIT(R_Player, MaxTradeskillAA, "40");
  169. RULE_INIT(R_Player, MaxPrestigeAA, "25");
  170. RULE_INIT(R_Player, MaxTradeskillPrestigeAA, "25");
  171. RULE_INIT(R_Player, MinLastNameLevel, "20");
  172. RULE_INIT(R_Player, MaxLastNameLength, "20");
  173. RULE_INIT(R_Player, MinLastNameLength, "4");
  174. /* PVP */
  175. RULE_INIT(R_PVP, AllowPVP, "0");
  176. RULE_INIT(R_PVP, LevelRange, "4");
  177. RULE_INIT(R_PVP, InvisPlayerDiscoveryRange, "20"); // value > 0 sets radius inner to see, = 0 means always seen, -1 = never seen
  178. /* COMBAT */
  179. RULE_INIT(R_Combat, MaxCombatRange, "4.0");
  180. /* SPAWN */
  181. RULE_INIT(R_Spawn, SpeedMultiplier, "300"); // note: this value was 1280 until 6/1/2009, then was 600 til Sep 2009, when it became 300...?
  182. //RULE_INIT(R_Spawn, SpeedRatio, "0"); // was 1280/7.5 and 600/7.5 until it became 300.
  183. /* TIMER */
  184. /* UI */
  185. RULE_INIT(R_UI, MaxWhoResults, "20");
  186. RULE_INIT(R_UI, MaxWhoOverrideStatus, "200");
  187. /* WORLD */
  188. RULE_INIT(R_World, DefaultStartingZoneID, "1");
  189. RULE_INIT(R_World, EnablePOIDiscovery, "0");
  190. RULE_INIT(R_World, GamblingTokenItemID, "2");
  191. RULE_INIT(R_World, GuildAutoJoin, "0");
  192. RULE_INIT(R_World, GuildAutoJoinID, "1");
  193. RULE_INIT(R_World, GuildAutoJoinDefaultRankID, "7");
  194. RULE_INIT(R_World, MaxPlayers, "-1");
  195. RULE_INIT(R_World, MaxPlayersOverrideStatus, "100");
  196. RULE_INIT(R_World, ServerLocked, "0");
  197. RULE_INIT(R_World, ServerLockedOverrideStatus, "10");
  198. RULE_INIT(R_World, SyncZonesWithLogin, "1");
  199. RULE_INIT(R_World, SyncEquipWithLogin, "1");
  200. RULE_INIT(R_World, UseBannedIPsTable, "0");
  201. RULE_INIT(R_World, LinkDeadTimer, "120000"); // default: 2 minutes
  202. RULE_INIT(R_World, RemoveDisconnectedClientsTimer, "30000"); // default: 30 seconds
  203. RULE_INIT(R_World, PlayerCampTimer, "20"); // default: 20 seconds
  204. RULE_INIT(R_World, GMCampTimer, "1"); // default: 1 second
  205. RULE_INIT(R_World, AutoAdminPlayers, "0"); // default: No
  206. RULE_INIT(R_World, AutoAdminGMs, "0"); // default: No
  207. RULE_INIT(R_World, AutoAdminStatusValue, "10"); // default: 10 (CSR)
  208. RULE_INIT(R_World, DuskTime, "20:00"); // default: 8pm
  209. RULE_INIT(R_World, DawnTime, "8:00"); // default: 8am
  210. RULE_INIT(R_World, ThreadedLoad, "0"); // default: no threaded loading
  211. RULE_INIT(R_World, TradeskillSuccessChance, "87.0"); // default: 87% chance of success while crafting
  212. RULE_INIT(R_World, TradeskillCritSuccessChance, "2.0"); // default: 2% chance of critical success while crafting
  213. RULE_INIT(R_World, TradeskillFailChance, "10.0"); // default: 10% chance of failure while crafting
  214. RULE_INIT(R_World, TradeskillCritFailChance, "1.0"); // default: 1% chance of critical failure while crafting
  215. RULE_INIT(R_World, TradeskillEventChance, "15.0"); // default: 15% chance of a tradeskill event while crafting
  216. RULE_INIT(R_World, EditorURL, "www.eq2emulator.net"); // default: www.eq2emulator.net
  217. RULE_INIT(R_World, EditorIncludeID, "0"); // default: 0 (0 = disabled, 1 = enabled)
  218. RULE_INIT(R_World, EditorOfficialServer, "0"); // default: 0 (0 = disabled, 1 = enabled)
  219. RULE_INIT(R_World, IRCEnabled, "0"); // default: 0 (0 = disabled, 1 = enabled)
  220. RULE_INIT(R_World, IRCGlobalEnabled, "0"); // default: 0 (0 = disabled, 1 = enabled)
  221. RULE_INIT(R_World, IRCAddress, "irc.eq2emulator.net"); // default: irc.eq2emulator.net
  222. RULE_INIT(R_World, IRCPort, "6667"); // default: 6667
  223. RULE_INIT(R_World, IRCChan, "#EQ2Emu"); // default: #EQ2Emu
  224. RULE_INIT(R_World, SavePaperdollImage, "1"); // default: true
  225. RULE_INIT(R_World, SaveHeadshotImage, "1"); // default: true
  226. RULE_INIT(R_World, SendPaperdollImagesToLogin, "1"); // default: true
  227. RULE_INIT(R_World, TreasureChestDisabled, "0"); // default: false
  228. RULE_INIT(R_World, StartingZoneRuleFlag, "0"); // default: 0 - match any options available, just based on version/other fields (will not force qc/outpost)
  229. // 1 - force split zones on alignment/deity despite client selection (queens colony/overlord outpost)
  230. // 2 - (isle of refuge)
  231. // 4 - send to 'new' starting zones, won't support old clients
  232. // 5+ - send to new and old starting zones as needed
  233. //INSERT INTO `ruleset_details`(`id`, `ruleset_id`, `rule_category`, `rule_type`, `rule_value`, `description`) VALUES (NULL, '1', 'R_World', '', '', '')
  234. /* ZONE */
  235. RULE_INIT(R_Zone, MaxPlayers, "100");
  236. RULE_INIT(R_Zone, MinZoneLevelOverrideStatus, "1");
  237. RULE_INIT(R_Zone, MinZoneAccessOverrideStatus, "100");
  238. RULE_INIT(R_Zone, WeatherEnabled, "1"); // default: 1 (0 = disabled, 1 = enabled)
  239. RULE_INIT(R_Zone, WeatherType, "0"); // default: 1 (0 = normal, 1 = dynamic, 2 = random, 3 = chaotic)
  240. RULE_INIT(R_Zone, MinWeatherSeverity, "0.0"); // default: 0.0 or no weather
  241. RULE_INIT(R_Zone, MaxWeatherSeverity, "1.0"); // default: 1.0 or hard rain (range 0.0 - 1.0, rain starts at 0.75)
  242. RULE_INIT(R_Zone, WeatherChangeFrequency, "300"); // default: 5 minutes
  243. RULE_INIT(R_Zone, WeatherChangePerInterval, "0.02"); // default: 0.02 (slight changes)
  244. RULE_INIT(R_Zone, WeatherChangeChance, "20"); // default: 20% (in whole percents)
  245. RULE_INIT(R_Zone, WeatherDynamicMaxOffset, "0.08"); // default: 0.08 - dynamic weather changes can only change this max amount
  246. RULE_INIT(R_Zone, SpawnUpdateTimer, "50"); // default: 50ms - how often to check for spawn update sends
  247. RULE_INIT(R_Zone, CheckAttackNPC, "2000"); // default: 2 seconds, how often to for NPCs to attack eachother
  248. RULE_INIT(R_Zone, CheckAttackPlayer, "2000"); // default: 2 seconds, how often to check for NPCs to attack players
  249. RULE_INIT(R_Zone, HOTime, "10.0"); // default: 10 seconds, time to complete the HO wheel before it expires
  250. /* ZONE TIMERS */
  251. RULE_INIT(R_Zone, RegenTimer, "6000");
  252. RULE_INIT(R_Zone, ClientSaveTimer, "60000");
  253. RULE_INIT(R_Zone, DefaultZoneShutdownTimer, "300000");
  254. RULE_INIT(R_Zone, WeatherTimer, "60000"); // default: 1 minute
  255. RULE_INIT(R_Zone, SpawnDeleteTimer, "30000"); // default: 30 seconds, how long a spawn pointer is held onto after being removed from the world before deleting it
  256. RULE_INIT(R_Loot, LootRadius, "5.0");
  257. RULE_INIT(R_Loot, AutoDisarmChest, "1");
  258. RULE_INIT(R_Loot, ChestTriggerRadiusGroup, "10.0"); // radius at which chest will trigger against group members
  259. RULE_INIT(R_Spells, NoInterruptBaseChance, "50");
  260. RULE_INIT(R_Expansion, GlobalExpansionFlag, "0");
  261. RULE_INIT(R_Expansion, GlobalHolidayFlag, "0");
  262. RULE_INIT(R_World, DatabaseVersion, "0");
  263. #undef RULE_INIT
  264. }
  265. void RuleManager::Flush(bool reinit)
  266. {
  267. map<int32, map<int32, Rule*> >::iterator itr;
  268. map<int32, Rule*>::iterator itr2;
  269. for (itr = rules.begin(); itr != rules.end(); itr++) {
  270. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++)
  271. safe_delete(itr2->second);
  272. }
  273. rules.clear();
  274. ClearRuleSets();
  275. ClearZoneRuleSets();
  276. if (reinit)
  277. Init();
  278. }
  279. void RuleManager::LoadCodedDefaultsIntoRuleSet(RuleSet *rule_set) {
  280. map<int32, map<int32, Rule *> >::iterator itr;
  281. map<int32, Rule *>::iterator itr2;
  282. assert(rule_set);
  283. for (itr = rules.begin(); itr != rules.end(); itr++) {
  284. for (itr2 = itr->second.begin(); itr2 != itr->second.end(); itr2++)
  285. rule_set->AddRule(new Rule(itr2->second));
  286. }
  287. }
  288. bool RuleManager::AddRuleSet(RuleSet *rule_set) {
  289. bool ret = false;
  290. int32 id;
  291. assert(rule_set);
  292. id = rule_set->GetID();
  293. m_rule_sets.writelock(__FUNCTION__, __LINE__);
  294. if (rule_sets.count(id) == 0) {
  295. rule_sets[id] = rule_set;
  296. ret = true;
  297. }
  298. m_rule_sets.releasewritelock(__FUNCTION__, __LINE__);
  299. return ret;
  300. }
  301. int32 RuleManager::GetNumRuleSets() {
  302. int32 ret;
  303. m_rule_sets.readlock(__FUNCTION__, __LINE__);
  304. ret = rule_sets.size();
  305. m_rule_sets.releasereadlock(__FUNCTION__, __LINE__);
  306. return ret;
  307. }
  308. void RuleManager::ClearRuleSets() {
  309. map<int32, RuleSet *>::iterator itr;
  310. m_rule_sets.writelock(__FUNCTION__, __LINE__);
  311. for (itr = rule_sets.begin(); itr != rule_sets.end(); itr++)
  312. safe_delete(itr->second);
  313. rule_sets.clear();
  314. m_rule_sets.releasewritelock(__FUNCTION__, __LINE__);
  315. }
  316. bool RuleManager::SetGlobalRuleSet(int32 rule_set_id) {
  317. if (rule_sets.count(rule_set_id) == 0)
  318. return false;
  319. global_rule_set.CopyRulesInto(rule_sets[rule_set_id]);
  320. return true;
  321. }
  322. Rule * RuleManager::GetGlobalRule(int32 category, int32 type) {
  323. return global_rule_set.GetRule(category, type);
  324. }
  325. Rule * RuleManager::GetGlobalRule(const char* category, const char* type) {
  326. return global_rule_set.GetRule(category, type);
  327. }
  328. bool RuleManager::SetZoneRuleSet(int32 zone_id, int32 rule_set_id) {
  329. bool ret = true;
  330. RuleSet *rule_set;
  331. m_rule_sets.readlock(__FUNCTION__, __LINE__);
  332. if (rule_sets.count(rule_set_id) == 0)
  333. ret = false;
  334. rule_set = rule_sets[rule_set_id];
  335. if (ret) {
  336. m_zone_rule_sets.writelock(__FUNCTION__, __LINE__);
  337. zone_rule_sets[zone_id] = rule_set;
  338. m_zone_rule_sets.releasewritelock(__FUNCTION__, __LINE__);
  339. }
  340. m_rule_sets.releasereadlock(__FUNCTION__, __LINE__);
  341. return ret;
  342. }
  343. Rule * RuleManager::GetZoneRule(int32 zone_id, int32 category, int32 type) {
  344. Rule *ret = 0;
  345. /* we never want to return null so MAKE SURE the rule exists. if this assertion fails then the server admin must fix the problem */
  346. assert(rules.count(category) > 0);
  347. assert(rules[category].count(type) > 0);
  348. /* first try to get the zone rule */
  349. m_zone_rule_sets.readlock(__FUNCTION__, __LINE__);
  350. if (zone_rule_sets.count(zone_id) > 0)
  351. ret = zone_rule_sets[zone_id]->GetRule(category, type);
  352. m_zone_rule_sets.releasereadlock(__FUNCTION__, __LINE__);
  353. return ret ? ret : rules[category][type];
  354. }
  355. void RuleManager::ClearZoneRuleSets() {
  356. m_zone_rule_sets.writelock(__FUNCTION__, __LINE__);
  357. zone_rule_sets.clear();
  358. m_zone_rule_sets.releasewritelock(__FUNCTION__, __LINE__);
  359. }