Initial commit of Admin Panel.

Has basic functionality that you might expect from the core program, escalates priviledges, loads categories and modules dynamically from configuration file, launches modules and returns to the panel once the module has completed. Works within ncurses, gtk and qt environments using the native widget set.

1 files changed, 330 insertions, 0 deletions

diff --git a/MainDisplay.pm b/MainDisplay.pm
new file mode 100644
index 00000000..5e42641c
--- /dev/null
+++ b/MainDisplay.pm
@@ -0,0 +1,330 @@
+#    Copyright 2012 Steven Tucker
+#
+#    This file is part of AdminPanel
+#
+#    AdminPanel is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    AdminPanel 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 AdminPanel.  If not, see <http://www.gnu.org/licenses/>.
+
+
+#Class MainDisplay
+package MainDisplay;
+
+use strict;
+use warnings;
+use diagnostics;
+use SettingsReader;
+use ConfigReader;
+use Category;
+use Module;
+use Data::Dumper;
+use yui;
+
+sub new {
+
+    my $self = {
+        my $categories = 0,
+        my $event = 0,
+        my $factory = 0,
+        my $mainWin = 0,
+        my $mainLayout = 0,
+        my $menuLayout = 0,
+        my $menus = {
+            my $file = 0,
+            my $help = 0
+        },
+        my $layout = 0,
+        my $leftPane = 0,
+        my $rightPane = 0,
+        my $currCategory = 0,
+        my $confDir = 0,
+        my $title   = 0,
+        my $settings = 0,
+        my $exitButton = 0,
+#        my $justToGetRidOfERROR = 0,
+        my $replacePoint = 0
+    };
+    bless $self, 'MainDisplay';
+    
+## Default values
+    $self->{name} =     "Administration panel";
+    $self->{categories} = [];
+    $self->{confDir}    = "/etc/apanel",
+    $self->{title}      = "apanel",
+    $self->setupGui();
+    
+    return $self;
+}
+
+## Begin the program event loop
+sub start {
+    my ($self) = shift;
+    my $reqExit = 0;
+
+    ##Default category selection
+    $self->{currCategory} = @{$self->{categories}}[0]; 
+    $self->{currCategory}->addButtons($self->{rightPane}, $self->{factory});
+    $self->{rightPaneFrame}->setLabel($self->{currCategory}->{name});
+    $self->{factory}->createSpacing($self->{rightPane}, 1, 1, 1.0 );
+
+    my $launch = 0;
+    while(!$launch) {
+
+	## Grab Event
+        $self->{event} = $self->{mainWin}->waitForEvent();
+
+	## Check for window close
+	if ($self->{event}->eventType() == $yui::YEvent::CancelEvent)
+	{
+            last;
+	}
+
+## why i can't test item() with $self->{menus}->{file}[0]?
+	## Check for Exit button push or menu
+    if($self->{event}->widget() == $self->{exitButton} || 
+       ($self->{event}->item() && ($self->{event}->item()->label() eq $self->{menus}->{file}[0]->label() ))) {
+        last;
+    };
+
+	## Discover if a menu button was selected.
+	## If menu button selected, set right panel to display
+	## selected Category Modules
+	for(@{$self->{categories}}){
+	    if( $_->{button} == $self->{event}->widget() ){
+
+		## Menu item selected, set right pane
+                $self->{mainWin}->startMultipleChanges();
+		## Remove existing modules
+                $self->{replacePoint}->deleteChildren();
+                $self->{rightPane} = $self->{factory}->createVBox($self->{replacePoint});
+
+		## Change Current Category to the selected one
+		$self->{currCategory} = $_;
+		## Add new Module Buttons to Right Pane
+		$self->{currCategory}->addButtons($self->{rightPane}, $self->{factory});
+                $self->{rightPaneFrame}->setLabel($self->{currCategory}->{name});
+                $self->{factory}->createSpacing($self->{rightPane}, 1, 1, 1.0 );
+		$self->{replacePoint}->showChild();
+		$self->{mainWin}->recalcLayout();
+		$self->{mainWin}->doneMultipleChanges();
+
+		last;
+	    }
+        }
+
+	## Check if event is from current Category View
+	## If icon click, launch the Module
+	for(@{$self->{currCategory}->{modules}}) {
+	    if( $_->{button} == $self->{event}->widget() ){
+		$launch = $_->{launch};
+		last;
+	    }
+	}
+    }
+
+    return $launch;
+}
+
+sub destroy {
+    my ($self) = shift;
+    $self->{mainWin}->destroy();
+}
+
+sub setupGui {
+    my ($self) = shift;
+
+    my $cmdline = new yui::YCommandLine;
+
+## TODO add parameter check
+    my $pos       = $cmdline->find("--name");
+    if ($pos > 0)
+    {
+        $self->{title} = $cmdline->arg($pos+1);
+    }
+    $pos       = $cmdline->find("--conf_dir");
+    if ($pos > 0)
+    {
+        $self->{confDir} = $cmdline->arg($pos+1);
+    }
+    else
+    {
+        $self->{confDir} = "/etc/$self->{title}";
+    }
+#     print "name     = ".$self->{title}."\n";
+#     print "conf dir = ".$self->{confDir}."\n";
+    
+    $self->loadSettings();
+    yui::YUILog::setLogFileName($self->{settings}->{log});
+    $self->{name} = $self->{settings}->{title};
+    yui::YUI::app()->setApplicationTitle($self->{name});
+    yui::YUI::app()->setApplicationIcon($self->{settings}->{icon});
+
+    $self->{factory} = yui::YUI::widgetFactory;
+    $self->{mainWin} = $self->{factory}->createMainDialog;
+#print "Title:  ".yui::YUI::app()->applicationTitle()."\n";
+
+    $self->{mainLayout} = $self->{factory}->createVBox($self->{mainWin});
+    $self->{menuLayout} = $self->{factory}->createHBox($self->{mainLayout});
+   
+    ## Menu file
+    ## TODO i8n 
+    my $align = $self->{factory}->createAlignment($self->{menuLayout}, 1, 0);
+    my $menu            = $self->{factory}->createMenuButton($align, "File");
+    my $item = new yui::YMenuItem("Exit");
+
+    push(@{$self->{menus}->{file}}, $item);
+    $menu->addItem($item);
+    $menu->rebuildMenuTree();
+
+    $align = $self->{factory}->createAlignment($self->{menuLayout}, 2, 0);
+    $menu           = $self->{factory}->createMenuButton($align, "Help");
+    $item = new yui::YMenuItem("Help");
+    $menu->addItem($item);
+    push(@{$self->{menus}->{help}}, $item);
+    $item = new yui::YMenuItem("About");
+    $menu->addItem($item);
+    push(@{$self->{menus}->{help}}, $item);
+    $menu->rebuildMenuTree();
+
+    $self->{layout}     = $self->{factory}->createHBox($self->{mainLayout});
+
+    #create left Panel Frame no need to add a label for title 
+    $self->{leftPaneFrame} = $self->{factory}->createFrame($self->{layout}, $self->{settings}->{category_title});
+    #create right Panel Frame no need to add a label for title (use setLabel when module changes) 
+    $self->{rightPaneFrame} = $self->{factory}->createFrame($self->{layout}, "");
+    #create replace point for dynamically created widgets
+    $self->{replacePoint} = $self->{factory}->createReplacePoint($self->{rightPaneFrame});
+
+    $self->{rightPane} = $self->{factory}->createVBox($self->{replacePoint});
+    $self->{leftPane} = $self->{factory}->createVBox($self->{leftPaneFrame});
+
+    #logo from settings
+    my $logo = $self->{factory}->createImage($self->{leftPane}, $self->{settings}->{logo});
+    $logo->setAutoScale(1);
+
+    $self->{leftPaneFrame}->setWeight(0, 25);
+    $self->{rightPaneFrame}->setWeight(0, 75);
+
+    $self->loadCategories();
+    $self->{factory}->createVStretch($self->{leftPane});
+
+    $self->{exitButton} = $self->{factory}->createPushButton($self->{leftPane}, "Exit");
+    $self->{exitButton}->setIcon("$self->{settings}->{images_dir}/quit.png");    
+    $self->{exitButton}->setStretchable(0, 1);
+#     $self->{exitButton}->setStretchable(1, 1);
+}
+
+## adpanel settings
+sub loadSettings {
+    my ($self) = @_;
+# configuration file name
+    my $fileName = "$self->{confDir}/settings.conf";
+    $self->{settings} = new SettingsReader($fileName);
+}
+
+sub loadCategory {
+    my ($self, $category) = @_;
+
+    push ( @{$self->{categories}}, $category );
+
+    @{$self->{categories}}[-1]->{button} = $self->{factory}->createPushButton(
+                                                                $self->{leftPane},
+                                                                $self->{categories}[-1]->{name}
+                                                                );
+    @{$self->{categories}}[-1]->setIcon();
+
+    @{$self->{categories}}[-1]->{button}->setStretchable(0, 1);
+#     @{$self->{categories}}[-1]->{button}->setStretchable(1, 1);
+}
+
+sub loadCategories {
+    my ($self) = @_;
+
+# configuration file name
+    my $fileName = "$self->{confDir}/categories.conf";
+
+    my $inFile = new ConfigReader($fileName);
+    my $tmpCat;
+    my $tmp;
+    my $hasNextCat = $inFile->hasNextCat();
+    while( $hasNextCat ) {
+	$tmp = $inFile->getNextCat();
+	$tmpCat = new Category($tmp->{title}, $tmp->{icon});
+	$self->loadCategory($tmpCat);
+	$hasNextCat = $inFile->hasNextCat();
+	$self->{currCategory} = $tmpCat;
+	
+	my $hasNextMod = $inFile->hasNextMod();
+	while( $hasNextMod ) {
+	    $tmp = $inFile->getNextMod();
+	    my $tmpMod = new Module($tmp->{title}, 
+		                    $tmp->{icon},
+		                    $tmp->{launcher}
+		                   );
+	    $self->{currCategory}->loadModule($tmpMod);
+
+	    $hasNextMod = $inFile->hasNextMod();
+	}
+    }
+    undef($tmpCat);
+}
+
+sub menuEventIndex {
+    my ($self) = shift;
+    
+    my $index = -1;
+
+    for(my $i = 0; $i < scalar(@{$self->{categories}} ); ++$i)
+    {
+        print "Current Index = ".$index."\n";
+        if($self->{event}->widget() == @{$self->{categories}}[$i]->{button})
+        {
+            $index = $i;
+	    print "Index found is : ".$index;
+            last;
+        }
+    }
+    return $index;
+}
+
+1;
+
+=pod
+
+=head1 NAME
+
+       MainDisplay - class for the main window
+
+=head1 SYNOPSIS
+
+       $mainDisplay = new MainDisplay();
+
+=head1 METHODS
+
+=head2 start
+
+       contains the main loop of the application
+              where we can check for events
+
+=head2 setupGui
+
+       creates a popupDialog using a YUI::WidgetFactory
+              and then populate this dialog with some components
+
+=head2 loadCategory
+
+       creates a new button representing a category
+
+=head3 category (String)
+
+=cut
+