Add dependency injection to MySql{Database,Properties} (#924)

Closes #922.
smrealms · Dec 13, 2020 · fc4bd93 · fc4bd93
1 parent 613786e
commit fc4bd93
Show file tree

Hide file tree

Showing 99 changed files with 982 additions and 639 deletions.
diff --git a/admin/Default/1.6/game_create_processing.php b/admin/Default/1.6/game_create_processing.php
@@ -57,7 +57,7 @@
 forward($container);
 
 function createNHA($gameID) {
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 	// create the Newbie Help Alliance
 	$db->query('REPLACE INTO alliance (alliance_id, game_id, alliance_name, alliance_description, alliance_password, leader_id, `mod`, recruiting) VALUES

diff --git a/admin/Default/changelog.php b/admin/Default/changelog.php
@@ -6,7 +6,7 @@
 $template->assign('ChangeMessage', $var['change_message'] ?? '');
 $template->assign('AffectedDb', $var['affected_db'] ?? '');
 
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 $first_entry = true;
 $link_set_live = true;
 

diff --git a/admin/Default/comp_share.php b/admin/Default/comp_share.php
@@ -8,7 +8,7 @@
 $skipExceptions = false;
 
 //extra db object and other vars
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 $used = array();
 
 //check the db and get the info we need

diff --git a/admin/Default/game_delete_processing.php b/admin/Default/game_delete_processing.php
@@ -3,7 +3,7 @@
 create_error('Deleting games is disabled!');
 
 // additional db objects
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 
 $smr_db_sql = array();
 $history_db_sql = array();
@@ -291,9 +291,9 @@
 
 	// don't know why exactly we have to do that,
 	// but it seems that the db is used globally instead kept to each object
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 }
-$db = new SmrMySqlDatabase();
+$db = MySqlDatabase::getInstance();
 //forward em
 forward(create_container('skeleton.php', 'admin_tools.php'));
diff --git a/admin/Default/ip_view_results.php b/admin/Default/ip_view_results.php
@@ -2,7 +2,7 @@
 $variable = SmrSession::getRequestVar('variable');
 $type = SmrSession::getRequestVar('type');
 
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 
 $container = create_container('skeleton.php', 'ip_view.php');
 $template->assign('BackHREF', SmrSession::getNewHREF($container));

diff --git a/admin/Default/log_console.php b/admin/Default/log_console.php
@@ -9,7 +9,7 @@
 			JOIN account USING(account_id)
 			GROUP BY account_id');
 if ($db->getNumRows()) {
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	while ($db->nextRecord()) {
 		$accountID = $db->getInt('account_id');
 		$loggedAccounts[$accountID] = array('AccountID' => $accountID,

diff --git a/admin/Default/newsletter_send.php b/admin/Default/newsletter_send.php
@@ -6,7 +6,7 @@
 $processingContainer = create_container('newsletter_send_processing.php');
 
 // Get the most recent newsletter text for preview
-$db = new SmrMySqlDatabase();
+$db = MySqlDatabase::getInstance();
 $db->query('SELECT newsletter_id, newsletter_html, newsletter_text FROM newsletter ORDER BY newsletter_id DESC LIMIT 1');
 if ($db->nextRecord()) {
 	$id = $db->getInt('newsletter_id');

diff --git a/composer.json b/composer.json
@@ -12,9 +12,16 @@
 		"php": "^7.4",
 		"phpmailer/phpmailer": "^6.1",
 		"vanilla/nbbc": "^2.0",
-		"vlucas/phpdotenv": "^v5.2.0"
+		"vlucas/phpdotenv": "^v5.2.0",
+		"php-di/php-di": "6.3.0"
+	},
+	"autoload": {
+		"psr-0": {
+			"Smr\\": "lib/"
+		}
 	},
 	"scripts": {
+		"start:dev": "docker-compose up --build -d traefik smr-dev",
 		"start:integration-services": [
 			"docker-compose --env-file test.env up -d mysql-integration-test",
 			"sleep 20",
@@ -24,7 +31,11 @@
 			"docker-compose stop",
 			"docker-compose rm --force"
 		],
-		"test": "docker-compose --env-file test.env run --rm smr-integration-test"
+		"test": "docker-compose --env-file test.env run --rm smr-integration-test",
+		"rebuild:dev": [
+			"@stop",
+			"@start:dev"
+		]
 	},
 	"autoload-dev": {
 		"psr-0": {

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -84,6 +84,8 @@ services:
             - ./htdocs:/smr/htdocs
             - ./lib:/smr/lib
             - ./templates:/smr/templates
+        environment:
+            DISABLE_PHPDI_COMPILATION: "true"
 
     smtp:
         image: hemberger/postfix-relay

diff --git a/engine/Default/alliance_message.php b/engine/Default/alliance_message.php
@@ -36,7 +36,7 @@
 $db->query($query);
 $threads = array();
 if ($db->getNumRows() > 0) {
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 
 	$container = create_container('alliance_message_delete_processing.php');
 	$container['alliance_id'] = $alliance->getAllianceID();
@@ -52,15 +52,15 @@
 		$thread_topics[$i] = $db->getField('topic');
 
 		$threads[$i]['Topic'] = $db->getField('topic');
-		
+
 		$db2->query('SELECT time
-					FROM player_read_thread 
+					FROM player_read_thread
 					WHERE ' . $player->getSQL() . '
 					AND alliance_id =' . $db2->escapeNumber($alliance->getAllianceID()) . '
 					AND thread_id=' . $db2->escapeNumber($threadID) . '
 					AND time>' . $db2->escapeNumber($db->getInt('sendtime')) . ' LIMIT 1');
 		$threads[$i]['Unread'] = $db2->getNumRows() == 0;
-		
+
 		// Determine the thread author display name
 		$sender_id = $db->getInt('sender_id');
 		if ($sender_id == ACCOUNT_ID_PLANET) {

diff --git a/engine/Default/alliance_mod.php b/engine/Default/alliance_mod.php
@@ -18,7 +18,7 @@
 	$template->assign('OpTime', $db->getInt('time'));
 
 	// Has player responded yet?
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	$db2->query('SELECT response FROM alliance_has_op_response WHERE alliance_id=' . $db2->escapeNumber($player->getAllianceID()) . ' AND ' . $player->getSQL() . ' LIMIT 1');
 
 	$response = $db2->nextRecord() ? $db2->getField('response') : null;

diff --git a/engine/Default/bank_anon.php b/engine/Default/bank_anon.php
@@ -18,7 +18,7 @@
 			AND game_id=' . $db->escapeNumber($player->getGameID()));
 
 $ownedAnon = [];
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 while ($db->nextRecord()) {
 	$anon = [];
 	$anon['anon_id'] = $db->getInt('anon_id');
@@ -33,7 +33,7 @@
 	} else {
 		$anon['last_transaction'] = 'No transactions';
 	}
-	
+
 	$container['account_num'] = $anon['anon_id'];
 	$container['password'] = $anon['password'];
 	$anon['href'] = SmrSession::getNewHREF($container);

diff --git a/engine/Default/changelog_view.php b/engine/Default/changelog_view.php
@@ -7,7 +7,7 @@
 	$template->assign('ContinueHREF', SmrSession::getNewHREF($container));
 }
 
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 
 $db->query('SELECT *
 			FROM version

diff --git a/engine/Default/council_vote.php b/engine/Default/council_vote.php
@@ -40,7 +40,7 @@
 			AND race_id_1 = ' . $db->escapeNumber($player->getRaceID()));
 if ($db->getNumRows() > 0) {
 
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 
 	while ($db->nextRecord()) {
 		$otherRaceID = $db->getInt('race_id_2');

diff --git a/engine/Default/current_players.php b/engine/Default/current_players.php
@@ -51,7 +51,7 @@
 
 $allRows = array();
 if ($count_last_active > 0) {
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	while ($db->nextRecord()) {
 		$row = array();
 

diff --git a/engine/Default/feature_request.php b/engine/Default/feature_request.php
@@ -61,7 +61,7 @@
 
 	$commentsContainer = $var;
 	$commentsContainer['body'] = 'feature_request_comments.php';
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	$featureRequests = array();
 	while ($db->nextRecord()) {
 		$featureRequestID = $db->getInt('feature_request_id');

diff --git a/engine/Default/galactic_post.php b/engine/Default/galactic_post.php
@@ -7,7 +7,7 @@
 $template->assign('PageTopic', 'Galactic Post');
 Menu::galactic_post();
 
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 
 $container = create_container('skeleton.php', 'galactic_post_view_article.php');
 $template->assign('ViewArticlesHREF', SmrSession::getNewHREF($container));

diff --git a/engine/Default/galactic_post_delete_processing.php b/engine/Default/galactic_post_delete_processing.php
@@ -1,5 +1,5 @@
 <?php declare(strict_types=1);
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 if (isset($var['article'])) {
 	if (Request::get('action') == 'Yes') {
 		$db->query('DELETE FROM galactic_post_article WHERE game_id = ' . $db->escapeNumber($player->getGameID()) . ' AND article_id = ' . $db->escapeNumber($var['id']));

diff --git a/engine/Default/game_play.php b/engine/Default/game_play.php
@@ -46,7 +46,7 @@
 		// generate list of game_id that this player is joined
 		$game_id_list[] = $game_id;
 
-		$db2 = new SmrMySqlDatabase();
+		$db2 = MySqlDatabase::getNewInstance();
 		$db2->query('SELECT count(*) as num_playing
 					FROM player
 					WHERE last_cpl_action >= ' . $db->escapeNumber(SmrSession::getTime() - 600) . '
@@ -191,7 +191,7 @@
 
 $db->query('SELECT * FROM voting WHERE end > ' . $db->escapeNumber(SmrSession::getTime()) . ' ORDER BY end DESC');
 if ($db->getNumRows() > 0) {
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	$votedFor = array();
 	$db2->query('SELECT * FROM voting_results WHERE account_id = ' . $db->escapeNumber($account->getAccountID()));
 	while ($db2->nextRecord()) {

diff --git a/engine/Default/game_stats.php b/engine/Default/game_stats.php
@@ -16,7 +16,7 @@
 	$template->assign('LowestAlign', $db->getInt('min_alignment'));
 	$template->assign('HighestKills', $db->getInt('max_kills'));
 }
-	
+
 $db->query('SELECT count(*) num_alliance FROM alliance WHERE game_id = ' . $gameID);
 if ($db->nextRecord()) {
 	$template->assign('TotalAlliances', $db->getInt('num_alliance'));
@@ -44,7 +44,7 @@
 }
 
 function allianceTopTen($gameID, $field) {
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getNewInstance();
 	$db->query('SELECT alliance_id, SUM(' . $field . ') amount
 				FROM alliance
 				LEFT JOIN player USING (game_id, alliance_id)

diff --git a/engine/Default/help.inc b/engine/Default/help.inc
@@ -2,9 +2,9 @@
 
 function echo_nav($topic_id) {
 	// database object
-	$db = new SmrMySqlDatabase();
-	$db2 = new SmrMySqlDatabase();
-	$db3 = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
+	$db2 = MySqlDatabase::getNewInstance();
+	$db3 = MySqlDatabase::getNewInstance();
 
 	// get current entry
 	$db->query('SELECT * FROM manual WHERE topic_id = '.$db->escapeNumber($topic_id));
@@ -100,7 +100,7 @@ function echo_nav($topic_id) {
 
 function echo_content($topic_id) {
 	// database object
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 	// get current entry
 	$db->query('SELECT * FROM manual WHERE topic_id = '.$topic_id);
@@ -120,7 +120,7 @@ function echo_content($topic_id) {
 
 function echo_subsection($topic_id) {
 	// database object
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 	$return='';
 	// check if there are subsections
 	$db->query('SELECT * FROM manual WHERE parent_topic_id = '.$db->escapeNumber($topic_id).' ORDER BY order_id');
@@ -139,7 +139,7 @@ function echo_subsection($topic_id) {
 function echo_menu($topic_id) {
 	$return='';
 	// database object
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 	$db->query('SELECT * FROM manual WHERE parent_topic_id = '.$db->escapeNumber($topic_id).' ORDER BY order_id');
 	if ($db->getNumRows()) {
@@ -158,7 +158,7 @@ function echo_menu($topic_id) {
 }
 
 function get_numbering($topic_id) {
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 	$db->query('SELECT * FROM manual WHERE topic_id = '.$db->escapeNumber($topic_id));
 	if ($db->nextRecord()) {

diff --git a/engine/Default/login_check_processing.php b/engine/Default/login_check_processing.php
@@ -10,7 +10,7 @@
 
 $lastLogin = $account->getLastLogin();
 
-$db = new SmrMySqlDatabase();
+$db = MySqlDatabase::getInstance();
 if ($var['CheckType'] == 'Announcements') {
 	$db->query('SELECT 1 FROM announcement WHERE time >= ' . $db->escapeNumber($lastLogin) . ' LIMIT 1');
 	// do we have announcements?

diff --git a/engine/Default/message_view.php b/engine/Default/message_view.php
@@ -93,7 +93,7 @@
 
 function displayScouts(&$messageBox, $player) {
 	// Generate the group messages
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 	$db->query('SELECT player.*, count( message_id ) AS number, min( send_time ) as first, max( send_time) as last, sum(msg_read=\'FALSE\') as total_unread
 					FROM message
 					JOIN player ON player.account_id = message.sender_id AND message.game_id = player.game_id

diff --git a/engine/Default/rankings_alliance_vs_alliance.php b/engine/Default/rankings_alliance_vs_alliance.php
@@ -3,7 +3,7 @@
 $template->assign('PageTopic', 'Alliance VS Alliance Rankings');
 
 Menu::rankings(1, 4);
-$db2 = new SmrMySqlDatabase();
+$db2 = MySqlDatabase::getNewInstance();
 $container = create_container('skeleton.php', 'rankings_alliance_vs_alliance.php');
 $template->assign('SubmitHREF', SmrSession::getNewHREF($container));
 

diff --git a/engine/Default/vote.php b/engine/Default/vote.php
@@ -3,7 +3,7 @@
 
 $db->query('SELECT * FROM voting ORDER BY end DESC');
 if ($db->getNumRows() > 0) {
-	$db2 = new SmrMySqlDatabase();
+	$db2 = MySqlDatabase::getNewInstance();
 	$votedFor = array();
 	$db2->query('SELECT * FROM voting_results WHERE account_id = ' . $db2->escapeNumber($account->getAccountID()));
 	while ($db2->nextRecord()) {

diff --git a/engine/Draft/alliance_pick.inc b/engine/Draft/alliance_pick.inc
@@ -3,7 +3,7 @@
 // Returns an array with all relevant information about draft teams,
 // including their current size and if the leader can pick teammates.
 function get_draft_teams($gameId) {
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 	$db->query('SELECT account_id FROM draft_leaders WHERE game_id=' . $db->escapeNumber($gameId));
 
 	// Get team leader, alliance, and alliance size

diff --git a/htdocs/album/album_comment.php b/htdocs/album/album_comment.php
@@ -44,7 +44,7 @@ function create_error_offline($msg) {
 		exit;
 	}
 
-	$db = new SmrMySqlDatabase();
+	$db = MySqlDatabase::getInstance();
 
 	if (!isset($_GET['comment']) || empty($_GET['comment'])) {
 		create_error_offline('Please enter a comment.');