/usr/share/popfile/POPFile/Loader.pm is in popfile 1.1.3+dfsg-0ubuntu1.
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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 | package POPFile::Loader;
#----------------------------------------------------------------------------
#
# Loader.pm --- API for loading POPFile loadable modules and
# encapsulating POPFile application tasks
#
# Subroutine names beginning with CORE indicate a subroutine designed
# for exclusive use of POPFile's core application (popfile.pl).
#
# Subroutines not so marked are suitable for use by POPFile-based
# utilities to assist in loading and executing modules
#
# Copyright (c) 2001-2011 John Graham-Cumming
#
# This file is part of POPFile
#
# POPFile is free software; you can redistribute it and/or modify it
# under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
#
# POPFile 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with POPFile; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Created by Sam Schinke (sschinke@users.sourceforge.net)
#
#----------------------------------------------------------------------------
use Getopt::Long qw(:config pass_through);
#----------------------------------------------------------------------------
# new
#
# Class new() function
#----------------------------------------------------------------------------
sub new
{
my $type = shift;
my $self;
# The POPFile classes are stored by reference in the components
# hash, the top level key is the type of the component (see
# CORE_load_directory_modules) and then the name of the component
# derived from calls to each loadable modules name() method and
# which points to the actual module
$self->{components__} = {};
# A handy boolean that tells us whether we are alive or not. When
# this is set to 1 then the proxy works normally, when set to 0
# (typically by the aborting() function called from a signal) then
# we will terminate gracefully
$self->{alive__} = 1;
# This must be 1 for POPFile::Loader to create any output on STDOUT
$self->{debug__} = 1;
# If this is set to 1 then POPFile will shutdown straight after it
# has started up. This is used by the installer and set by the
# --shutdown command-line option
$self->{shutdown__} = 0;
# This stuff lets us do some things in a way that tolerates some
# window-isms
$self->{on_windows__} = 0;
if ( $^O eq 'MSWin32' ) {
require v5.8.0;
$self->{on_windows__} = 1;
}
# See CORE_loader_init below for an explanation of these
$self->{aborting__} = '';
$self->{pipeready__} = '';
$self->{forker__} = '';
$self->{reaper__} = '';
$self->{childexit__} = '';
$self->{warning__} = '';
$self->{die__} = '';
# POPFile's version number as individual numbers and as
# string
$self->{major_version__} = '?';
$self->{minor_version__} = '?';
$self->{build_version__} = '?';
$self->{version_string__} = '';
# Where POPFile is installed
$self->{popfile_root__} = './';
bless $self, $type;
return $self;
}
#----------------------------------------------------------------------------
#
# CORE_loader_init
#
# Initialize things only needed in CORE
#
#----------------------------------------------------------------------------
sub CORE_loader_init
{
my ( $self ) = @_;
if ( defined( $ENV{POPFILE_ROOT} ) ) {
$self->{popfile_root__} = $ENV{POPFILE_ROOT};
}
# These anonymous subroutine references allow us to call these important
# functions from anywhere using the reference, granting internal access
# to $self, without exposing $self to the unwashed. No reference to
# POPFile::Loader is needed by the caller
$self->{aborting__} = sub { $self->CORE_aborting(@_) };
$self->{pipeready__} = sub { $self->pipeready(@_) };
$self->{forker__} = sub { $self->CORE_forker(@_) };
$self->{reaper__} = sub { $self->CORE_reaper(@_) };
$self->{childexit__} = sub { $self->CORE_childexit(@_) };
$self->{warning__} = sub { $self->CORE_warning(@_) };
$self->{die__} = sub { $self->CORE_die(@_) };
# See if there's a file named popfile_version that contains the
# POPFile version number
my $version_file = $self->root_path__( 'POPFile/popfile_version' );
if ( -e $version_file ) {
open VER, "<$version_file";
my $major = int(<VER>);
my $minor = int(<VER>);
my $rev = int(<VER>);
close VER;
$self->CORE_version( $major, $minor, $rev );
}
# Parse the command-line options (only --shutdown is supported at present)
GetOptions( "shutdown" => \$self->{shutdown__} );
print "\nPOPFile Engine loading\n" if $self->{debug__};
}
#----------------------------------------------------------------------------
#
# CORE_aborting
#
# Called if we are going to be aborted or are being asked to abort our
# operation. Sets the alive flag to 0 that will cause us to abort at
# the next convenient moment
#
#----------------------------------------------------------------------------
sub CORE_aborting
{
my ( $self ) = @_;
$self->{alive__} = 0;
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->alive(0);
}
}
}
#----------------------------------------------------------------------------
#
# pipeready
#
# Returns 1 if there is data available to be read on the passed in
# pipe handle
#
# $pipe Pipe handle
#
#----------------------------------------------------------------------------
sub pipeready
{
my ( $self, $pipe ) = @_;
# Check that the $pipe is still a valid handle
if ( !defined( $pipe ) ) {
return 0;
}
if ( $self->{on_windows__} ) {
# I am NOT doing a select() here because that does not work
# on Perl running on Windows. -s returns the "size" of the file
# (in this case a pipe) and will be non-zero if there is data to read
return ( ( -s $pipe ) > 0 );
} else {
# Here I do a select because we are not running on Windows where
# you can't select() on a pipe
my $rin = '';
vec( $rin, fileno( $pipe ), 1 ) = 1;
my $ready = select( $rin, undef, undef, 0.01 );
return ( $ready > 0 );
}
}
#----------------------------------------------------------------------------
#
# CORE_reaper
#
# Called if we get SIGCHLD and asks each module to do whatever reaping
# is needed
#
#----------------------------------------------------------------------------
sub CORE_reaper
{
my ( $self ) = @_;
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->reaper();
}
}
$SIG{CHLD} = $self->{reaper__};
}
#----------------------------------------------------------------------------
#
# CORE_childexit
#
# Called by a module that is in a child process and wants to exit. This
# warns all the other modules in the same process by calling their childexit
# function and then does the exit.
#
# $code The process exit code
#
#----------------------------------------------------------------------------
sub CORE_childexit
{
my ( $self, $code ) = @_;
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->childexit();
}
}
exit( $code );
}
#----------------------------------------------------------------------------
#
# CORE_forker
#
# Called to fork POPFile. Calls every module's forked function in the
# child process to give then a chance to clean up
#
# Returns the return value from fork() and a file handle that form a
# pipe in the direction child to parent. There is no need to close
# the file handles that are unused as would normally be the case with
# a pipe and fork as forker takes care that in each process only one
# file handle is open (be it the reader or the writer)
#
#----------------------------------------------------------------------------
sub CORE_forker
{
my ( $self ) = @_;
my @types = sort keys %{$self->{components__}};
# Tell all the modules that a fork is about to happen
foreach my $type ( @types ) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->prefork();
}
}
# Create the pipe that will be used to send data from the child to
# the parent process, $writer will be returned to the child
# process and $reader to the parent process
pipe my $reader, my $writer;
my $pid = fork();
# If fork() returns an undefined value then we failed to fork and are
# in serious trouble (probably out of resources) so we return undef
if ( !defined( $pid ) ) {
close $reader;
close $writer;
return (undef, undef);
}
# If fork returns a PID of 0 then we are in the child process so
# close the reading pipe file handle, inform all modules that are
# fork has occurred and then return 0 as the PID so that the
# caller knows that we are in the child
if ( $pid == 0 ) {
foreach my $type ( @types ) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->forked( $writer );
}
}
close $reader;
# Set autoflush on the write handle so that output goes
# straight through to the parent without buffering it until
# the socket closes
use IO::Handle;
$writer->autoflush(1);
return (0, $writer);
}
# Reach here because we are in the parent process, close out the
# writer pipe file handle and return our PID (non-zero) indicating
# that this is the parent process
foreach my $type ( @types ) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->postfork( $pid, $reader );
}
}
close $writer;
return ($pid, $reader);
}
#----------------------------------------------------------------------------
#
# CORE_warning
#
# Called when a warning occurs.
# Output the warning to the log file and print it to STDERR.
#
#----------------------------------------------------------------------------
sub CORE_warning
{
my ( $self, @message ) = @_;
if ( $self->module_config( 'GLOBAL', 'debug' ) > 0 ) {
$self->{components__}{core}{logger}->debug( 0, "Perl warning: @message" );
warn @message;
}
}
#----------------------------------------------------------------------------
#
# CORE_die
#
# Called when a fatal error occurs.
# Output the error message to the log file and exit.
#
#----------------------------------------------------------------------------
sub CORE_die
{
my ( $self, @message ) = @_;
# Do nothing when dies in eval
return if $^S;
# Print error message
print STDERR @message;
if ( $self->module_config( 'GLOBAL', 'debug' ) > 0 ) {
$self->{components__}{core}{logger}->debug( 0, "Perl fatal error : @message" );
}
# Try to stop safely
$self->CORE_stop( );
exit 1;
}
#----------------------------------------------------------------------------
#
# CORE_load_directory_modules
#
# Called to load all the POPFile Loadable Modules (implemented as .pm
# files with special comment on first line) in a specific subdirectory
# and loads them into a structured components hash
#
# $directory The directory to search for loadable modules
# $type The 'type' of module being loaded (e.g. proxy, core, ui) which
# is used when fixing up references between modules (e.g. proxy
# modules all need access to the classifier module) and for
# structuring components hash
#
#----------------------------------------------------------------------------
sub CORE_load_directory_modules
{
my ( $self, $directory, $type ) = @_;
print "\n {$type:" if $self->{debug__};
# Look for all the .pm files in named directory and then see which
# of them are POPFile modules indicated by the first line of the
# file being and comment (# POPFILE LOADABLE MODULE) and load that
# module into the %{$self->{components__}} hash getting the name
# from the module by calling name()
opendir MODULES, $self->root_path__( $directory );
while ( my $entry = readdir MODULES ) {
if ( $entry =~ /\.pm$/ ) {
$self->CORE_load_module( "$directory/$entry", $type );
}
}
closedir MODULES;
print '} ' if $self->{debug__};
}
#----------------------------------------------------------------------------
#
# CORE_load_module
#
# Called to load a single POPFile Loadable Module (implemented as .pm
# files with special comment on first line) and add it to the
# components hash.
#
# Returns a handle to the module
#
# $module The path of the module to load
# $type The 'type' of module being loaded (e.g. proxy, core, ui)
#
#----------------------------------------------------------------------------
sub CORE_load_module
{
my ( $self, $module, $type ) = @_;
my $mod = $self->load_module_($module);
if ( defined( $mod ) ) {
my $name = $mod->name();
print " $name" if $self->{debug__};
$self->{components__}{$type}{$name} = $mod;
}
return $mod;
}
#----------------------------------------------------------------------------
#
# load_module_
#
# Called to load a single POPFile Loadable Module (implemented as .pm
# files with special comment on first line. Returns a handle to the
# module, undef if the module failed to load. No internal
# side-effects.
#
# $module The path of the module to load
#
#----------------------------------------------------------------------------
sub load_module_
{
my ( $self, $module ) = @_;
my $mod;
if ( open MODULE, '<' . $self->root_path__( $module ) ) {
my $first = <MODULE>;
close MODULE;
if ( $first =~ /^# POPFILE LOADABLE MODULE/ ) {
require $module;
$module =~ s/\//::/;
$module =~ s/\.pm//;
$mod = $module->new();
}
}
return $mod;
}
#----------------------------------------------------------------------------
#
# CORE_signals
#
# Sets signals to ensure that POPFile handles OS and IPC events
#
# TODO: Figure out why windows POPFile doesn't seem to get SIGTERM
# when windows shuts down
#
#----------------------------------------------------------------------------
sub CORE_signals
{
my ( $self ) = @_;
# Redefine POPFile's signals
$SIG{QUIT} = $self->{aborting__};
$SIG{ABRT} = $self->{aborting__};
$SIG{KILL} = $self->{aborting__};
$SIG{STOP} = $self->{aborting__};
$SIG{TERM} = $self->{aborting__};
$SIG{INT} = $self->{aborting__};
# Yuck. On Windows SIGCHLD isn't calling the reaper under
# ActiveState 5.8.0 so we detect Windows and ignore SIGCHLD and
# call the reaper code below
$SIG{CHLD} = $self->{on_windows__}?'IGNORE':$self->{reaper__};
# I've seen spurious ALRM signals happen on Windows so here we for
# safety say that we want to ignore them
$SIG{ALRM} = 'IGNORE';
# Ignore broken pipes
$SIG{PIPE} = 'IGNORE';
# Better handling of the Perl warnings
$SIG{__WARN__} = $self->{warning__};
# Try to capture the Perl errors
$SIG{__DIE__} = $self->{die__};
return $SIG;
}
#----------------------------------------------------------------------------
#
# CORE_platform_
#
# Loads POPFile's platform-specific code
#
#----------------------------------------------------------------------------
sub CORE_platform_
{
my ( $self ) = @_;
# Look for a module called Platform::<platform> where <platform>
# is the value of $^O and if it exists then load it as a component
# of POPFile. IN this way we can have platform specific code (or
# not) encapsulated. Note that such a module needs to be a
# POPFile Loadable Module and a subclass of POPFile::Module to
# operate correctly
my $platform = $^O;
if ( -e $self->root_path__( "Platform/$platform.pm" ) ) {
print "\n {core:" if $self->{debug__};
$self->CORE_load_module( "Platform/$platform.pm",'core');
print "}" if $self->{debug__};
}
}
#----------------------------------------------------------------------------
#
# CORE_load
#
# Loads POPFile's modules
#
# noserver Set to 1 if no servers (i.e. UI and proxies)
#
#----------------------------------------------------------------------------
sub CORE_load
{
my ( $self, $noserver ) = @_;
# Create the main objects that form the core of POPFile. Consists
# of the configuration modules, the classifier, the UI (currently
# HTML based), and the proxies.
print "\n Loading... " if $self->{debug__};
# Do our platform-specific stuff
$self->CORE_platform_();
# populate our components hash
$self->CORE_load_directory_modules( 'POPFile', 'core' );
$self->CORE_load_directory_modules( 'Classifier', 'classifier' );
if ( !$noserver ) {
$self->CORE_load_directory_modules( 'UI', 'interface' );
$self->CORE_load_directory_modules( 'Proxy', 'proxy' );
$self->CORE_load_directory_modules( 'Services', 'services' );
}
}
#----------------------------------------------------------------------------
#
# CORE_link_components
#
# Links POPFile's modules together to allow them to make use of
# each-other as objects
#
#----------------------------------------------------------------------------
sub CORE_link_components
{
my ( $self ) = @_;
print "\n\nPOPFile Engine $self->{version_string__} starting" if $self->{debug__};
# Link each of the main objects with the configuration object so
# that they can set their default parameters all or them also get
# access to the logger, version, and message-queue
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->version( scalar($self->CORE_version()) );
$self->{components__}{$type}{$name}->configuration( $self->{components__}{core}{config} );
$self->{components__}{$type}{$name}->logger( $self->{components__}{core}{logger} ) if ( $name ne 'logger' );
$self->{components__}{$type}{$name}->mq( $self->{components__}{core}{mq} );
}
}
# All interface components need access to the classifier and history
foreach my $name (sort keys %{$self->{components__}{interface}}) {
$self->{components__}{interface}{$name}->classifier( $self->{components__}{classifier}{bayes} );
$self->{components__}{interface}{$name}->history( $self->{components__}{core}{history} );
}
foreach my $name (sort keys %{$self->{components__}{proxy}}) {
$self->{components__}{proxy}{$name}->classifier( $self->{components__}{classifier}{bayes} );
$self->{components__}{proxy}{$name}->history( $self->{components__}{core}{history} );
}
foreach my $name (sort keys %{$self->{components__}{services}}) {
$self->{components__}{services}{$name}->classifier( $self->{components__}{classifier}{bayes} );
$self->{components__}{services}{$name}->history( $self->{components__}{core}{history} );
}
# Classifier::Bayes and POPFile::History are friends and are aware
# of one another
$self->{components__}{core}{history}->classifier( $self->{components__}{classifier}{bayes} );
$self->{components__}{classifier}{bayes}->history( $self->{components__}{core}{history} );
$self->{components__}{classifier}{bayes}->{parser__}->mangle(
$self->{components__}{classifier}{wordmangle} );
}
#----------------------------------------------------------------------------
#
# CORE_initialize
#
# Loops across POPFile's modules and initializes them
#
#----------------------------------------------------------------------------
sub CORE_initialize
{
my ( $self ) = @_;
print "\n\n Initializing... " if $self->{debug__};
# Tell each module to initialize itself
# Make sure that the core is started first.
my @c = ( 'core', grep {!/^core$/} sort keys %{$self->{components__}} );
foreach my $type (@c) {
print "\n {$type:" if $self->{debug__};
foreach my $name (sort keys %{$self->{components__}{$type}}) {
print " $name" if $self->{debug__};
flush STDOUT;
my $mod = $self->{components__}{$type}{$name};
my $code = $mod->initialize();
if ( $code == 0 ) {
die "Failed to start while initializing the $name module";
}
if ( $code == 1 ) {
$mod->alive( 1 );
$mod->forker( $self->{forker__} );
$mod->setchildexit( $self->{childexit__} );
$mod->pipeready( $self->{pipeready__} );
}
}
print '} ' if $self->{debug__};
}
print "\n" if $self->{debug__};
}
#----------------------------------------------------------------------------
#
# CORE_config
#
# Loads POPFile's configuration and command-line settings
#
#----------------------------------------------------------------------------
sub CORE_config
{
my ( $self ) = @_;
# Load the configuration from disk and then apply any command line
# changes that override the saved configuration
$self->{components__}{core}{config}->load_configuration();
return $self->{components__}{core}{config}->parse_command_line();
}
#----------------------------------------------------------------------------
#
# CORE_start
#
# Loops across POPFile's modules and starts them
#
#----------------------------------------------------------------------------
sub CORE_start
{
my ( $self ) = @_;
print "\n Starting... " if $self->{debug__};
# Now that the configuration is set tell each module to begin operation
# Make sure that the core is started first.
my @c = ( 'core', grep {!/^core$/} sort keys %{$self->{components__}} );
foreach my $type (@c) {
print "\n {$type:" if $self->{debug__};
foreach my $name (sort keys %{$self->{components__}{$type}}) {
my $code = $self->{components__}{$type}{$name}->start();
if ( $code == 0 ) {
die "Failed to start while starting the $name module";
}
# If the module said that it didn't want to be loaded then
# unload it.
if ( $code == 2 ) {
delete $self->{components__}{$type}{$name};
} else {
print " $name" if $self->{debug__};
flush STDOUT;
}
}
print '} ' if $self->{debug__};
}
print "\n\nPOPFile Engine ", scalar($self->CORE_version()), " running\n" if $self->{debug__};
flush STDOUT;
}
#----------------------------------------------------------------------------
#
# CORE_service
#
# This is POPFile. Loops across POPFile's modules and executes their
# service subroutines then sleeps briefly
#
# $nowait If 1 then don't sleep and don't loop
#
#----------------------------------------------------------------------------
sub CORE_service
{
my ( $self, $nowait ) = @_;
$nowait = 0 if ( !defined( $nowait ) );
# MAIN LOOP - Call each module's service() method to all it to
# handle its own requests
while ( $self->{alive__} == 1 ) {
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
if ( $self->{components__}{$type}{$name}->service() == 0 ) {
$self->{alive__} = 0;
last;
}
}
}
# Sleep for 0.05 of a second to ensure that POPFile does not
# hog the machine's CPU
select(undef, undef, undef, 0.05) if !$nowait;
# If we are on Windows then reap children here
if ( $self->{on_windows__} ) {
foreach my $type (sort keys %{$self->{components__}}) {
foreach my $name (sort keys %{$self->{components__}{$type}}) {
$self->{components__}{$type}{$name}->reaper();
}
}
}
last if $nowait;
# If we are asked to shutdown then we allow a single run
# through the service routines and then exit
if ( $self->{shutdown__} == 1 ) {
$self->{alive__} = 0;
}
}
return $self->{alive__};
}
#----------------------------------------------------------------------------
#
# CORE_stop
#
# Loops across POPFile's modules and stops them
#
#----------------------------------------------------------------------------
sub CORE_stop
{
my ( $self ) = @_;
if ( $self->{debug__} ) {
print "\n\nPOPFile Engine $self->{version_string__} stopping\n";
flush STDOUT;
print "\n Stopping... ";
}
# Shutdown the MQ first. This is done so that it will flush out
# any remaining messages and hand them off to the other modules
# that might want to deal with them in their stop() routine
$self->{components__}{core}{mq}->alive(0);
$self->{components__}{core}{mq}->stop();
$self->{components__}{core}{history}->alive(0);
$self->{components__}{core}{history}->stop();
# Shutdown all the modules
foreach my $type (sort keys %{$self->{components__}}) {
print "\n {$type:" if $self->{debug__};
foreach my $name (sort keys %{$self->{components__}{$type}}) {
print " $name" if $self->{debug__};
flush STDOUT;
next if ( $name eq 'mq' );
next if ( $name eq 'history' );
$self->{components__}{$type}{$name}->alive(0);
$self->{components__}{$type}{$name}->stop();
}
print '} ' if $self->{debug__};
}
print "\n\nPOPFile Engine $self->{version_string__} terminated\n" if $self->{debug__};
}
#----------------------------------------------------------------------------
#
# CORE_version
#
# Gets and Sets POPFile's version data. Returns string in scalar
# context, or (major, minor, build) triplet in list context
#
# $major_version The major version number
# $minor_version The minor version number
# $build_version The build version number
#
#----------------------------------------------------------------------------
sub CORE_version
{
my ( $self, $major_version, $minor_version, $build_version ) = @_;
if (!defined($major_version)) {
if (wantarray) {
return ($self->{major_version__},$self->{minor_version__},$self->{build_version__});
} else {
return $self->{version_string__};
}
} else {
($self->{major_version__}, $self->{minor_version__}, $self->{build_version__}) = ($major_version, $minor_version, $build_version);
$self->{version_string__} = "v$major_version.$minor_version.$build_version"
}
}
#----------------------------------------------------------------------------
#
# get_module
#
# Gets a module from components hash. Returns a handle to a module.
#
# May be called either as:
#
# $name Module name in scoped format (eg, Classifier::Bayes)
#
# Or:
#
# $name Name of the module
# $type The type of module
#
#----------------------------------------------------------------------------
sub get_module
{
my ( $self, $name, $type ) = @_;
if (!defined($type) && $name =~ /^(.*)::(.*)$/ ) {
$type = lc($1);
$name = lc($2);
$type =~ s/^POPFile$/core/i;
$type =~ s/^UI$/interface/i;
}
return $self->{components__}{$type}{$name};
}
#----------------------------------------------------------------------------
#
# set_module
#
# Inserts a module into components hash.
#
# $name Name of the module
# $type The type of module
# $module A handle to a module
#
#----------------------------------------------------------------------------
sub set_module
{
my ($self, $type, $name, $module) = @_;
$self->{components__}{$type}{$name} = $module;
}
#----------------------------------------------------------------------------
#
# remove_module
#
# removes a module from components hash.
#
# $name Name of the module
# $type The type of module
# $module A handle to a module
#
#----------------------------------------------------------------------------
sub remove_module
{
my ($self, $type, $name) = @_;
$self->{components__}{$type}{$name}->stop();
delete($self->{components__}{$type}{$name});
}
#----------------------------------------------------------------------------
#
# root_path__
#
# Joins the path passed in with the POPFile root
#
# $path RHS of path
#
#----------------------------------------------------------------------------
sub root_path__
{
my ( $self, $path ) = @_;
$self->{popfile_root__} =~ s/[\/\\]$//;
$path =~ s/^[\/\\]//;
return "$self->{popfile_root__}/$path";
}
# GETTER/SETTER
sub debug
{
my ( $self, $debug ) = @_;
$self->{debug__} = $debug;
}
sub module_config
{
my ( $self, $module, $item, $value ) = @_;
return $self->{components__}{core}{config}->module_config_( $module, $item, $value );
}
1;
|