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
use std::{
fmt::Display,
io,
path::{Path, PathBuf},
};
use anyhow::format_err;
use fs_err as fs;
use indoc::formatdoc;
use crate::{
manifest::Realm,
package_contents::PackageContents,
package_id::PackageId,
package_source::{PackageSourceId, PackageSourceMap},
resolution::Resolve,
};
pub struct InstallationContext {
shared_dir: PathBuf,
shared_index_dir: PathBuf,
shared_path: Option<String>,
server_dir: PathBuf,
server_index_dir: PathBuf,
server_path: Option<String>,
}
impl InstallationContext {
pub fn new(project_path: &Path) -> Self {
let shared_dir = project_path.join("Packages");
let shared_index_dir = shared_dir.join("_Index");
let server_dir = project_path.join("ServerPackages");
let server_index_dir = server_dir.join("_Index");
Self {
shared_dir,
shared_index_dir,
shared_path: None,
server_dir,
server_index_dir,
server_path: None,
}
}
pub fn clean(&self) -> anyhow::Result<()> {
fn remove_ignore_not_found(path: &Path) -> io::Result<()> {
if let Err(err) = fs::remove_dir_all(path) {
if err.kind() != io::ErrorKind::NotFound {
return Err(err);
}
}
Ok(())
}
remove_ignore_not_found(&self.shared_dir)?;
remove_ignore_not_found(&self.server_dir)?;
Ok(())
}
pub fn install(
&self,
sources: &PackageSourceMap,
root_package_id: PackageId,
resolved: &Resolve,
) -> anyhow::Result<()> {
let default_registry = sources.get(&PackageSourceId::DefaultRegistry).unwrap();
for package_id in &resolved.activated {
log::debug!("Installing {}...", package_id);
let shared_deps = resolved.shared_dependencies.get(package_id);
let server_deps = resolved.server_dependencies.get(package_id);
if package_id == &root_package_id {
if let Some(deps) = shared_deps {
self.write_root_package_links(Realm::Shared, deps)?;
}
if let Some(deps) = server_deps {
self.write_root_package_links(Realm::Server, deps)?;
}
} else {
let metadata = resolved.metadata.get(package_id).unwrap();
let package_realm = if metadata.server_only {
Realm::Server
} else {
Realm::Shared
};
if let Some(deps) = shared_deps {
self.write_package_links(package_id, package_realm, deps, Realm::Shared)?;
}
if let Some(deps) = server_deps {
self.write_package_links(package_id, package_realm, deps, Realm::Server)?;
}
let contents = default_registry.download_package(package_id)?;
self.write_contents(package_id, &contents, package_realm)?;
}
}
Ok(())
}
fn link_sibling_same_index(&self, id: &PackageId) -> String {
formatdoc! {r#"
return require(script.Parent.Parent._Index["{full_name}"]["{short_name}"])
"#,
full_name = package_id_file_name(id),
short_name = id.name().name()
}
}
fn link_root_same_index(&self, id: &PackageId) -> String {
formatdoc! {r#"
return require(script.Parent._Index["{full_name}"]["{short_name}"])
"#,
full_name = package_id_file_name(id),
short_name = id.name().name()
}
}
fn link_shared_index(&self, id: &PackageId) -> anyhow::Result<String> {
let shared_path = self.shared_path.as_ref().ok_or_else(|| {
format_err!(
"Cannot have server dependencies depend on \
shared dependencies without shared_path set"
)
})?;
let contents = formatdoc! {r#"
return require({packages}._Index["{full_name}"]["{short_name}"])
"#,
packages = shared_path,
full_name = package_id_file_name(id),
short_name = id.name().name()
};
Ok(contents)
}
fn link_server_index(&self, id: &PackageId) -> anyhow::Result<String> {
let server_path = self.server_path.as_ref().ok_or_else(|| {
format_err!(
"Cannot have shared dependencies depend on \
server dependencies without server_path set"
)
})?;
let contents = formatdoc! {r#"
if not game:GetService("RunService"):IsServer() then
error("{full_name} is a server-only package.", 2)
end
return require({packages}._Index["{full_name}"]["{short_name}"])
"#,
packages = server_path,
full_name = package_id_file_name(id),
short_name = id.name().name()
};
Ok(contents)
}
fn write_root_package_links<'a, K: Display>(
&self,
realm: Realm,
dependencies: impl IntoIterator<Item = (K, &'a PackageId)>,
) -> anyhow::Result<()> {
let base_path = match realm {
Realm::Shared => &self.shared_dir,
Realm::Server => &self.server_dir,
};
for (dep_name, dep_package_id) in dependencies {
let path = base_path.join(format!("{}.lua", dep_name));
let contents = self.link_root_same_index(dep_package_id);
fs::write(path, contents)?;
}
Ok(())
}
fn write_package_links<'a, K: std::fmt::Display>(
&self,
package_id: &PackageId,
package_realm: Realm,
dependencies: impl IntoIterator<Item = (K, &'a PackageId)>,
dependencies_realm: Realm,
) -> anyhow::Result<()> {
let mut base_path = match package_realm {
Realm::Shared => self.shared_index_dir.clone(),
Realm::Server => self.server_index_dir.clone(),
};
base_path.push(package_id_file_name(package_id));
fs::create_dir_all(&base_path)?;
for (dep_name, dep_package_id) in dependencies {
let path = base_path.join(format!("{}.lua", dep_name));
let contents = match (package_realm, dependencies_realm) {
(source, dest) if source == dest => self.link_sibling_same_index(dep_package_id),
(_, Realm::Server) => self.link_server_index(dep_package_id)?,
(_, Realm::Shared) => self.link_shared_index(dep_package_id)?,
};
fs::write(path, contents)?;
}
Ok(())
}
fn write_contents(
&self,
package_id: &PackageId,
contents: &PackageContents,
realm: Realm,
) -> anyhow::Result<()> {
let mut path = match realm {
Realm::Shared => self.shared_index_dir.clone(),
Realm::Server => self.server_index_dir.clone(),
};
path.push(package_id_file_name(package_id));
path.push(package_id.name().name());
fs::create_dir_all(&path)?;
contents.unpack_into_path(&path)?;
Ok(())
}
}
fn package_id_file_name(id: &PackageId) -> String {
format!(
"{}_{}@{}",
id.name().scope(),
id.name().name(),
id.version()
)
}