Index: /trunk/console/Build.PL =================================================================== --- /trunk/console/Build.PL (revision 24600) +++ /trunk/console/Build.PL (revision 24600) @@ -0,0 +1,24 @@ +use Module::Build; +# See perldoc Module::Build for details of how this works + +Module::Build->new( + module_name => 'console', + dist_version_from => 'scripts/console', + author => 'Joshua Hoblitt ', + license => 'gpl', + create_makefile_pl => 'passthrough', + requires => { + 'Config::YAML' => '1.42', + }, + build_requires => { + 'Test::Cmd' => '1.05', + 'Test::More' => 0, + 'Test::Warn' => '0.08', + }, + recommends => { + 'Test::Distribution' => '1.22', + }, + script_files => [qw( + scripts/console + )], +)->create_build_script; Index: /trunk/console/Changes =================================================================== --- /trunk/console/Changes (revision 24600) +++ /trunk/console/Changes (revision 24600) @@ -0,0 +1,6 @@ +Revision history for Perl module console + +0.01 Mon Jun 8 16:19:11 2009 + - original version; created by ExtUtils::ModuleMaker 0.51 + + Index: /trunk/console/LICENSE =================================================================== --- /trunk/console/LICENSE (revision 24600) +++ /trunk/console/LICENSE (revision 24600) @@ -0,0 +1,260 @@ +The General Public License (GPL) +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, +Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute +verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to most of +the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for this service if you wish), that +you receive source code or can get it if you want it, that you can change the +software or use pieces of it in new free programs; and that you know you can do +these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a +fee, you must give the recipients all the rights that you have. You must make +sure that they, too, receive or can get the source code. And you must show +them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) offer +you this license which gives you legal permission to copy, distribute and/or +modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced by +others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We wish +to avoid the danger that redistributors of a free program will individually obtain +patent licenses, in effect making the program proprietary. To prevent this, we +have made it clear that any patent must be licensed for everyone's free use or +not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +GNU GENERAL PUBLIC LICENSE +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND +MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is not +restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and appropriately +publish on each copy an appropriate copyright notice and disclaimer of warranty; +keep intact all the notices that refer to this License and to the absence of any +warranty; and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at +your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such +modifications or work under the terms of Section 1 above, provided that you also +meet all of these conditions: + +a) You must cause the modified files to carry prominent notices stating that you +changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or in +part contains or is derived from the Program or any part thereof, to be licensed +as a whole at no charge to all third parties under the terms of this License. + +c) If the modified program normally reads commands interactively when run, you +must cause it, when started running for such interactive use in the most ordinary +way, to print or display an announcement including an appropriate copyright +notice and a notice that there is no warranty (or else, saying that you provide a +warranty) and that users may redistribute the program under these conditions, +and telling the user how to view a copy of this License. (Exception: if the +Program itself is interactive but does not normally print such an announcement, +your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be on +the terms of this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to +work written entirely by you; rather, the intent is to exercise the right to control +the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and 2 +above provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source +code, which must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give any +third party, for a charge no more than your cost of physically performing source +distribution, a complete machine-readable copy of the corresponding source +code, to be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all the +source code for all modules it contains, plus any associated interface definition +files, plus the scripts used to control compilation and installation of the +executable. However, as a special exception, the source code distributed need +not include anything that is normally distributed (in either source or binary form) +with the major components (compiler, kernel, and so on) of the operating system +on which the executable runs, unless that component itself accompanies the +executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so long +as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not accept +this License. Therefore, by modifying or distributing the Program (or any work +based on the Program), you indicate your acceptance of this License to do so, +and all its terms and conditions for copying, distributing or modifying the +Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to copy, +distribute or modify the Program subject to these terms and conditions. You +may not impose any further restrictions on the recipients' exercise of the rights +granted herein. You are not responsible for enforcing compliance by third parties +to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), conditions are imposed on +you (whether by court order, agreement or otherwise) that contradict the +conditions of this License, they do not excuse you from the conditions of this +License. If you cannot distribute so as to satisfy simultaneously your obligations +under this License and any other pertinent obligations, then as a consequence +you may not distribute the Program at all. For example, if a patent license would +not permit royalty-free redistribution of the Program by all those who receive +copies directly or indirectly through you, then the only way you could satisfy +both it and this License would be to refrain entirely from distribution of the +Program. + +If any portion of this section is held invalid or unenforceable under any particular +circumstance, the balance of the section is intended to apply and the section as +a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other +property right claims or to contest validity of any such claims; this section has +the sole purpose of protecting the integrity of the free software distribution +system, which is implemented by public license practices. Many people have +made generous contributions to the wide range of software distributed through +that system in reliance on consistent application of that system; it is up to the +author/donor to decide if he or she is willing to distribute software through any +other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries +either by patents or by copyrighted interfaces, the original copyright holder who +places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is permitted +only in or among countries not thus excluded. In such case, this License +incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems or +concerns. + +Each version is given a distinguishing version number. If the Program specifies a +version number of this License which applies to it and "any later version", you +have the option of following the terms and conditions either of that version or of +any later version published by the Free Software Foundation. If the Program does +not specify a version number of this License, you may choose any version ever +published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of all +derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS +NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE +COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM +"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR +IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE +ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED +TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY +WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM +(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY +OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS +BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS Index: /trunk/console/MANIFEST =================================================================== --- /trunk/console/MANIFEST (revision 24600) +++ /trunk/console/MANIFEST (revision 24600) @@ -0,0 +1,9 @@ +MANIFEST +README +LICENSE +Todo +Changes +Build.PL +Makefile.PL +lib/console.pm +t/001_load.t Index: /trunk/console/README =================================================================== --- /trunk/console/README (revision 24600) +++ /trunk/console/README (revision 24600) @@ -0,0 +1,15 @@ +pod2text console.pm > README + +If this is still here it means the programmer was too lazy to create the readme file. + +You can create it now by using the command shown above from this directory. + +At the very least you should be able to use this set of instructions +to install the module... + +perl Build.PL +./Build +./Build test +./Build install + +If you are on a windows box you should use 'nmake' rather than 'make'. Index: /trunk/console/Todo =================================================================== --- /trunk/console/Todo (revision 24600) +++ /trunk/console/Todo (revision 24600) @@ -0,0 +1,5 @@ +TODO list for Perl module console + +- Nothing yet + + Index: /trunk/console/lib/Console.pm =================================================================== --- /trunk/console/lib/Console.pm (revision 24600) +++ /trunk/console/lib/Console.pm (revision 24600) @@ -0,0 +1,43 @@ +package Console; + +use strict; +use warnings; + +use vars qw( $VERSION ); +$VERSION = '0.01'; + +use Config::YAML; + +sub find_rcfile +{ + my $rcname = "." . __PACKAGE__ . "rc"; + my $rcfile; + if (-e $rcname) { + $rcfile = $rcname; + } else { + $rcfile = "$ENV{HOME}/$rcname"; + } + $rcfile = File::Spec->canonpath($rcfile); + + return $rcfile; +} + +sub read_rcfile +{ + my $rcfile = shift; + + return unless defined $rcfile; + + if (!-f $rcfile) { + open(my $fh, '>', $rcfile) or die("can't open file: $!"); + close($fh) or die("can't close file:$!"); + } + + return Config::YAML->new( + config => $rcfile, + output => $rcfile, + ); +} + + +1; Index: /trunk/console/scripts/console =================================================================== --- /trunk/console/scripts/console (revision 24600) +++ /trunk/console/scripts/console (revision 24600) @@ -0,0 +1,211 @@ +#!/usr/bin/env perl + +# Copyright (C) 2009 Joshua Hoblitt + +use strict; +use warnings FATAL => qw( all ); + +use vars qw( $VERSION ); +$VERSION = '0.01'; + +use Config::YAML; +use Console; + +use Getopt::Long qw( GetOptions :config auto_help auto_version ); +use Pod::Usage qw( pod2usage ); + +my ( + $user, + $verbose, +); + +GetOptions( + 'user|u=s' => \$user, + 'verbose|v' => \$verbose, +) || pod2usage( 2 ); + +my $hostname = shift @ARGV; +die "a hostname is required" unless defined $hostname; + +$user ||= $ENV{USER}; + +my $rcfile = Console::find_rcfile(); +my $c = Console::read_rcfile($rcfile); +my $hosts = $c->get_hosts; + +my $console = $hosts->{$hostname}->{console}; +die "error with rcfile: $rcfile, console for $hostname is not defined" + unless defined $console; + +system("ssh $user:$hostname\@$console"); + +__END__ + +=pod + +=head1 NAME + +console - access a remote serial console + +=head1 SYNOPSIS + + console [--user ] [--verbose] + +=head1 DESCRIPTION + +This program looks for mounted volumes, at a configurable interval, and records +statistics about them into a database. + +=head1 OPTIONS + +=over 4 + +=item * --db|-d + +Name of database (C) to write too. + +Optional if defined in the F<.nebdiskdrc> file or the appropriate environment +variable is set. + +=item * --user|-u + +Username to authenticate with. + +Optional if defined in the F<.nebdiskdrc> file or the appropriate environment +variable is set. + +=item * --pass|-p + +Password to authenticate with. + +Optional if defined in the F<.nebdiskdrc> file or the appropriate environment +variable is set. + +=item * --debug + +This flag prevents the program from "daemonizing" so output can be sent to +C/C and a debugger used on the running process. + +=item * --pidfile + +Filename to log the running daemon's PID too. + +Optional, if this option is omitted and no value is defined in the +F<.nebdiskrc> then no pidfile is created. + +=item * --stop|-s + +Uses the pidfile to kill an already running daemon. + +=item * --restart|-r + +Uses the pidfile to kill an already running daemon and then starts a new +instance. + +=item * --verbose|-r + +Turns on informational/debugging messages to be sent to the +C/C. This option is probably not very usefully unless combined +with C<--debug>. + +=back + +=head1 ENVIRONMENT + +These environment variables may be used in place of the specified command line +options. All command line option will override the corresponding environment +value. + +=over 4 + +=item * C + +Equivalent to --db|-d + +=item * C + +Equivalent to --user|-u + +=item * C + +Equivalent to --pass|-p + +=back + +=head1 RCFILE + +This program will attempt to read an C from F<$HOME/.nebdiskrc> and if +found will use it's values to override program defaults. Please not that the +precedence for values is: command line, rcfile, environment variables. + +The format of the C is in L format and uses the following values: + + --- + db: nebulous + dbpass: '@neb@' + dbuser: nebulous + mounts: + - /mnt + - /tmp + - /usr + pidfile: /var/tmp/nebdiskd + poll_interval: 5 + +The values C, C, C, and C have the same semantics +as their command line and/or environment variable equivalents. + +=over 4 + +=item * C + +A list of "paths" to C before mounted volumes are polled. The propose +of this option is to attempt to keep "automounted" volumes mounted while this +program is running. + +This value may be omitted or left blank. + +=item * C + +The number of seconds to wait between checks for mounted volumes. + +This value may be omitted or left blank. The default value is C<60>s. + +=back + +=head1 CREDITS + +Just me, myself, and I. + +=head1 SUPPORT + +Please contact the author directly via e-mail. + +=head1 AUTHOR + +Joshua Hoblitt + +=head1 COPYRIGHT + +Copyright (C) 2009 Joshua Hoblitt. All rights reserved. + +This program 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. + +This program 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 +this program; if not, write to the Free Software Foundation, Inc., 59 Temple +Place - Suite 330, Boston, MA 02111-1307, USA. + +The full text of the license can be found in the L Pod as supplied +with Perl 5.8.1 and later. + +=head1 SEE ALSO + +L + +=cut Index: /trunk/console/scripts/console-config =================================================================== --- /trunk/console/scripts/console-config (revision 24600) +++ /trunk/console/scripts/console-config (revision 24600) @@ -0,0 +1,163 @@ +#!/usr/bin/env perl + +# Copyright (C) 2009 Joshua Hoblitt + +use strict; +use warnings FATAL => qw( all ); + +use vars qw( $VERSION ); +$VERSION = '0.01'; + +use Console; + +use Getopt::Long qw( GetOptions :config auto_help auto_version ); +use Pod::Usage qw( pod2usage ); + +my ( + $add, + $console, + $verbose, +); + +GetOptions( + 'add|a' => \$add, + 'console|c=s' => \$console, + 'verbose|v' => \$verbose, +) || pod2usage( 2 ); + +my $hostname = shift @ARGV; + +my $rcfile = Console::find_rcfile(); +my $c = Console::read_rcfile($rcfile); +my $hosts = $c->get_hosts; + +unless (defined $add) { + if (defined $hostname) { + die "unknown hostname: $hostname" unless exists $hosts->{$hostname}->{console}; + printf("%-20s %s\n", "# hostname", "console"); + printf("%20s %s\n", $hostname, $hosts->{$hostname}->{console}); + } else { + printf("%-20s %s\n", "# hostname", "console"); + foreach my $name (keys %$hosts) { + printf("%-20s %s\n", $name, $hosts->{$name}->{console}); + } + } +} else { + die "--console option is required under --add" unless defined $console; + $hosts->{$hostname} = { console => $console }; + $c->set_hosts($hosts); + $c->write; +} + +__END__ + +=pod + +=head1 NAME + +console-config - configure the console util + +=head1 SYNOPSIS + + console [--console ] [--verbose] + +=head1 DESCRIPTION + +This program is used to configure the ".rc" file for the console util. + +=head1 OPTIONS + +=over 4 + +=item * --add|-a + +Flag used to add a entry to the ".rc" file. Requires both C<> and +C<--console>. + +=item * --console|-c + +The name of the console to connect to for serial console access to +C<>. + +=item * --verbose|-r + +Turns on informational/debugging messages to be sent to the +C/C. + +=back + +=head1 RCFILE + +This program will attempt to read an C from F<$HOME/.Consolerc> + +The format of the C is in L format and uses the following values: + + --- + db: nebulous + dbpass: '@neb@' + dbuser: nebulous + mounts: + - /mnt + - /tmp + - /usr + pidfile: /var/tmp/nebdiskd + poll_interval: 5 + +The values C, C, C, and C have the same semantics +as their command line and/or environment variable equivalents. + +=over 4 + +=item * C + +A list of "paths" to C before mounted volumes are polled. The propose +of this option is to attempt to keep "automounted" volumes mounted while this +program is running. + +This value may be omitted or left blank. + +=item * C + +The number of seconds to wait between checks for mounted volumes. + +This value may be omitted or left blank. The default value is C<60>s. + +=back + +=head1 CREDITS + +Just me, myself, and I. + +=head1 SUPPORT + +Please contact the author directly via e-mail. + +=head1 AUTHOR + +Joshua Hoblitt + +=head1 COPYRIGHT + +Copyright (C) 2009 Joshua Hoblitt. All rights reserved. + +This program 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. + +This program 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 +this program; if not, write to the Free Software Foundation, Inc., 59 Temple +Place - Suite 330, Boston, MA 02111-1307, USA. + +The full text of the license can be found in the L Pod as supplied +with Perl 5.8.1 and later. + +=head1 SEE ALSO + +L + +=cut Index: /trunk/console/t/001_load.t =================================================================== --- /trunk/console/t/001_load.t (revision 24600) +++ /trunk/console/t/001_load.t (revision 24600) @@ -0,0 +1,12 @@ +# -*- perl -*- + +# t/001_load.t - check module loading and create testing directory + +use Test::More tests => 2; + +BEGIN { use_ok( 'console' ); } + +my $object = console->new (); +isa_ok ($object, 'console'); + +