/usr/share/perl5/Spoon/Base.pm is in libspoon-perl 0.24-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | package Spoon::Base;
use Spiffy 0.24 -Base;
use Spiffy qw(-yaml);
use Spiffy qw(WWW XXX YYY ZZZ);
# WWW - Creating a wrapper sub to require() IO::All caused spurious segfaults
use IO::All 0.32;
our @EXPORT = qw(io trace WWW XXX YYY ZZZ);
our @EXPORT_OK = qw(conf);
field used_classes => [];
field 'encoding';
const plugin_base_directory => './plugin';
field using_debug => 0;
field config_class => 'Spoon::Config';
sub hub {
return $Spoon::Base::HUB
if defined($Spoon::Base::HUB) and not @_;
Carp::confess "Too late to create a new hub. One already exists"
if defined $Spoon::Base::HUB;
my ($args, @config_files);
{
no warnings;
local *paired_arguments = sub { qw(-config_class) };
($args, @config_files) = $self->parse_arguments(@_);
}
my $config_class = $args->{-config_class} ||
$self->can('config_class')
? $self->config_class
: 'Spoon::Config';
eval "require $config_class"; die $@ if $@;
my $config = $config_class->new(@config_files);
my $hub_class = $config->hub_class;
eval "require $hub_class";
my $hub = $hub_class->new(
config => $config,
config_files => \@config_files,
);
}
sub destroy_hub {
undef $Spoon::Base::HUB;
}
sub init { }
sub assert {
die "Assertion failed" unless shift;
}
sub trace() {
require Spoon::Trace;
no warnings;
*trace = \ &Spoon::Trace::trace;
goto &trace;
}
sub t {
trace->mark;
return $self;
}
sub conf() {
my ($name, $default) = @_;
my $package = caller;
no strict 'refs';
*{$package . '::' . $name} = sub {
my $self = shift;
return $self->{$name}
if exists $self->{$name};
$self->{$name} = exists($self->hub->config->{$name})
? $self->hub->config->{$name}
: $default;
};
}
sub clone {
return bless {%$self}, ref $self;
}
sub is_in_cgi {
defined $ENV{GATEWAY_INTERFACE};
}
sub is_in_test {
defined $ENV{SPOON_TEST};
}
sub have_plugin {
my $hub = $self->class_id eq 'hub'
? $self
: $self->hub;
local $@;
eval { $hub->load_class(shift) }
}
sub plugin_directory {
my $dir = join '/',
$self->plugin_base_directory,
$self->class_id,
;
mkdir $dir unless -d $dir;
return $dir;
}
sub debug {
no warnings;
if ($self->is_in_cgi) {
eval 'use CGI::Carp qw(fatalsToBrowser)'; die $@ if $@;
$SIG{__DIE__} = sub { CGI::Carp::confess(@_) }
}
else {
require Carp;
$SIG{__DIE__} = sub { Carp::confess(@_) }
}
$self->using_debug(1)
if ref $self;
return $self;
}
our ($UPPER, $LOWER, $ALPHA, $NUM, $ALPHANUM, $WORD, $WIKIWORD);
push @EXPORT_OK, qw($UPPER $LOWER $ALPHA $NUM $ALPHANUM $WORD $WIKIWORD);
our %EXPORT_TAGS = (char_classes => [@EXPORT_OK]);
if ($] < 5.008) {
$UPPER = 'A-Z\xc0-\xde';
$LOWER = 'a-z\xdf-\xff';
$ALPHA = $UPPER . $LOWER;
$NUM = '0-9';
$ALPHANUM = $ALPHA . $NUM;
$WORD = $ALPHANUM . '_';
$WIKIWORD = $WORD;
}
else {
$UPPER = '\p{UppercaseLetter}';
$LOWER = '\p{LowercaseLetter}';
$ALPHA = '\p{Letter}';
$NUM = '\p{Number}';
$ALPHANUM = '\p{Letter}\p{Number}\pM';
$WORD = '\p{Letter}\p{Number}\p{ConnectorPunctuation}\pM';
$WIKIWORD = "$UPPER$LOWER$NUM" . '\p{ConnectorPunctuation}\pM';
}
sub env_check {
my $variable = shift;
die "Environment variable '$variable' not set"
unless defined $ENV{$variable};
}
sub dumper_to_file {
my $path = shift;
require Data::Dumper;
no warnings;
local $Data::Dumper::Indent = 1;
local $Data::Dumper::Terse = (@_ == 1) ? 1 : 0;
local $Data::Dumper::Sortkeys = 1;
io("$path")->assert->print(Data::Dumper::Dumper(@_));
}
# Codecs and Escaping
my $has_utf8;
sub has_utf8 {
$has_utf8 = shift if @_;
return $has_utf8 if defined($has_utf8);
$has_utf8 = $] < 5.008 ? 0 : 1;
require Encode if $has_utf8;
}
sub utf8_decode {
$_[0] = Encode::decode('utf8', $_[0])
if $self->has_utf8 and
defined $_[0] and
not Encode::is_utf8($_[0]);
return $_[0];
}
sub utf8_encode {
$_[0] = Encode::encode('utf8', $_[0])
if $self->has_utf8 and
defined $_[0];
return $_[0];
}
sub uri_escape {
require CGI::Util;
my $data = shift;
$self->utf8_encode($data);
return CGI::Util::escape($data);
}
sub uri_unescape {
require CGI::Util;
my $data = shift;
$data = CGI::Util::unescape($data);
$self->utf8_decode($data);
return $data;
}
# WWW - The CGI.pm version is broken in Chinese
sub html_escape {
my $val = shift;
$val =~ s/&/&/g;
$val =~ s/</</g;
$val =~ s/>/>/g;
$val =~ s/\(/(/g;
$val =~ s/\)/)/g;
$val =~ s/"/"/g;
$val =~ s/'/'/g;
return $val;
}
sub html_unescape {
CGI::unescapeHTML(shift);
}
sub base64_encode {
require MIME::Base64;
MIME::Base64::encode_base64(@_);
}
sub base64_decode {
require MIME::Base64;
MIME::Base64::decode_base64(@_);
}
# XXX Move to IO::All. Make more robust. Use Damian's prompting module.
package IO::All;
sub prompt {
print shift;
io('-')->chomp->getline;
}
__END__
=head1 NAME
Spoon::Base - Generic Spoon Base Class
=head1 SYNOPSIS
use Spoon::Base '-Base';
=head1 DESCRIPTION
Base class for application plugins. Provides basic functionality to all
modules inheriting from this class.
=head1 SUBROUTINES
These subroutines are meant to be called bare, not as an object-method call.
=head2 trace
See Spoon::Trace::trace().
=head2 conf(name, default)
Returns the configuration value for "name", if it can be found in
the config ($self->hub->config). Returns $default, otherwise.
=head1 METHODS
=head2 hub
Return the application's hub object. See Spoon::Hub.
=head2 init
Inherited by all subclasses. Put your class initialization stuff here.
=head2 assert(boolean)
Die if the supplied argument is false.
=head2 t([label])
Calls Spoon::Trace::mark(). See Spoon::Trace.
=head2 clone
Copies a class instance. The copy is only a shallow one.
=head2 is_in_cgi
Returns a boolean, indicating whether we were called from a CGI interface.
=head2 is_in_test
Returns a boolean, indicating whether we were called from a test suite.
=head2 have_plugin(class_id)
Tries to load a plugin. See Spoon::Hub::load_class().
=head2 plugin_directory
Returns your plugin's directory. You can use this directory to store state.
=head2 env_check(variable_name)
Sanity check: ensure the specified variable exists in %ENV. If the variable
is not found, dies with a useful error message.
=head2 dumper_to_file(filepath, variable1 [, variable2...])
Uses Data::Dumper to save a dump of one or more variables to the specified
file.
=head2 has_utf8
Returns a boolean, indicating whether utf8 is available on this platform and
version of perl.
=head2 utf8_encode(string)
Encodes the string in utf8, if utf8 is available. Otherwise, returns $string
unmodified. See Encode::encode().
=head2 utf8_decode(string)
Decodes the string from utf8, if utf8 is available. Otherwise, returns $string
unmodified. See Encode::decode().
=head2 uri_escape(string)
Escapes all invalid URI characters. See CGI::Util::escape().
=head2 uri_unescape(string)
Unescapes all invalid URI characters. See CGI::Util::unescape().
=head2 html_escape(string)
Escapes all reserved characters. The result is suitable for including verbatim
in an HTML document. See CGI::escapeHTML().
=head2 html_unescape(string)
Escapes all reserved characters. The result is suitable for including verbatim
in an HTML document. See CGI::unescapeHTML().
=head2 base64_encode(string)
Encodes the specified string into Base64. See MIME::Base64::encode_base64().
=head2 base64_encode(base64_data)
Decodes the specified data from Base64. See MIME::Base64::decode_base64().
=head1 TODO
* Document what Spoon::Base->debug() does.
=head1 AUTHOR
Brian Ingerson <INGY@cpan.org>
=head1 COPYRIGHT
Copyright (c) 2004. Brian Ingerson. All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See http://www.perl.com/perl/misc/Artistic.html
=cut
|