added Milkbone::Plugin and ::Conf

lib/Milkbone.pm

@@ -1,11 +1,7 @@
 # -----------------------------------------------------------------------------
-# Author(s)	:	Bill Atkins
+# Milkbone.pm
-# Title		:	MOS core tools
+# Desc: Contains the code for the hook system and plugin management.  Exports
-# Date		:	12.21.02
+# aliases to some of the other parts of the core.
-# Desc		:	the hamster that keep MOS going
-# QoTP		:	got milkbone tools?
-# Notes		:	for more information see the plugin documentation
-# License	:	under the same terms as mos.pl
 # -----------------------------------------------------------------------------
 
 package Milkbone;
@@ -13,54 +9,60 @@ package Milkbone;
 use strict;
 use warnings;
 
+# standard modules
 use Carp qw(longmess);
+require Exporter;
+
+# include the rest of the core
 use Milkbone::HookEntry;
-use Milkbone::AllHooks;
-use Benchmark;
 
-our $VERSION = "0.361";
+# equal to the version of the current milkbone release
+our $VERSION = "0.37";
 
+# initialition
+# XXX: FatalLog needs to go to the config
 our $FatalLog = "fatals.txt";
+push @INC, "./plugins";
 
-require Exporter;
+# exports
-
 our @ISA = qw( Exporter );
-our @EXPORT = qw( hook is_running abort queued_hook register_hook option path data %ARGS slurp
+our @EXPORT = qw(hook is_running abort register_hook option data slurp
-	deregister_hook strip_html user_file set_option MOSLoop set_interval unload_plugin load_plugin init_plugin reload_core reload_plugin nix win32);
+		 deregister_hook strip_html user_file set_option
-our @EXPORT_OK = qw( );
+		 unload_plugin load_plugin reload_core reload_plugin
+		 nix win32 %ARGS);
 
+# global variables
 my ($running, $dirty);
 my $interval = 0.006;
+
 our (%hooks, %options, %data, %plugins);
 our (%ARGS) = ();
 
 $running = 1;
 
+# autoflushing on
 $| = 1;
 
+# returns a boolean indicating whether or not the core loop is running
 sub is_running
 {
   $running;
 }
 
-sub set_interval
+# end the core loop and begin shutdown
-{
-	$interval = shift;
-}
-
 sub abort
 {
   $running = 0;
-	die @_;
+  print @_;
+  exit;
 }
 
+# initialize the core
 sub init
 {
-	# initialization
-	register_hook("load_options", \&load_options);
   register_hook("load_plugins", \&load_plugins);
-	register_hook("post_mainloop", \&post_mainloop);
   register_hook("pre_mainloop", \&pre_mainloop);
+  register_hook("post_mainloop", \&post_mainloop);
   register_hook("save_options", \&save_options);
   register_hook("loaded_plugins", \&plugin_list);
   register_hook("error", \&error);
@@ -154,44 +156,57 @@ sub set_option
 	$dirty = 1;
 }
 
-sub load_plugin
+# prepare plugin for loading by adding it to @INC
+sub prep_plugin
 {
   my ($plugin) = @_;
 
   return unless $plugin;
 
-	if(-e path("plugins/$plugin.pl"))
+  if(-e path("plugins/$plugin.pl")) {
-	{
+    # single-file plugin - no need for @INC setting
   }
-        # PAR support - disabled in non-Mercury releases
+  elsif(-e path("plugins/$plugin") and -d path("plugins/$plugin")) {
-	#elsif(-e path("plugins/$plugin.zip"))
+    # multi-file plugin - add its folder to @INC
-	#{
-	#	PAR->import(path("plugins/$plugin.zip"));
-	#}
-	elsif(-e path("plugins/$plugin") and -d path("plugins/$plugin"))
-	{
     unshift @INC, path("plugins/$plugin");
   }
-	else
+  else {
-	{
+    # plugin doesn't exist
     die "Couldn't load plugin $plugin";
     return;
   }
 
+  # mark plugin as loaded
   $plugins{$plugin} = 1;
 }
 
+# call a plugin's initialization code
+sub init_plugin
+{
+  my ($plugin) = @_;
+  eval "require \"$plugin.pl\";";
+  error("Couldn't require $plugin.pl for $plugin: $@") if $@;
+}
+
+# load one or more plugins
+sub load_plugin
+{
+  for my $plugin (@_) {
+    prep_plugin($plugin);
+    init_plugin($plugin);
+  }
+}
+
+# unload a plugin from the core
 sub unload_plugin
 {
   my ($plugin) = @_;
   my $package = $plugin;
   $package =~ s/-//g;
 
-	for my $element (keys %hooks)
+  for my $element (keys %hooks) {
-	{
     my @new;
-		for(@{$hooks{$element}})
+    for(@{$hooks{$element}}) {
-		{
       unless($_->{package} eq $package)
 	{
 				push @new, $_;
@@ -218,17 +233,11 @@ sub plugin_list
     [keys(%plugins)];
 }
 
-sub init_plugin
-{
-	my ($plugin) = @_;
-	eval "require \"$plugin.pl\";" or hook("error", -short => "Couldn't require $plugin.pl for $plugin: $! $@");
-}
-
 sub load_plugins
 {
 	
 	my @plugins = grep({ $_ } (option("Modules"), option("Plugins")));
-	push @INC, "./plugins";
+
 	load_plugin($_) for @plugins;
 	init_plugin($_) for(@plugins);
 }
@@ -296,15 +305,14 @@ sub deregister_hook
 #	 delete $hooks{$hook} unless @temp;
 }
 
-sub MOSLoop
+register_hook "mainloop", sub {
-{
 	my $i = 0;
 	while(is_running)
 	{
 		hook("tick");
 		# select(undef, undef, undef, $interval) if $i++ % 5 == 0 && $interval;
 	}
-}
+};
 
 # ------------------------------------------
 # Default Hooks

lib/Milkbone/Conf.pm

@@ -0,0 +1,36 @@
+# -----------------------------------------------------------------------------
+# Milkbone::Conf
+# Desc: Registers hooks for loading, modifying, reading, and saving XML
+# configuration.
+# -----------------------------------------------------------------------------
+
+package Milkbone::Conf;
+
+use strict;
+use warnings;
+
+use Milkbone;
+
+# standard modules
+use XML::Simple;
+
+# global variables
+my $xml;
+
+# exports
+require Exporter;
+our @EXPORT = qw(option set_option);
+
+register_hook "save_options", sub {
+};
+
+register_hook "load_options", sub {
+};
+
+sub option {
+}
+
+sub set_option {
+}
+
+1;

lib/Milkbone/Plugin.pm

@@ -0,0 +1,18 @@
+# -----------------------------------------------------------------------------
+# Milkbone::Plugin
+# Desc: Stores information about each running plugin
+# -----------------------------------------------------------------------------
+
+package Milkbone::Plugin;
+
+use strict;
+use warnings;
+
+sub new {
+  my $class = shift;
+  my $self = {};
+
+  bless $self, $class;
+}
+
+1;

tk.pl

@@ -0,0 +1,32 @@
+# -----------------------------------------------------------------------------
+# tk.pl
+# Desc: Default guidance script; loads and intializes the Tk interface
+# -----------------------------------------------------------------------------
+
+use Milkbone::Hooks qw(create_logon_prompt pre_mainloop mainloop
+		       post_mainloop protocol_signon);
+
+Milkbone->init;
+
+load_plugin "Tk-GUI";
+
+load_plugin "Tk-About";
+load_plugin "Tk-AddBuddy";
+load_plugin "Tk-BList";
+load_plugin "Tk-Convo";
+load_plugin "Tk-Chat";
+load_plugin "Tk-Conf";
+load_plugin "Tk-File";
+load_plugin "Tk-Logon";
+load_plugin "Tk-PluginsConf";
+load_plugin "Tk-Profile";
+
+load_plugin "Net-OSCAR";
+
+create_logon_prompt;
+
+pre_mainloop;
+mainloop;
+post_mainloop;
+
+1;

tktest.pl

@@ -0,0 +1,35 @@
+# -----------------------------------------------------------------------------
+# tktest.pl
+# Desc: Testing guidance script; loads and intializes the Tk interfacey
+# -----------------------------------------------------------------------------
+
+use Milkbone::Hooks qw(create_logon_prompt pre_mainloop mainloop
+		       post_mainloop protocol_signon);
+
+Milkbone->init;
+
+load_plugin "Tk-GUI";
+
+load_plugin "Tk-About";
+load_plugin "Tk-AddBuddy";
+load_plugin "Tk-BList";
+load_plugin "Tk-Convo";
+load_plugin "Tk-Chat";
+load_plugin "Tk-Conf";
+load_plugin "Tk-File";
+load_plugin "Tk-Logon";
+load_plugin "Tk-PluginsConf";
+load_plugin "Tk-Profile";
+
+# begin unit testing code
+
+protocol_signon -user => 'test', -pass => 'test';
+data("me") = "lala";
+
+# end unit testing code
+
+pre_mainloop;
+mainloop;
+post_mainloop;
+
+1;