Fldigi/Shell.pm untested

filter: Statementstmt 0.0% 0 / 114 Branchbran 0.0% 0 / 30 Conditioncond 0.0% 0 / 5 MC/DCmcdc 0.0% 0 / 3 Subroutinesub 0.0% 0 / 11 Podpod 0.0% 0 / 2 totaltotal 0.0% 0 / 165 CC 16 SCAR 47.5
CC
16
Cov
0%
start
210.0
new
12.0
BEGIN
2.0
CRAP 115.2
1 #!/usr/bin/perl
2  
3 #==============================================================================
4 # Ham::Fldigi::Shell
5 # v0.002
6 # (c) 2012 Andy Smith, M0VKG
7 #==============================================================================
8 # DESCRIPTION
9 # This module provides a shell for interacting with Fldigi
10 #==============================================================================
11 # SYNOPSIS
12 # use Ham::Fldigi;
13 # my $f = new Ham::Fldigi('LogLevel' => 4,
14 # 'LogFile' => './debug.log',
15 # 'LogPrint' => 1,
16 # 'LogWrite' => 1);
17 # my $client = $f->client('Hostname' => 'localhost',
18 # 'Port' => '7362',
19 # 'Name' => 'default');
20 # my $shell = $fldigi->shell($client);
21 #==============================================================================
22  
23 # Perl documentation is provided inline in pod format.
24 # To view, run:-
25 # perldoc Ham::Fldigi::Shell
26  
27 =head1 NAME
28  
29 Ham::Fldigi::Shell - an interactive shell for Fldigi
30  
31 =head1 SYNOPSIS
32  
33 use Ham::Fldigi;
34 my $f = new Ham::Fldigi;
35 my $c = new Ham::Fldigi::Client('Hostname' => 'localhost', 'Port' => 7362, 'Name' => 'example');
36 my $s = $f->shell($c);
37  
38 =head1 DESCRIPTION
39  
40 This module is for communicating with individual Fldigi instances.
41  
42 It uses Fldigi's XMLRPC service, which usually runs on localhost:7362, providing support for it has been compiled in.
43  
44 =head2 EXPORT
45  
46 None by default.
47 =cut
48  
49 package Ham::Fldigi::Shell;
50  
51 use 5.012004;
52 use strict;
53 use warnings;
54  
55 use Moose;
56 use Data::Dumper;
57 use Time::HiRes qw( usleep );
58 use Term::ReadLine;
59 use Switch;
60 use base qw(Ham::Fldigi::Debug);
61  
62 our $VERSION = '0.001';
63  
64 has 'id' => (is => 'ro', isa => 'String');
65 has 'parent' => (is => 'ro', isa => 'Ref');
66 has 'client' => (is => 'rw', isa => 'Ref');
67  
68 =head1 CONSTRUCTORS
69  
70 =head2 Shell->new(I<Ham::Fldigi::Shell ref>)
71  
72 Creates a new B<Ham::Fldigi::Shell> object with the specified arguments.
73  
74 =cut
75  
76 sub new {
77
78 # Get our name, and set an ID
79 my $class = shift;
80 my (%params) = @_;
81 my $g = Data::GUID->new;
82  
83 # Fill in the class ID and version
84 my $self = {
85 'version' => $VERSION,
86 'id' => $g->as_string,
87 };
88  
89 # Bless self
90 bless $self, $class;
91  
92 if(!defined($params{'Parent'})) {
93 $self->error("Parent is undefined. Ham::Fldigi::Shell should only be called with Ham::Fldigi->shell()!");
94 return undef;
95 } else {
96 $self->{parent} = $params{'Parent'};
97 }
98  
99 $self->debug("Constructor called. Version ".$VERSION.", with ID ".$self->id.".");
100  
101 if(!defined($params{'Client'})) {
102 $self->debug("No client passed.");
103 } else {
104 $self->client($params{'Client'});
105 $self->debug("Passed client ref is for client named ".$self->client->name.", with an XML-RPC URL of ".$self->client->url.".");
106 }
107  
108 $self->debug("Returning...");
109 return $self;
110 }
111  
112 =head1 METHODS
113  
114 =head2 Client->shell()
115  
116 Start an interactive shell, similar to fldigi-shell.
117  
118 =cut
119  
120 sub start {
121  
122 my ($self) = @_;
123  
124 $self->debug("Starting shell...");
125  
126 my $term = Term::ReadLine->new('Ham::Fldigi shell');
127 print "Ham::Fldigi::Shell v".$VERSION."\n";
128 print "(c) 2012 Andy Smith M0VKG\n";
129  
130 my $prompt;
131 if(defined($self->client)) {
132 $prompt = "fldigi(".$self->client->name.")> ";
133 } else {
134 $prompt = "fldigi> ";
135 }
136  
137 my $OUT = $term->OUT || \*STDOUT;
138  
139 my $running = 1;
140 while ($running == 1) {
141  
142 my $c = $term->readline($prompt);
143  
144 if((defined($c)) && ($c =~ /\S/)) {
145 my ($cmd, @args) = split(" ", $c);
146 $term->addhistory($_);
147  
148 switch ($cmd) {
149 case /^connect$|^c$/ {
150 if(defined($self->parent->clients))
151 {
152 if(@args) {
153 if(!defined($self->parent->clients->{$args[0]})) {
154 print $OUT "No client with name '".$args[0]."'.\n";
155 } else {
156 $self->client($self->parent->clients->{$args[0]});
157 print $OUT "Switched to client '".$args[0]."'.\n";
158 $prompt = "fldigi(".$self->client->name.")> ";
159 }
160 }
161 }
162 }
163 case /^disconnect$|^d$/ {
164 if(defined($self->client)) {
165 print $OUT "Disconnected from client '".$self->client->name.".\n";
166 $self->{client} = undef;
167 $prompt = "fldigi> ";
168 } else {
169 print $OUT "Not connected to a client.\n";
170 }
171 }
172 case /^list$|^l$/ {
173 if(defined($self->parent->clients))
174 {
175 foreach my $client (keys %{$self->parent->clients}) {
176 print $OUT "\t".$client."\t\t(".$self->parent->clients->{$client}->url.")\n";
177 }
178 } else {
179 print $OUT "No clients found!";
180 }
181 }
182 case qr/^set|^s$/ {
183 if(defined($args[0])) {
184 switch ($args[0]) {
185 case "debug_level" {
186 if(defined($args[1])) {
187 $Ham::Fldigi::Debug::debug_level = $args[1];
188 }
189 print $OUT "debug_level is ".$Ham::Fldigi::Debug::debug_level;
190 }
191 case "debug_file" {
192 if(defined($args[1])) {
193 $Ham::Fldigi::Debug::debug_file = $args[1];
194 }
195 print $OUT "debug_file is ".$Ham::Fldigi::Debug::debug_file;
196 }
197 case "debug_print" {
198 if(defined($args[1])) {
199 $Ham::Fldigi::Debug::debug_print = $args[1];
200 }
201 print $OUT "debug_print is ".$Ham::Fldigi::Debug::debug_print;
202 }
203 case "debug_write" {
204 if(defined($args[1])) {
205 $Ham::Fldigi::Debug::debug_write = $args[1];
206 }
207 print $OUT "debug_write is ".$Ham::Fldigi::Debug::debug_write;
208 }
209 }
210 } else {
211 print $OUT "\tdebug_level\t\t".$Ham::Fldigi::Debug::debug_write."\tDebug level (0-4)\n";
212 print $OUT "\tdebug_file\t\t".$Ham::Fldigi::Debug::debug_write."\tFile to log to (path)\n";
213 print $OUT "\tdebug_print\t\t".$Ham::Fldigi::Debug::debug_write."\tLog to screen (1) or not (0)\n";
214 print $OUT "\tdebug_write\t\t".$Ham::Fldigi::Debug::debug_write."\tLog to file (1) or not (0)\n";
215 }
216 }
217 case qr/^quit|^q$/ {
218 print $OUT "Exiting shell...";
219 $running = 0;
220 }
221 case qr/\w+/ {
222 if(defined($self->client)) {
223 my $arg = join(" ", @args);
224 chomp($arg);
225 my $r = $self->client->command($cmd, $arg);
226 print $OUT $r."\n";
227 } else {
228 print $OUT "Not connected to a client.\n";
229 }
230 }
231 }
232
233 }
234 }
235
236 $self->debug("Shell stopped.");
237 return 1;
238  
239 }
240  
241 1;
242 __END__