summaryrefslogtreecommitdiff
path: root/src/mods.cpp
blob: 6a7ab79aade2870804b74119d46f5bb381d3b64c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
/*
Minetest
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "mods.h"
#include "filesys.h"
#include "strfnd.h"
#include "log.h"
#include "subgame.h"
#include "settings.h"
#include "strfnd.h"

std::map<std::string, ModSpec> getModsInPath(std::string path)
{
	std::map<std::string, ModSpec> result;
	std::vector<fs::DirListNode> dirlist = fs::GetDirListing(path);
	for(u32 j=0; j<dirlist.size(); j++){
		if(!dirlist[j].dir)
			continue;
		std::string modname = dirlist[j].name;
		// Ignore all directories beginning with a ".", especially
		// VCS directories like ".git" or ".svn"
		if(modname[0] == '.')
			continue;
		std::string modpath = path + DIR_DELIM + modname;

		// Handle modpacks (defined by containing modpack.txt)
		std::ifstream modpack_is((modpath+DIR_DELIM+"modpack.txt").c_str(),
					std::ios_base::binary);
		if(modpack_is.good()) //a modpack, recursively get the mods in it
		{
			modpack_is.close(); // We don't actually need the file
			ModSpec spec(modname,modpath);
			spec.modpack_content = getModsInPath(modpath);
			spec.is_modpack = true;
			result.insert(std::make_pair(modname,spec));
		}
		else // not a modpack, add the modspec
		{
			std::set<std::string> depends;
			std::ifstream is((modpath+DIR_DELIM+"depends.txt").c_str(),
				std::ios_base::binary);
			while(is.good())
			{
				std::string dep;
				std::getline(is, dep);
				dep = trim(dep);	
				if(dep != "")
					depends.insert(dep);
			}

			ModSpec spec(modname, modpath, depends);
			result.insert(std::make_pair(modname,spec));
		}
	}
	return result;
}

std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods)
{
	std::map<std::string, ModSpec> result;
	for(std::map<std::string,ModSpec>::iterator it = mods.begin();
		it != mods.end(); ++it)
	{
		ModSpec mod = (*it).second;
		if(mod.is_modpack)
		{
			std::map<std::string, ModSpec> content = 
				flattenModTree(mod.modpack_content);
			result.insert(content.begin(),content.end());
			result.insert(std::make_pair(mod.name,mod));
		} 
		else //not a modpack
		{
			result.insert(std::make_pair(mod.name,mod));
		}
	}
	return result;
}

std::vector<ModSpec> flattenMods(std::map<std::string, ModSpec> mods)
{
	std::vector<ModSpec> result;
	for(std::map<std::string,ModSpec>::iterator it = mods.begin();
		it != mods.end(); ++it)
	{
		ModSpec mod = (*it).second;
		if(mod.is_modpack)
		{
			std::vector<ModSpec> content = flattenMods(mod.modpack_content);
			result.reserve(result.size() + content.size());
			result.insert(result.end(),content.begin(),content.end());
			
		} 
		else //not a modpack
		{
			// infostream << "inserting mod " << mod.name << std::endl;
			result.push_back(mod);
		}
	}
	return result;
}

std::vector<ModSpec> filterMods(std::vector<ModSpec> mods,
								std::set<std::string> exclude_mod_names)
{
	std::vector<ModSpec> result;
	for(std::vector<ModSpec>::iterator it = mods.begin();
		it != mods.end(); ++it)
	{
		ModSpec& mod = *it;
		if(exclude_mod_names.count(mod.name) == 0)
			result.push_back(mod);
	}	
	return result;
}

void ModConfiguration::addModsInPathFiltered(std::string path, std::set<std::string> exclude_mods)
{
	addMods(filterMods(flattenMods(getModsInPath(path)),exclude_mods));
}


void ModConfiguration::addMods(std::vector<ModSpec> new_mods)
{
	// Step 1: remove mods in sorted_mods from unmet dependencies
	// of new_mods. new mods without unmet dependencies are
	// temporarily stored in satisfied_mods
	std::vector<ModSpec> satisfied_mods;
	for(std::vector<ModSpec>::iterator it = m_sorted_mods.begin();
		it != m_sorted_mods.end(); ++it)
	{
		ModSpec mod = *it;
		for(std::vector<ModSpec>::iterator it_new = new_mods.begin();
			it_new != new_mods.end(); ++it_new)
		{
			ModSpec& mod_new = *it_new;
			//infostream << "erasing dependency " << mod.name << " from " << mod_new.name << std::endl;
			mod_new.unsatisfied_depends.erase(mod.name);
		}
	}

	// split new mods into satisfied and unsatisfied
	for(std::vector<ModSpec>::iterator it = new_mods.begin();
		it != new_mods.end(); ++it)
	{
		ModSpec mod_new = *it;
		if(mod_new.unsatisfied_depends.empty())
			satisfied_mods.push_back(mod_new);
		else
			m_unsatisfied_mods.push_back(mod_new);
	}

	// Step 2: mods without unmet dependencies can be appended to
	// the sorted list.
	while(!satisfied_mods.empty())
	{
		ModSpec mod = satisfied_mods.back();
		m_sorted_mods.push_back(mod);
		satisfied_mods.pop_back();
		for(std::list<ModSpec>::iterator it = m_unsatisfied_mods.begin();
			it != m_unsatisfied_mods.end(); )
		{
			ModSpec& mod2 = *it;
			mod2.unsatisfied_depends.erase(mod.name);
			if(mod2.unsatisfied_depends.empty())
			{
				satisfied_mods.push_back(mod2);
				it = m_unsatisfied_mods.erase(it);
			}
			else
				++it;
		}	
	}
}

// If failed, returned modspec has name==""
static ModSpec findCommonMod(const std::string &modname)
{
	// Try to find in {$user,$share}/games/common/$modname
	std::vector<std::string> find_paths;
	find_paths.push_back(porting::path_user + DIR_DELIM + "games" +
			DIR_DELIM + "common" + DIR_DELIM + "mods" + DIR_DELIM + modname);
	find_paths.push_back(porting::path_share + DIR_DELIM + "games" +
			DIR_DELIM + "common" + DIR_DELIM + "mods" + DIR_DELIM + modname);
	for(u32 i=0; i<find_paths.size(); i++){
		const std::string &try_path = find_paths[i];
		if(fs::PathExists(try_path))
			return ModSpec(modname, try_path);
	}
	// Failed to find mod
	return ModSpec();
}

ModConfiguration::ModConfiguration(std::string worldpath)
{
	SubgameSpec gamespec = findWorldSubgame(worldpath);

	// Add common mods without dependency handling
	std::vector<std::string> inexistent_common_mods;
	Settings gameconf;
	if(getGameConfig(gamespec.path, gameconf)){
		if(gameconf.exists("common_mods")){
			Strfnd f(gameconf.get("common_mods"));
			while(!f.atend()){
				std::string modname = trim(f.next(","));
				if(modname.empty())
					continue;
				ModSpec spec = findCommonMod(modname);
				if(spec.name.empty())
					inexistent_common_mods.push_back(modname);
				else
					m_sorted_mods.push_back(spec);
			}
		}
	}
	if(!inexistent_common_mods.empty()){
		std::string s = "Required common mods ";
		for(u32 i=0; i<inexistent_common_mods.size(); i++){
			if(i != 0) s += ", ";
			s += std::string("\"") + inexistent_common_mods[i] + "\"";
		}
		s += " could not be found.";
		throw ModError(s);
	}

	// Add all world mods and all game mods
	addModsInPath(worldpath + DIR_DELIM + "worldmods");
	addModsInPath(gamespec.gamemods_path);

	// check world.mt file for mods explicitely declared to be
	// loaded or not by a load_mod_<modname> = ... line.
	std::string worldmt = worldpath+DIR_DELIM+"world.mt";
	Settings worldmt_settings;
	worldmt_settings.readConfigFile(worldmt.c_str());
	std::vector<std::string> names = worldmt_settings.getNames();
	std::set<std::string> exclude_mod_names;
	for(std::vector<std::string>::iterator it = names.begin(); 
		it != names.end(); ++it)
	{	
		std::string name = *it;  
		// for backwards compatibility: exclude only mods which are
		// explicitely excluded. if mod is not mentioned at all, it is
		// enabled. So by default, all installed mods are enabled.
		if (name.compare(0,9,"load_mod_") == 0 &&
			!worldmt_settings.getBool(name))
		{
			exclude_mod_names.insert(name.substr(9));
		}
	}

	for(std::set<std::string>::const_iterator i = gamespec.addon_mods_paths.begin();
			i != gamespec.addon_mods_paths.end(); ++i)
		addModsInPathFiltered((*i),exclude_mod_names);
}