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 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
# Copyright (C) 2008-2010, Sebastian Riedel.
package Mojo::Commands;
use strict;
use warnings;
use base 'Mojo::Command';
use Mojo::ByteStream 'b';
use Mojo::Loader;
__PACKAGE__->attr(hint => <<"EOF");
See '$0 help COMMAND' for more information on a specific command.
EOF
__PACKAGE__->attr(message => <<"EOF");
usage: $0 COMMAND [OPTIONS]
Tip: CGI, FastCGI and PSGI environments can be automatically detected very
often and work without commands.
These commands are currently available:
EOF
__PACKAGE__->attr(namespaces => sub { ['Mojo::Command'] });
# Aren't we forgetting the true meaning of Christmas?
# You know, the birth of Santa.
sub run {
my ($self, $name, @args) = @_;
# Try to detect environment
my $detect = $self->_detect;
$name = $detect if $detect && !$ENV{MOJO_NO_DETECT};
# Run command
if ($name && $name =~ /^\w+$/ && ($name ne 'help' || $args[0])) {
# Help
my $help = $name eq 'help' ? 1 : 0;
$name = shift @args if $help;
# Try all namespaces
my $module;
for my $namespace (@{$self->namespaces}) {
# Generate module
my $try = $namespace . '::' . b($name)->camelize;
# Load
if (my $e = Mojo::Loader->load($try)) {
# Module missing
next unless ref $e;
# Real error
die $e;
}
# Module is a command
next unless $try->can('new') && $try->can('run');
# Found
$module = $try;
last;
}
# Command missing
die qq/Command "$name" missing, maybe you need to install it?\n/
unless $module;
# Run
my $command = $module->new;
return $help ? $command->help : $command->run(@args);
}
# Try all namespaces
my $commands = [];
my $seen = {};
for my $namespace (@{$self->namespaces}) {
# Search
if (my $modules = Mojo::Loader->search($namespace)) {
for my $module (@$modules) {
# Load
if (my $e = Mojo::Loader->load($module)) { die $e }
# Seen
my $command = $module;
$command =~ s/^$namespace\:://;
push @$commands, [$command => $module]
unless $seen->{$command};
$seen->{$command} = 1;
}
}
}
# Print overview
print $self->message;
# Make list
my $list = [];
my $length = 0;
foreach my $command (@$commands) {
# Generate name
my $name = $command->[0];
$name = b($name)->decamelize;
# Add to list
my $l = length $name;
$length = $l if $l > $length;
push @$list, [$name, $command->[1]->new->description];
}
# Print list
foreach my $command (@$list) {
my $name = $command->[0];
my $description = $command->[1];
my $padding = ' ' x ($length - length $name);
print " $name$padding $description";
}
# Hint
print $self->hint;
return $self;
}
sub start {
my $self = shift;
# Don't run commands if we are reloading
return $self if $ENV{MOJO_COMMANDS_DONE};
$ENV{MOJO_COMMANDS_DONE} ||= 1;
# Arguments
my @args = @_ ? @_ : @ARGV;
# Run
return ref $self ? $self->run(@args) : $self->new->run(@args);
}
sub _detect {
my ($self, $name) = @_;
# PSGI (Plack only for now)
return 'psgi' if defined $ENV{PLACK_ENV};
# CGI
return 'cgi' if defined $ENV{PATH_INFO};
# No further detection if we have a name
return $name if $name;
# FastCGI
return 'fastcgi' unless defined $ENV{PATH};
# Nothing
return;
}
1;
__END__
=head1 NAME
Mojo::Commands - Commands
=head1 SYNOPSIS
use Mojo::Commands;
# Command line interface
my $commands = Mojo::Commands->new;
$commands->run(@ARGV);
=head1 DESCRIPTION
L<Mojo::Commands> is the interactive command line interface to the L<Mojo>
framework.
It will automatically detect available commands in the L<Mojo::Command>
namespace.
Commands are implemented by subclassing L<Mojo::Command>.
These commands are available by default.
=over 4
=item C<help>
mojo
mojo help
List available commands with short descriptions.
mojo help <command>
List available options for the command with short descriptions.
=item C<generate>
mojo generate
mojo generate help
List available generator commands with short descriptions.
mojo generate help <generator>
List available options for generator command with short descriptions.
=item C<generate app>
mojo generate app <AppName>
Generate application directory structure for a fully functional L<Mojo>
application.
=item C<generate makefile>
script/myapp generate makefile
Generate C<Makefile.PL> file for application.
=item C<generate psgi>
script/myapp generate psgi
Generate C<myapp.psgi> file for application.
=item C<cgi>
mojo cgi
script/myapp cgi
Start application with CGI backend.
=item C<daemon>
mojo cgi
script/myapp daemon
Start application with standalone HTTP 1.1 server backend.
=item C<daemon_prefork>
mojo daemon_prefork
script/myapp daemon_prefork
Start application with preforking standalone HTTP 1.1 server backend.
=item C<fastcgi>
mojo fastcgi
script/myapp fastcgi
Start application with FastCGI backend.
=item C<get>
mojo get http://mojolicious.org
script/myapp get /foo
Perform GET request to remote host or local application.
=item C<test>
mojo test
script/myapp test
script/myapp test t/foo.t
Runs application tests from the C<t> directory.
=item C<version>
mojo version
List version information for installed core and optional modules, very useful
for debugging.
=back
=head1 ATTRIBUTES
L<Mojo::Commands> inherits all attributes from L<Mojo::Command> and
implements the following new ones.
=head2 C<hint>
my $hint = $commands->hint;
$commands = $commands->hint('Foo!');
Short hint shown after listing available commands.
=head2 C<message>
my $message = $commands->message;
$commands = $commands->message('Hello World!');
Short usage message shown before listing available commands.
=head2 C<namespaces>
my $namespaces = $commands->namespaces;
$commands = $commands->namespaces(['Mojo::Command']);
Namespaces to search for available commands, defaults to L<Mojo::Command>.
=head1 METHODS
L<Mojo::Commands> inherits all methods from L<Mojo::Command> and implements
the following new ones.
=head2 C<run>
$commands->run;
$commands->run(@ARGV);
Load and run commands.
=head2 C<start>
Mojo::Commands->start;
Mojo::Commands->start(@ARGV);
Start the command line interface.
=head1 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicious.org>.
=cut
|