1 |
=head1 NAME |
2 |
|
3 |
Net::Knuddels - www.knuddels.de protocol implementation. |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use Net::Knuddels; |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
11 |
RTSL. |
12 |
|
13 |
=cut |
14 |
|
15 |
package Net::Knuddels; |
16 |
|
17 |
use Net::Knuddels::Dictionary; |
18 |
|
19 |
use strict; |
20 |
use utf8; |
21 |
|
22 |
use Carp; |
23 |
use Math::BigInt; |
24 |
|
25 |
sub _to32($) { |
26 |
unpack "l", pack "L", (new Math::BigInt $_[0]) & 0xffffffff |
27 |
} |
28 |
|
29 |
sub hash_pw($$) { |
30 |
my ($challenge, $pw) = @_; |
31 |
|
32 |
my $l1 = length $pw; |
33 |
my $l2 = length $challenge; |
34 |
|
35 |
my $k = chr ($l1 ^ ($l2 << 4)); |
36 |
|
37 |
my $l = $l1 < $l2 ? $l2 : $l1; |
38 |
|
39 |
my $xor = substr +($pw x 100) ^ ($challenge x 100) ^ ($k x 100), 0, $l; |
40 |
|
41 |
my ($i, $j); |
42 |
|
43 |
--$l; |
44 |
|
45 |
if ($l <= 17) { |
46 |
for (0 .. $l) { |
47 |
$i = _to32 $i * 3 + ord substr $xor, $l - $_; |
48 |
$j = _to32 $j * 5 + ord substr $xor, $_; |
49 |
} |
50 |
} else { |
51 |
for ($_ = $l; $_ >= 0; $_ -= int $_/19) { |
52 |
$i = _to32 $i * 5 + ord substr $xor, $_; |
53 |
$j = _to32 $j * 3 + ord substr $xor, $l - $_; |
54 |
} |
55 |
} |
56 |
|
57 |
$i ^= $j; |
58 |
_to32 (($i & 0xffffff) ^ ($i >> 24)) |
59 |
} |
60 |
|
61 |
my $RE_dec = join "|", keys %$Net::Knuddels::Dictionary; |
62 |
|
63 |
sub decode { |
64 |
my $bin = unpack "b*", $_[0]; |
65 |
my $res = ""; |
66 |
|
67 |
while ($bin =~ /\G($RE_dec)/cog) { |
68 |
my $frag = $Net::Knuddels::Dictionary->{$1}; |
69 |
$frag = chr unpack "v", pack "b*", $bin =~ /\G(.{16})/cg && $1 if $frag eq "\\\\\\"; |
70 |
$res .= $frag; |
71 |
} |
72 |
$bin =~ /\G(.*[^0].*)$/ and die "Net::Knuddels::Receiver: undecodable message tail '$1'"; |
73 |
|
74 |
$res |
75 |
} |
76 |
|
77 |
my %encode = reverse %$Net::Knuddels::Dictionary; |
78 |
|
79 |
my $RE_enc = join "|", map quotemeta, sort { (length $b) <=> (length $a) } keys %encode; |
80 |
|
81 |
sub encode($) { |
82 |
my ($msg) = @_; |
83 |
|
84 |
my $data = ""; |
85 |
|
86 |
while () { |
87 |
$data .= $encode{$1} while $msg =~ /\G($RE_enc)/cog; |
88 |
|
89 |
$msg =~ /\G./csog |
90 |
or last; |
91 |
|
92 |
$data .= $encode{"\\\\\\"} . unpack "b*", pack "v", ord $1; |
93 |
} |
94 |
|
95 |
pack "b*", $data |
96 |
} |
97 |
|
98 |
=head2 CLASS Net::Knuddels::Protocol |
99 |
|
100 |
You B<must> call the C<destroy> method of this class when you no longer |
101 |
use it, as circular references will keep the object alive otherwise. |
102 |
|
103 |
=over 4 |
104 |
|
105 |
=cut |
106 |
|
107 |
package Net::Knuddels::Protocol; |
108 |
|
109 |
=item new |
110 |
|
111 |
Create a new C<Net::Knuddels::Protocol> object. |
112 |
|
113 |
=cut |
114 |
|
115 |
sub new { |
116 |
my $class = shift; |
117 |
|
118 |
my %data; |
119 |
|
120 |
my $self = bless { |
121 |
@_ |
122 |
}, $class; |
123 |
|
124 |
$self; |
125 |
} |
126 |
|
127 |
=item $protocol->feed_data ($octets) |
128 |
|
129 |
Feed raw protocol data into the decoder. |
130 |
|
131 |
=cut |
132 |
|
133 |
sub feed_data($$) { |
134 |
my ($self, $data) = @_; |
135 |
|
136 |
# split data stream into packets |
137 |
|
138 |
$data = "$self->{rbuf}$data"; |
139 |
|
140 |
while () { |
141 |
1 <= length $data or last; |
142 |
my $len = ord substr $data, 0, 1; |
143 |
|
144 |
my $skip; |
145 |
if ($len & 0x80) { |
146 |
my $tail = (($len >> 5) & 3) - 1; |
147 |
$len = ($len & 0x1f) + 1; |
148 |
|
149 |
$tail < length $data or last; |
150 |
$len += (ord substr $data, $_ + 1, 1) << ($_ * 8 + 5) |
151 |
for 0 .. $tail; |
152 |
|
153 |
$skip = 2 + $tail; |
154 |
} else { |
155 |
$skip = 1; |
156 |
$len++; |
157 |
} |
158 |
|
159 |
$len + $skip <= length $data or last; |
160 |
substr $data, 0, $skip, ""; |
161 |
my $msg = substr $data, 0, $len, ""; |
162 |
|
163 |
$self->feed_msg ($msg); |
164 |
} |
165 |
|
166 |
$self->{rbuf} = $data; |
167 |
} |
168 |
|
169 |
sub feed_msg($$) { |
170 |
my ($self, $msg) = @_; |
171 |
|
172 |
$self->feed_event (split /\0/, Net::Knuddels::decode $msg); |
173 |
} |
174 |
|
175 |
sub feed_event($@) { |
176 |
my ($self, @cmd) = @_; |
177 |
|
178 |
my $ev = $self->{cb}{ALL}; |
179 |
$_->(@cmd) for values %$ev; |
180 |
|
181 |
unless ($self->{cb}{$cmd[0]}) { |
182 |
my $ev = $self->{cb}{UNHANDLED}; |
183 |
$_->(@cmd) for values %$ev; |
184 |
} |
185 |
|
186 |
my $ev = $self->{cb}{shift @cmd}; |
187 |
$_->(@cmd) for values %$ev; |
188 |
} |
189 |
|
190 |
=item $msg = $protocol->encode_msg (@strings) |
191 |
|
192 |
Join the strings with C<\0>, encode the result into a protocol packet and |
193 |
return it. |
194 |
|
195 |
=cut |
196 |
|
197 |
sub encode_msg($@) { |
198 |
my ($self, @args) = @_; |
199 |
my $msg = Net::Knuddels::encode join "\0", @args; |
200 |
my $len = (length $msg) - 1; |
201 |
|
202 |
if ($len < 0x80) { |
203 |
(chr $len) . $msg |
204 |
} else { |
205 |
(chr 0x80 | 0x40 | ($len & 0x1f)) |
206 |
. (chr +($len >> 5) % 0xff) |
207 |
. (chr +($len >> 13) % 0xff) |
208 |
. $msg |
209 |
} |
210 |
} |
211 |
|
212 |
=item $protocol->register ($type => $callback) |
213 |
|
214 |
Register a callback for events of type C<$type>, which is either the name |
215 |
of a low-level event sent by the server (such as "k" for dialog box) or |
216 |
the name of a generated event, such as C<login>. |
217 |
|
218 |
=cut |
219 |
|
220 |
sub register { |
221 |
my ($self, $type, $cb) = @_; |
222 |
|
223 |
$self->{cb}{$type}{$cb} = $cb; |
224 |
} |
225 |
|
226 |
=item $protocol->destroy |
227 |
|
228 |
I<MUST> be called to destroy the object, otherwise it will leak (no automatic cleanup). |
229 |
|
230 |
=cut |
231 |
|
232 |
sub destroy { |
233 |
my ($self) = @_; |
234 |
|
235 |
delete $self->{cb}; |
236 |
} |
237 |
|
238 |
=back |
239 |
|
240 |
=head2 CLASS Net::Knuddels::Client |
241 |
|
242 |
Implement a Knuddels client connection. |
243 |
|
244 |
=over 4 |
245 |
|
246 |
=cut |
247 |
|
248 |
package Net::Knuddels::Client; |
249 |
|
250 |
sub handle_room { |
251 |
my ($self, $room) = @_; |
252 |
|
253 |
if ($room eq "-") { |
254 |
if (defined $self->{only_room}) { |
255 |
return $self->{only_room}; |
256 |
} else { |
257 |
warn "Couldn't assign '-' room to a room!"; |
258 |
return '-'; |
259 |
} |
260 |
} else { |
261 |
return $room; |
262 |
} |
263 |
} |
264 |
|
265 |
sub update_user_stats { |
266 |
my ($user) = @_; |
267 |
|
268 |
if ($user->{name} =~ s/\cJ(\d+)$//) { |
269 |
$user->{age} = $1 |
270 |
} |
271 |
|
272 |
if ($user->{picture} =~ m/\bmale/) { |
273 |
$user->{gender} = 'm'; |
274 |
|
275 |
} elsif ($user->{picture} =~ m/female/) { |
276 |
$user->{gender} = 'f'; |
277 |
} |
278 |
|
279 |
return $user; |
280 |
} |
281 |
|
282 |
sub del1 { |
283 |
my ($str) = @_; |
284 |
my $s = substr ($$str, 0, 1); |
285 |
$$str = substr ($$str, 1); |
286 |
$s |
287 |
} |
288 |
|
289 |
sub del2 { |
290 |
my ($str) = @_; |
291 |
my $s = substr ($$str, 0, 2); |
292 |
$$str = substr ($$str, 2); |
293 |
$s |
294 |
} |
295 |
|
296 |
sub todelim { |
297 |
my ($str) = @_; |
298 |
$$str =~ s/^(.*?)\365//; |
299 |
$1; |
300 |
} |
301 |
|
302 |
sub chk_flag { |
303 |
my ($str) = @_; |
304 |
if ($$str =~ s/^\343//) { |
305 |
return 1; |
306 |
} |
307 |
return 0; |
308 |
} |
309 |
|
310 |
my %switch_main = ( |
311 |
's' => sub { |
312 |
|
313 |
}, |
314 |
'w' => sub { |
315 |
|
316 |
}, |
317 |
); |
318 |
|
319 |
=pod |
320 |
sub clean_windef { |
321 |
my ($self, $windef) = @_; |
322 |
|
323 |
my $wd = {}; |
324 |
|
325 |
$wd->{title} = todelim \$windef; |
326 |
|
327 |
while (not chk_flag \$windef) { |
328 |
my $c = del1 \$windef; |
329 |
if ($c eq 's') { |
330 |
$wd->{cmd} = todelim \$windef; |
331 |
$wd->{nickname} = todelim \$windef; |
332 |
} elsif ($c eq 'w' or $c eq 'p') { |
333 |
del2 \$windef; |
334 |
} elsif ($c eq 'h' or $c eq 'f') { |
335 |
del1 \$windef; |
336 |
} elsif ($c eq 'r') { |
337 |
# ... resizeable |
338 |
} |
339 |
} |
340 |
|
341 |
my $fl1 = 0; |
342 |
do { # holgi, i will hit you |
343 |
my $c = del1 \$windef; |
344 |
|
345 |
if ($c eq 'U') { |
346 |
$wd->{weird_field} = todelim \$windef; |
347 |
$fl1 = 1; |
348 |
|
349 |
} elsif ($c eq 'G') { |
350 |
del2 \$windef; del2 \$windef; |
351 |
|
352 |
} elsif ($c eq 'F') { |
353 |
|
354 |
} elsif ($c eq 'B') { |
355 |
del1 \$windef; |
356 |
|
357 |
} else { |
358 |
$fl2 = 1; |
359 |
$windef = $c . $windef; |
360 |
} |
361 |
} while ($fl1); |
362 |
|
363 |
while (not chk_flag \$windef) { |
364 |
if ($fl2) { |
365 |
my $c = del1 \$winddef |
366 |
if (not ($c eq 'N' |
367 |
or $c eq 'S' |
368 |
or $c eq 'E' |
369 |
or $c eq 'W' |
370 |
or $c eq 'C')) |
371 |
{ |
372 |
$windef = $c . $windef; |
373 |
} |
374 |
} |
375 |
|
376 |
} |
377 |
|
378 |
return $wd; |
379 |
} |
380 |
=cut |
381 |
|
382 |
=item new Net::Knuddels::Client [IO::Socket::new arguments] |
383 |
|
384 |
Create a new client connection. |
385 |
|
386 |
=cut |
387 |
|
388 |
use IO::Socket::INET; |
389 |
|
390 |
sub new { |
391 |
my ($class, @arg) = @_; |
392 |
|
393 |
my $fh = new IO::Socket::INET @arg |
394 |
or Carp::croak "Net::Knuddels::Client::new: $!"; |
395 |
|
396 |
my $self = bless { |
397 |
fh => $fh, |
398 |
proto => (new Net::Knuddels::Protocol), |
399 |
}, $class; |
400 |
|
401 |
syswrite $fh, "\0"; |
402 |
|
403 |
$self->register ("(" => sub { |
404 |
$self->{login_challenge} = $_[0]; |
405 |
$self->{login_room} = $_[1]; |
406 |
$self->{proto}->feed_event ("login"); |
407 |
}); |
408 |
$self->register (k => sub { |
409 |
my @str = map { s/[\356\343]//; $_ } @_; |
410 |
my @out; |
411 |
push @out, split /#/, $_ for @str; |
412 |
$self->{proto}->feed_event (dialog => \@out); |
413 |
}); |
414 |
$self->register (t => sub { |
415 |
my $src = $_[0]; |
416 |
if ($src eq '-') { |
417 |
$_[2] = $self->{knuddels_nick} . " " . $_[2]; |
418 |
} else { |
419 |
$_[2] = $src . " " . $_[2]; |
420 |
} |
421 |
$self->{proto}->feed_event (action_room => $self->handle_room ($_[1]), $_[2]); |
422 |
}); |
423 |
$self->register (r => sub { |
424 |
my $src = $_[0]; |
425 |
$src = $self->{knuddels_nick} if $src eq "-"; |
426 |
$self->{proto}->feed_event (msg_priv => $self->handle_room ($_[2]), $src, $_[1], $_[3]); |
427 |
}); |
428 |
$self->register (e => sub { |
429 |
$self->{proto}->feed_event (msg_room => $self->handle_room ($_[1]), $_[0], $_[2]); |
430 |
}); |
431 |
$self->register (l => sub { |
432 |
my $room = $self->handle_room ($_[0]); |
433 |
return if $room eq "-"; # things that shouln't happen |
434 |
|
435 |
my $user = { |
436 |
name => $_[1], |
437 |
flag => $_[2], |
438 |
color => $_[3], |
439 |
picture => $_[4] |
440 |
}; |
441 |
|
442 |
update_user_stats ($user); |
443 |
|
444 |
my $rl = $self->{user_lists}->{lc $room}->{lc $user->{name}} = $user; |
445 |
|
446 |
$self->{proto}->feed_event (join_room => $room, $user); |
447 |
}); |
448 |
$self->register (w => sub { |
449 |
my $room = $self->handle_room ($_[1]); |
450 |
return if $room eq "-"; # things that shouln't happen |
451 |
|
452 |
my $username = $_[0]; |
453 |
|
454 |
my $u = delete $self->{user_lists}->{lc $room}->{lc $username}; |
455 |
|
456 |
if (not defined $u) { |
457 |
warn "User $username wasn't in room $room, trying to fix... but be careful!!!\n"; |
458 |
$u = { name => $username }; |
459 |
} |
460 |
|
461 |
$self->{proto}->feed_event (part_room => $room, $u); |
462 |
}); |
463 |
$self->register (a => sub { |
464 |
# the only_room stuff is from java-code, which has naughy semantics |
465 |
if (not defined $self->{only_room}) { |
466 |
$self->{only_room} = $_[0]; |
467 |
} else { |
468 |
$self->{only_room} = "-"; |
469 |
} |
470 |
|
471 |
$self->{my_nick} = $_[1]; # i'm really _not_ shure about this |
472 |
|
473 |
my $ri = $self->{room}->{lc $_[0]} = { |
474 |
picture => $_[7], |
475 |
}; |
476 |
|
477 |
$self->{proto}->feed_event (room_info => $_[0], $ri); |
478 |
}); |
479 |
$self->register (u => sub { |
480 |
my $room = shift; |
481 |
my $rl = $self->{user_lists}->{lc $room} = {}; |
482 |
my $cur_u = {}; |
483 |
|
484 |
while (@_) { |
485 |
$cur_u->{name} = shift; |
486 |
$cur_u->{flag} = shift; |
487 |
$cur_u->{color} = shift; |
488 |
|
489 |
my $i = 0; |
490 |
|
491 |
while ((my $nxt = shift) ne "-") { |
492 |
if ($i == 0) { |
493 |
$cur_u->{picture} = $nxt; |
494 |
} |
495 |
$i++; |
496 |
} |
497 |
|
498 |
update_user_stats ($cur_u); |
499 |
$rl->{lc $cur_u->{name}} = $cur_u; |
500 |
$cur_u = {}; |
501 |
} |
502 |
$self->{proto}->feed_event (user_list => $room, $rl); |
503 |
}); |
504 |
|
505 |
$self |
506 |
} |
507 |
|
508 |
=item $client->fh |
509 |
|
510 |
Return the fh used for communications. You are responsible for calling C<< |
511 |
$client->ready >> whenever the fh becomes ready for reading. |
512 |
|
513 |
=cut |
514 |
|
515 |
sub fh { |
516 |
$_[0]->{fh} |
517 |
} |
518 |
|
519 |
=item $client->ready |
520 |
|
521 |
To be called then the filehandle is ready for reading. Returns false if |
522 |
the server closed the connection, true otherwise. |
523 |
|
524 |
=cut |
525 |
|
526 |
sub ready { |
527 |
my ($self) = @_; |
528 |
|
529 |
sysread $self->{fh}, my $buf, 8192 |
530 |
or return; |
531 |
|
532 |
$self->{proto}->feed_data ($buf); |
533 |
|
534 |
1; |
535 |
} |
536 |
|
537 |
=item $client->command ($type => @args) |
538 |
|
539 |
Send a message of type C<$type> and the given arguments to the server. |
540 |
|
541 |
=cut |
542 |
|
543 |
sub command { |
544 |
my ($self, $type, @args) = @_; |
545 |
|
546 |
#use Dumpvalue; Dumpvalue->new (compactDump => 1, veryCompact => 1, quoteHighBit => 1, tick => '"')->dumpValue ([$type, @args]); |
547 |
|
548 |
syswrite $self->{fh}, $self->{proto}->encode_msg ($type, @args); |
549 |
} |
550 |
|
551 |
=item $client->login ($url, $unknown) |
552 |
|
553 |
Send a 't' message. The default for C<$url> is |
554 |
C<http://www.knuddels.de/applet.html?v=86a&c=0> and C<$unknown> is C<6>. |
555 |
|
556 |
=cut |
557 |
|
558 |
sub login { |
559 |
my ($self, $url, $unknown) = @_; |
560 |
|
561 |
$self->command ("t", "V8.6a", $url || "http://www.knuddels.de/applet.html?v=86a&c=0", $unknown || 3); |
562 |
} |
563 |
|
564 |
=item $client->set_nick ($room, $nick, $password) |
565 |
|
566 |
Registers the nick with the given password. |
567 |
|
568 |
=cut |
569 |
|
570 |
sub set_nick { |
571 |
my ($self, $room, $nick, $password) = @_; |
572 |
|
573 |
exists $self->{login_challenge} or Carp::croak "set_nick can only be called after a login event"; |
574 |
|
575 |
$self->{knuddels_nick} = $nick; |
576 |
$self->command ("n", $room, $nick, Net::Knuddels::hash_pw $self->{login_challenge}, $password); |
577 |
} |
578 |
|
579 |
=item $client->send_whois ($nick) |
580 |
|
581 |
Sends a whois-request for $nick. |
582 |
|
583 |
=cut |
584 |
sub send_whois { |
585 |
my ($self, $room, $nick) = @_; |
586 |
|
587 |
print "send: $room:/w $nick\n"; |
588 |
$self->command ("e", $room, "/w $nick"); |
589 |
} |
590 |
|
591 |
|
592 |
=item $client->send_room_msg ($nick, $room, $message) |
593 |
|
594 |
Sends a private C<$message> to C<$nick> over C<$room>. |
595 |
|
596 |
=cut |
597 |
sub send_room_msg { |
598 |
my ($self, $room, $message) = @_; |
599 |
|
600 |
print "SEND ROOM: $room : $message\n"; |
601 |
$self->command ("e", $room, $message); |
602 |
} |
603 |
|
604 |
|
605 |
=item $client->send_priv_msg ($nick, $room, $message) |
606 |
|
607 |
Sends a private C<$message> to C<$nick> over C<$room>. |
608 |
|
609 |
=cut |
610 |
sub send_priv_msg { |
611 |
my ($self, $nick, $room, $message) = @_; |
612 |
|
613 |
print "SEND ROOM: $room : /p $nick:$message\n"; |
614 |
$self->command ("e", $room, "/p $nick:$message"); |
615 |
} |
616 |
|
617 |
=item $client->register ($type => $cb) |
618 |
|
619 |
See L<Net::Knuddels::Protocol::register>. The following extra events will |
620 |
be generated by this class: |
621 |
|
622 |
login |
623 |
set_nick can only be called _after_ a login event has occured. |
624 |
|
625 |
msg_room => $room, $user, $msg |
626 |
produced when a public message is uttered :) |
627 |
|
628 |
msg_room => $room, $src, $dst, $msg |
629 |
personal message from $src to $dst |
630 |
|
631 |
user_list => $room, $list |
632 |
the userlist of a channel named $room, a elmement of the list (a user) |
633 |
looks like: |
634 |
{ |
635 |
name => <name>, |
636 |
flag => <some flag i don't know what it means>, |
637 |
color => like /\d+.\d+.\d+/, |
638 |
age => /\d+/, |
639 |
gender => /(f|m)/, |
640 |
picture => <the picture file to put behind the nick> |
641 |
} |
642 |
|
643 |
room_info => $room, $room_info |
644 |
some information about the $room: |
645 |
$room_info = |
646 |
{ |
647 |
picture => <some picturefile> |
648 |
} |
649 |
|
650 |
join_room => $room, $user |
651 |
join message of $user joined the room $room |
652 |
$user contains the user structure (see user_list). |
653 |
|
654 |
part_room => $room, $user |
655 |
part message of $user who left the room $room |
656 |
$user contains the user structure (see user_list). |
657 |
=cut |
658 |
|
659 |
sub register { |
660 |
my ($self, $type, $cb) = @_; |
661 |
|
662 |
$self->{proto}->register ($type, $cb); |
663 |
} |
664 |
|
665 |
=back |
666 |
|
667 |
=head1 AUTHOR |
668 |
|
669 |
Marc Lehmann <pcg@goof.com> |
670 |
http://home.schmorp.de/ |
671 |
|
672 |
=cut |
673 |
|
674 |
1; |
675 |
|