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
|
//! ref: composer/src/Composer/Command/DumpAutoloadCommand.php
use anyhow::Result;
use shirabe_external_packages::symfony::component::console::input::InputInterface;
use shirabe_external_packages::symfony::component::console::output::OutputInterface;
use shirabe_php_shim::{InvalidArgumentException, PhpMixed, file_exists};
use crate::command::{BaseCommand, BaseCommandData, HasBaseCommandData};
use crate::composer::Composer;
use crate::console::input::InputOption;
use crate::io::IOInterface;
use crate::plugin::CommandEvent;
use crate::plugin::PluginEvents;
#[derive(Debug)]
pub struct DumpAutoloadCommand {
base_command_data: BaseCommandData,
}
impl DumpAutoloadCommand {
pub fn configure(&mut self) {
self
.set_name("dump-autoload")
.set_aliases(&["dumpautoload".to_string()])
.set_description("Dumps the autoloader")
.set_definition(&[
InputOption::new("optimize", Some(PhpMixed::String("o".to_string())), Some(InputOption::VALUE_NONE), "Optimizes PSR0 and PSR4 packages to be loaded with classmaps too, good for production.", None).unwrap().into(),
InputOption::new("classmap-authoritative", Some(PhpMixed::String("a".to_string())), Some(InputOption::VALUE_NONE), "Autoload classes from the classmap only. Implicitly enables `--optimize`.", None).unwrap().into(),
InputOption::new("apcu", None, Some(InputOption::VALUE_NONE), "Use APCu to cache found/not-found classes.", None).unwrap().into(),
InputOption::new("apcu-prefix", None, Some(InputOption::VALUE_REQUIRED), "Use a custom prefix for the APCu autoloader cache. Implicitly enables --apcu", None).unwrap().into(),
InputOption::new("dry-run", None, Some(InputOption::VALUE_NONE), "Outputs the operations but will not execute anything.", None).unwrap().into(),
InputOption::new("dev", None, Some(InputOption::VALUE_NONE), "Enables autoload-dev rules. Composer will by default infer this automatically according to the last install or update --no-dev state.", None).unwrap().into(),
InputOption::new("no-dev", None, Some(InputOption::VALUE_NONE), "Disables autoload-dev rules. Composer will by default infer this automatically according to the last install or update --no-dev state.", None).unwrap().into(),
InputOption::new("ignore-platform-req", None, Some(InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY), "Ignore a specific platform requirement (php & ext- packages).", None).unwrap().into(),
InputOption::new("ignore-platform-reqs", None, Some(InputOption::VALUE_NONE), "Ignore all platform requirements (php & ext- packages).", None).unwrap().into(),
InputOption::new("strict-psr", None, Some(InputOption::VALUE_NONE), "Return a failed status code (1) if PSR-4 or PSR-0 mapping errors are present. Requires --optimize to work.", None).unwrap().into(),
InputOption::new("strict-ambiguous", None, Some(InputOption::VALUE_NONE), "Return a failed status code (2) if the same class is found in multiple files. Requires --optimize to work.", None).unwrap().into(),
])
.set_help(
"<info>php composer.phar dump-autoload</info>\n\n\
Read more at https://getcomposer.org/doc/03-cli.md#dump-autoload-dumpautoload"
);
}
pub fn execute(
&mut self,
input: &dyn InputInterface,
output: &dyn OutputInterface,
) -> Result<i64> {
let mut composer = self.require_composer(None, None)?;
// TODO(plugin): dispatch CommandEvent
let command_event =
CommandEvent::new(PluginEvents::COMMAND, "dump-autoload", input, output);
composer
.get_event_dispatcher()
.borrow_mut()
.dispatch(Some(command_event.get_name()), None);
// Clone the Rc<RefCell<Config>> so we can take mutable borrows of composer later
let config = std::rc::Rc::clone(composer.get_config());
let mut missing_dependencies = false;
{
let local_repo = composer.get_repository_manager().get_local_repository();
for local_pkg in local_repo.get_canonical_packages() {
// TODO(phase-b): get_install_path takes &mut self on installation_manager which conflicts with the &local_repo borrow held by this loop; needs shared-ownership refactor
let install_path: Option<String> =
todo!("InstallationManager::get_install_path requires &mut self");
if install_path.as_deref().is_some_and(|p| !file_exists(p)) {
missing_dependencies = true;
self.get_io().write("<warning>Not all dependencies are installed. Make sure to run a \"composer install\" to install missing dependencies</warning>");
break;
}
}
}
let optimize = input.get_option("optimize").as_bool().unwrap_or(false)
|| config
.borrow_mut()
.get("optimize-autoloader")
.as_bool()
.unwrap_or(false);
let authoritative = input
.get_option("classmap-authoritative")
.as_bool()
.unwrap_or(false)
|| config
.borrow_mut()
.get("classmap-authoritative")
.as_bool()
.unwrap_or(false);
let apcu_prefix = input
.get_option("apcu-prefix")
.as_string_opt()
.map(|s| s.to_string());
let apcu = apcu_prefix.is_some()
|| input.get_option("apcu").as_bool().unwrap_or(false)
|| config
.borrow_mut()
.get("apcu-autoloader")
.as_bool()
.unwrap_or(false);
if input.get_option("strict-psr").as_bool().unwrap_or(false) && !optimize && !authoritative
{
return Err(InvalidArgumentException {
message: "--strict-psr mode only works with optimized autoloader, use --optimize or --classmap-authoritative if you want a strict return value.".to_string(),
code: 0,
}
.into());
}
if input
.get_option("strict-ambiguous")
.as_bool()
.unwrap_or(false)
&& !optimize
&& !authoritative
{
return Err(InvalidArgumentException {
message: "--strict-ambiguous mode only works with optimized autoloader, use --optimize or --classmap-authoritative if you want a strict return value.".to_string(),
code: 0,
}
.into());
}
if authoritative {
self.get_io()
.write("<info>Generating optimized autoload files (authoritative)</info>");
} else if optimize {
self.get_io()
.write("<info>Generating optimized autoload files</info>");
} else {
self.get_io()
.write("<info>Generating autoload files</info>");
}
let platform_requirement_filter = self.get_platform_requirement_filter(input)?;
if input.get_option("dry-run").as_bool().unwrap_or(false) {
composer.get_autoload_generator_mut().set_dry_run(true);
}
if input.get_option("no-dev").as_bool().unwrap_or(false) {
composer.get_autoload_generator_mut().set_dev_mode(false);
}
if input.get_option("dev").as_bool().unwrap_or(false) {
if input.get_option("no-dev").as_bool().unwrap_or(false) {
return Err(InvalidArgumentException {
message:
"You can not use both --no-dev and --dev as they conflict with each other."
.to_string(),
code: 0,
}
.into());
}
composer.get_autoload_generator_mut().set_dev_mode(true);
}
composer
.get_autoload_generator_mut()
.set_class_map_authoritative(authoritative);
composer.get_autoload_generator_mut().set_run_scripts(true);
composer
.get_autoload_generator_mut()
.set_apcu(apcu, apcu_prefix);
composer
.get_autoload_generator_mut()
.set_platform_requirement_filter(platform_requirement_filter);
// TODO(phase-b): dump requires multiple borrows of composer simultaneously (autoload generator mut, repository, package, installation manager, locker); needs shared-ownership refactor
let class_map: shirabe_class_map_generator::class_map::ClassMap =
todo!("AutoloadGenerator::dump requires concurrent borrows of Composer subsystems");
let number_of_classes = class_map.map.len();
if authoritative {
self.get_io().write(&format!("<info>Generated optimized autoload files (authoritative) containing {} classes</info>", number_of_classes));
} else if optimize {
self.get_io().write(&format!(
"<info>Generated optimized autoload files containing {} classes</info>",
number_of_classes
));
} else {
self.get_io().write("<info>Generated autoload files</info>");
}
if missing_dependencies
|| (input.get_option("strict-psr").as_bool().unwrap_or(false)
&& !class_map.get_psr_violations().is_empty())
{
return Ok(1);
}
if input
.get_option("strict-ambiguous")
.as_bool()
.unwrap_or(false)
&& !class_map.get_ambiguous_classes(None)?.is_empty()
{
return Ok(2);
}
Ok(0)
}
}
impl HasBaseCommandData for DumpAutoloadCommand {
fn base_command_data(&self) -> &BaseCommandData {
&self.base_command_data
}
fn base_command_data_mut(&mut self) -> &mut BaseCommandData {
&mut self.base_command_data
}
}
|
