]> gb7djk.dxcluster.net Git - spider.git/blob - perl/DXProtout.pm
add panes
[spider.git] / perl / DXProtout.pm
1 #!/usr/bin/perl
2 #
3 # This module impliments the outgoing PCxx generation routines
4 #
5 # These are all the namespace of DXProt and are separated for "clarity"
6 #
7 # Copyright (c) 1998 Dirk Koopman G1TLH
8 #
9 # $Id$
10
11
12 package DXProt;
13
14 @ISA = qw(DXProt DXChannel);
15
16 use DXUtil;
17 use DXM;
18 use DXDebug;
19
20 use strict;
21
22 use vars qw($VERSION $BRANCH);
23 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
24 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
25 $main::build += $VERSION;
26 $main::branch += $BRANCH;
27
28 use vars qw($sentencelth);
29
30 $sentencelth = 180;
31
32 #
33 # All the PCxx generation routines
34 #
35
36 # create a talk string ($from, $to, $via, $text)
37 sub pc10
38 {
39         my ($from, $to, $via, $text, $origin) = @_;
40         my ($user1, $user2);
41         if ($via && $via ne $to) {
42                 $user1 = $via;
43                 $user2 = $to;
44         } else {
45                 $user2 = ' ';
46                 $user1 = $to;
47         }
48         $origin ||= $main::mycall;
49         $text = unpad($text);
50         $text = ' ' unless $text && length $text > 0;
51         $text =~ s/\^/%5E/g;
52         return "PC10^$from^$user1^$text^*^$user2^$origin^~";  
53 }
54
55 # create a dx message (call, freq, dxcall, text) 
56 sub pc11
57 {
58         my ($mycall, $freq, $dxcall, $text) = @_;
59         my $hops = get_hops(11);
60         my $t = time;
61         $text = ' ' if !$text;
62         $text =~ s/\^/%5E/g;
63         return sprintf "PC11^%.1f^$dxcall^%s^%s^$text^$mycall^$main::mycall^$hops^~", $freq, cldate($t), ztime($t);
64 }
65
66 # create an announce message
67 sub pc12
68 {
69         my ($call, $text, $tonode, $sysop, $wx, $origin) = @_;
70         my $hops = get_hops(12);
71         $text ||= ' ';
72         $text =~ s/\^/%5E/g;
73         $tonode ||= '*';
74         $sysop ||= ' ';
75         $wx ||= '0';
76         $origin ||= $main::mycall;
77         return "PC12^$call^$tonode^$text^$sysop^$origin^$wx^$hops^~";
78 }
79
80 #
81 # add one or more users (I am expecting references that have 'call', 
82 # 'conf' & 'here' method) 
83 #
84 # this will create a list of PC16 with up pc16_max_users in each
85 # called $self->pc16(..)
86 #
87 sub pc16
88 {
89         my $node = shift;
90         my $ncall = $node->call;
91         my @out;
92
93         my $s = "";
94         for (@_) {
95                 next unless $_;
96                 my $ref = $_;
97                 my $str = sprintf "^%s %s %d", $ref->call, $ref->conf ? '*' : '-', $ref->here;
98                 if (length($s) + length($str) > $sentencelth) {
99                         push @out, "PC16^$ncall" . $s . sprintf "^%s^", get_hops(16);
100                         $s = "";
101                 }
102                 $s .= $str;
103         }
104         push @out, "PC16^$ncall" . $s . sprintf "^%s^", get_hops(16);
105         return @out;
106 }
107
108 # remove a local user
109 sub pc17
110 {
111         my @out;
112         while (@_) {
113                 my $node = shift;
114                 my $ref = shift;
115                 my $hops = get_hops(17);
116                 my $ncall = $node->call;
117                 my $ucall = $ref->call;
118                 push @out, "PC17^$ucall^$ncall^$hops^"; 
119         }
120         return @out;
121 }
122
123 # Request init string
124 sub pc18
125 {
126         my $flags = "";
127         $flags .= " xml" if DXXml::available(); 
128         return "PC18^DXSpider Version: $main::version Build: $main::build$flags^$DXProt::myprot_version^";
129 }
130
131 #
132 # add one or more nodes 
133
134 sub pc19
135 {
136         my @out;
137         my @in;
138
139         my $s = "";
140         for (@_) {
141                 next unless $_;
142                 my $ref = $_;
143                 my $call = $ref->call;
144                 my $here = $ref->here;
145                 my $conf = $ref->conf;
146                 my $version = $ref->version;
147                 my $str = "^$here^$call^$conf^$version";
148                 if (length($s) + length($str) > $sentencelth) {
149                         push @out, "PC19" . $s . sprintf "^%s^", get_hops(19);
150                         $s = "";
151                 }
152                 $s .= $str;
153         }
154         push @out, "PC19" . $s . sprintf "^%s^", get_hops(19);
155         return @out;
156 }
157
158 # end of Rinit phase
159 sub pc20
160 {
161         return 'PC20^';
162 }
163
164 # delete a node
165 sub pc21
166 {
167         my @out;
168         while (@_) {
169                 my $node = shift;
170                 my $hops = get_hops(21);
171                 my $call = $node->call;
172                 push @out, "PC21^$call^Gone^$hops^";
173         }
174         return @out;
175 }
176
177 # end of init phase
178 sub pc22
179 {
180         return 'PC22^';
181 }
182
183 # here status
184 sub pc24
185 {
186         my $self = shift;
187         my $call = $self->call;
188         my $flag = $self->here ? '1' : '0';
189         my $hops = shift || get_hops(24);
190   
191         return "PC24^$call^$flag^$hops^";
192 }
193
194
195 # create a merged dx message (freq, dxcall, t, text, spotter, orig-node) 
196 sub pc26
197 {
198         my ($freq, $dxcall, $t, $text, $spotter, $orignode) = @_;
199         $text = ' ' unless $text;
200         $orignode = $main::mycall unless $orignode;
201         return sprintf "PC26^%.1f^$dxcall^%s^%s^$text^$spotter^$orignode^ ^~", $freq, cldate($t), ztime($t);
202 }
203
204 # create a merged WWV spot (logger, t, sfi, a, k, forecast, orig-node)
205 sub pc27
206 {
207         my ($logger, $t, $sfi, $a, $k, $forecast, $orignode) = @_;
208         return sprintf "PC27^%s^%-2.2s^$sfi^$a^$k^$forecast^$logger^$orignode^ ^~", cldate($t), ztime($t);
209 }
210
211 # message start (fromnode, tonode, to, from, t, private, subject, origin)
212 sub pc28
213 {
214         my ($tonode, $fromnode, $to, $from, $t, $private, $subject, $origin, $rr) = @_;
215         my $date = cldate($t);
216         my $time = ztime($t);
217         $private = $private ? '1' : '0';
218         $rr = $rr ? '1' : '0';
219         $subject ||= ' ';
220         return "PC28^$tonode^$fromnode^$to^$from^$date^$time^$private^$subject^ ^5^$rr^ ^$origin^~";
221 }
222
223 # message text (from and to node same way round as pc29)
224 sub pc29 
225 {
226         my ($fromnode, $tonode, $stream, $text) = @_;
227         $text = ' ' unless defined $text && length $text > 0;
228         $text =~ s/\^/%5E/og;                   # remove ^
229         return "PC29^$fromnode^$tonode^$stream^$text^~";
230 }
231
232 # subject acknowledge (will have to and from node reversed to pc28)
233 sub pc30
234 {
235         my ($fromnode, $tonode, $stream) = @_;
236         return "PC30^$fromnode^$tonode^$stream^";
237 }
238
239 # acknowledge this tranche of lines (to and from nodes reversed to pc29 and pc28
240 sub pc31
241 {
242         my ($fromnode, $tonode, $stream) = @_;
243         return "PC31^$fromnode^$tonode^$stream^";
244 }
245
246 #  end of message from the sending end (pc28 node order)
247 sub pc32
248 {
249         my ($fromnode, $tonode, $stream) = @_;
250         return "PC32^$fromnode^$tonode^$stream^";
251 }
252
253 # acknowledge end of message from receiving end (opposite pc28 node order)
254 sub pc33
255 {
256         my ($fromnode, $tonode, $stream) = @_;
257         return "PC33^$fromnode^$tonode^$stream^";
258 }
259
260 # remote cmd send
261 sub pc34
262 {
263         my($fromnode, $tonode, $msg) = @_;
264         return "PC34^$tonode^$fromnode^$msg^~";
265 }
266
267 # remote cmd reply
268 sub pc35
269 {
270         my($fromnode, $tonode, $msg) = @_;
271         return "PC35^$tonode^$fromnode^$msg^~";
272 }
273
274 # send all the DX clusters I reckon are connected
275 sub pc38
276 {
277         return join '^', "PC38", map {$_->call} Route::Node::get_all();
278 }
279
280 # tell the local node to discconnect
281 sub pc39
282 {
283         my ($call, $reason) = @_;
284         my $hops = get_hops(39);
285         $reason = "Gone." if !$reason;
286         return "PC39^$call^$reason^$hops^";
287 }
288
289 # cue up bulletin or file for transfer
290 sub pc40
291 {
292         my ($to, $from, $fn, $bull) = @_;
293         $bull = $bull ? '1' : '0';
294         return "PC40^$to^$from^$fn^$bull^5^";
295 }
296
297 # user info
298 sub pc41
299 {
300         my $call = shift;
301         $call = shift if ref $call;
302         
303         my $sort = shift || '0';
304         my $info = shift || ' ';
305         my $hops = shift || get_hops(41);
306         return "PC41^$call^$sort^$info^$hops^~";
307 }
308
309 # abort message
310 sub pc42
311 {
312         my ($fromnode, $tonode, $stream) = @_;
313         return "PC42^$fromnode^$tonode^$stream^";
314 }
315
316 # remote db request
317 sub pc44
318 {
319         my ($fromnode, $tonode, $stream, $db, $req, $call) = @_;
320         $db = uc $db;
321         return "PC44^$tonode^$fromnode^$stream^$db^$req^$call^";
322 }
323
324 # remote db data
325 sub pc45
326 {
327         my ($fromnode, $tonode, $stream, $data) = @_;
328         return "PC45^$tonode^$fromnode^$stream^$data^";
329 }
330
331 # remote db data complete
332 sub pc46
333 {
334         my ($fromnode, $tonode, $stream) = @_;
335         return "PC46^$tonode^$fromnode^$stream^";
336 }
337
338 # bull delete
339 sub pc49
340 {
341         my ($from, $subject) = @_;
342         my $hops = get_hops(49);
343         return "PC49^$from^$subject^$hops^~";
344 }
345
346 # periodic update of users, plus keep link alive device (always H99)
347 sub pc50
348 {
349         my $self = shift;
350         my $call = $self->call;
351         my $n = shift || '0';
352         my $hops = shift || 'H99';
353         return "PC50^$call^$n^$hops^";
354 }
355
356 # generate pings
357 sub pc51
358 {
359         my ($to, $from, $val) = @_;
360         return "PC51^$to^$from^$val^";
361 }
362
363 # clx remote cmd send
364 sub pc84
365 {
366         my($fromnode, $tonode, $call, $msg) = @_;
367         return "PC84^$tonode^$fromnode^$call^$msg^~";
368 }
369
370 # clx remote cmd reply
371 sub pc85
372 {
373         my($fromnode, $tonode, $call, $msg) = @_;
374         return "PC85^$tonode^$fromnode^$call^$msg^~";
375 }
376
377 # spider route broadcast
378 sub pc90
379 {
380 }
381
382 1;
383 __END__
384
385
386