1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | Crossfire::Client - undocumented utility garbage for our crossfire client |
3 | CFPlus - undocumented utility garbage for our crossfire client |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use Crossfire::Client; |
7 | use CFPlus; |
8 | |
8 | |
9 | =head1 DESCRIPTION |
9 | =head1 DESCRIPTION |
10 | |
10 | |
11 | =over 4 |
11 | =over 4 |
12 | |
12 | |
13 | =cut |
13 | =cut |
14 | |
14 | |
15 | package Crossfire::Client; |
15 | package CFPlus; |
|
|
16 | |
|
|
17 | use Carp (); |
16 | |
18 | |
17 | BEGIN { |
19 | BEGIN { |
18 | $VERSION = '0.1'; |
20 | $VERSION = '0.97'; |
19 | |
21 | |
20 | use XSLoader; |
22 | use XSLoader; |
21 | XSLoader::load "Crossfire::Client", $VERSION; |
23 | XSLoader::load "CFPlus", $VERSION; |
|
|
24 | } |
|
|
25 | |
|
|
26 | use utf8; |
|
|
27 | |
|
|
28 | use AnyEvent (); |
|
|
29 | use BerkeleyDB; |
|
|
30 | use Pod::POM (); |
|
|
31 | use Scalar::Util (); |
|
|
32 | use Storable (); # finally |
|
|
33 | |
|
|
34 | BEGIN { |
|
|
35 | use Crossfire::Protocol::Base (); |
|
|
36 | *to_json = \&Crossfire::Protocol::Base::to_json; |
|
|
37 | *from_json = \&Crossfire::Protocol::Base::from_json; |
|
|
38 | } |
|
|
39 | |
|
|
40 | =item guard { BLOCK } |
|
|
41 | |
|
|
42 | Returns an object that executes the given block as soon as it is destroyed. |
|
|
43 | |
|
|
44 | =cut |
|
|
45 | |
|
|
46 | sub guard(&) { |
|
|
47 | bless \(my $cb = $_[0]), "CFPlus::Guard" |
|
|
48 | } |
|
|
49 | |
|
|
50 | sub CFPlus::Guard::DESTROY { |
|
|
51 | ${$_[0]}->() |
|
|
52 | } |
|
|
53 | |
|
|
54 | sub asxml($) { |
|
|
55 | local $_ = $_[0]; |
|
|
56 | |
|
|
57 | s/&/&/g; |
|
|
58 | s/>/>/g; |
|
|
59 | s/</</g; |
|
|
60 | |
|
|
61 | $_ |
|
|
62 | } |
|
|
63 | |
|
|
64 | sub socketpipe() { |
|
|
65 | socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC |
|
|
66 | or die "cannot establish bidiretcional pipe: $!\n"; |
|
|
67 | |
|
|
68 | ($fh1, $fh2) |
|
|
69 | } |
|
|
70 | |
|
|
71 | sub background(&;&) { |
|
|
72 | my ($bg, $cb) = @_; |
|
|
73 | |
|
|
74 | my ($fh_r, $fh_w) = CFPlus::socketpipe; |
|
|
75 | |
|
|
76 | my $pid = fork; |
|
|
77 | |
|
|
78 | if (defined $pid && !$pid) { |
|
|
79 | local $SIG{__DIE__}; |
|
|
80 | |
|
|
81 | open STDOUT, ">&", $fh_w; |
|
|
82 | open STDERR, ">&", $fh_w; |
|
|
83 | close $fh_r; |
|
|
84 | close $fh_w; |
|
|
85 | |
|
|
86 | $| = 1; |
|
|
87 | |
|
|
88 | eval { $bg->() }; |
|
|
89 | |
|
|
90 | if ($@) { |
|
|
91 | my $msg = $@; |
|
|
92 | $msg =~ s/\n+/\n/; |
|
|
93 | warn "FATAL: $msg"; |
|
|
94 | CFPlus::_exit 1; |
|
|
95 | } |
|
|
96 | |
|
|
97 | # win32 is fucked up, of course. exit will clean stuff up, |
|
|
98 | # which destroys our database etc. _exit will exit ALL |
|
|
99 | # forked processes, because of the dreaded fork emulation. |
|
|
100 | CFPlus::_exit 0; |
|
|
101 | } |
|
|
102 | |
|
|
103 | close $fh_w; |
|
|
104 | |
|
|
105 | my $buffer; |
|
|
106 | |
|
|
107 | my $w; $w = AnyEvent->io (fh => $fh_r, poll => 'r', cb => sub { |
|
|
108 | unless (sysread $fh_r, $buffer, 4096, length $buffer) { |
|
|
109 | undef $w; |
|
|
110 | $cb->(); |
|
|
111 | return; |
|
|
112 | } |
|
|
113 | |
|
|
114 | while ($buffer =~ s/^(.*)\n//) { |
|
|
115 | my $line = $1; |
|
|
116 | $line =~ s/\s+$//; |
|
|
117 | utf8::decode $line; |
|
|
118 | if ($line =~ /^\x{e877}json_msg (.*)$/s) { |
|
|
119 | $cb->(from_json $1); |
|
|
120 | } else { |
|
|
121 | ::message ({ |
|
|
122 | markup => "background($pid): " . CFPlus::asxml $line, |
|
|
123 | }); |
|
|
124 | } |
|
|
125 | } |
|
|
126 | }); |
|
|
127 | } |
|
|
128 | |
|
|
129 | sub background_msg { |
|
|
130 | my ($msg) = @_; |
|
|
131 | |
|
|
132 | $msg = "\x{e877}json_msg " . to_json $msg; |
|
|
133 | $msg =~ s/\n//g; |
|
|
134 | utf8::encode $msg; |
|
|
135 | print $msg, "\n"; |
|
|
136 | } |
|
|
137 | |
|
|
138 | package CFPlus::Database; |
|
|
139 | |
|
|
140 | our @ISA = BerkeleyDB::Btree::; |
|
|
141 | |
|
|
142 | sub get($$) { |
|
|
143 | my $data; |
|
|
144 | |
|
|
145 | $_[0]->db_get ($_[1], $data) == 0 |
|
|
146 | ? $data |
|
|
147 | : () |
|
|
148 | } |
|
|
149 | |
|
|
150 | my %DB_SYNC; |
|
|
151 | |
|
|
152 | sub put($$$) { |
|
|
153 | my ($db, $key, $data) = @_; |
|
|
154 | |
|
|
155 | my $hkey = $db + 0; |
|
|
156 | Scalar::Util::weaken $db; |
|
|
157 | $DB_SYNC{$hkey} ||= AnyEvent->timer (after => 5, cb => sub { |
|
|
158 | delete $DB_SYNC{$hkey}; |
|
|
159 | $db->db_sync if $db; |
|
|
160 | }); |
|
|
161 | |
|
|
162 | $db->db_put ($key => $data) |
|
|
163 | } |
|
|
164 | |
|
|
165 | package CFPlus; |
|
|
166 | |
|
|
167 | sub find_rcfile($) { |
|
|
168 | my $path; |
|
|
169 | |
|
|
170 | for (grep !ref, @INC) { |
|
|
171 | $path = "$_/CFPlus/resources/$_[0]"; |
|
|
172 | return $path if -r $path; |
|
|
173 | } |
|
|
174 | |
|
|
175 | die "FATAL: can't find required file $_[0]\n"; |
|
|
176 | } |
|
|
177 | |
|
|
178 | sub read_cfg { |
|
|
179 | my ($file) = @_; |
|
|
180 | |
|
|
181 | open my $fh, $file |
|
|
182 | or return; |
|
|
183 | |
|
|
184 | local $/; |
|
|
185 | my $CFG = <$fh>; |
|
|
186 | |
|
|
187 | if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove |
|
|
188 | require YAML; |
|
|
189 | utf8::decode $CFG; |
|
|
190 | $::CFG = YAML::Load ($CFG); |
|
|
191 | } elsif ($CFG =~ /^\{/) { |
|
|
192 | $::CFG = from_json $CFG; |
|
|
193 | } else { |
|
|
194 | $::CFG = eval $CFG; ## todo comaptibility cruft |
|
|
195 | } |
|
|
196 | } |
|
|
197 | |
|
|
198 | sub write_cfg { |
|
|
199 | my ($file) = @_; |
|
|
200 | |
|
|
201 | $::CFG->{VERSION} = $::VERSION; |
|
|
202 | |
|
|
203 | open my $fh, ">:utf8", $file |
|
|
204 | or return; |
|
|
205 | print $fh to_json $::CFG; |
|
|
206 | } |
|
|
207 | |
|
|
208 | sub http_proxy { |
|
|
209 | my @proxy = win32_proxy_info; |
|
|
210 | |
|
|
211 | if (@proxy) { |
|
|
212 | "http://" . (@proxy < 2 ? "" : @proxy < 3 ? "$proxy[1]\@" : "$proxy[1]:$proxy[2]\@") . $proxy[0] |
|
|
213 | } elsif (exists $ENV{http_proxy}) { |
|
|
214 | $ENV{http_proxy} |
|
|
215 | } else { |
|
|
216 | () |
|
|
217 | } |
|
|
218 | } |
|
|
219 | |
|
|
220 | sub set_proxy { |
|
|
221 | my $proxy = http_proxy |
|
|
222 | or return; |
|
|
223 | |
|
|
224 | $ENV{http_proxy} = $proxy; |
|
|
225 | } |
|
|
226 | |
|
|
227 | sub lwp_useragent { |
|
|
228 | require LWP::UserAgent; |
|
|
229 | |
|
|
230 | CFPlus::set_proxy; |
|
|
231 | |
|
|
232 | my $ua = LWP::UserAgent->new ( |
|
|
233 | agent => "cfplus $VERSION", |
|
|
234 | keep_alive => 1, |
|
|
235 | env_proxy => 1, |
|
|
236 | timeout => 30, |
|
|
237 | ); |
|
|
238 | } |
|
|
239 | |
|
|
240 | sub lwp_check($) { |
|
|
241 | my ($res) = @_; |
|
|
242 | |
|
|
243 | $res->is_error |
|
|
244 | and die $res->status_line; |
|
|
245 | |
|
|
246 | $res |
|
|
247 | } |
|
|
248 | |
|
|
249 | our $DB_ENV; |
|
|
250 | our $DB_STATE; |
|
|
251 | |
|
|
252 | sub db_table($) { |
|
|
253 | my ($table) = @_; |
|
|
254 | |
|
|
255 | $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; |
|
|
256 | |
|
|
257 | new CFPlus::Database |
|
|
258 | -Env => $DB_ENV, |
|
|
259 | -Filename => $table, |
|
|
260 | # -Filename => "database", |
|
|
261 | # -Subname => $table, |
|
|
262 | -Property => DB_CHKSUM, |
|
|
263 | -Flags => DB_CREATE | DB_UPGRADE, |
|
|
264 | or die "unable to create/open database table $_[0]: $BerkeleyDB::Error" |
|
|
265 | } |
|
|
266 | |
|
|
267 | { |
|
|
268 | use strict; |
|
|
269 | |
|
|
270 | my $HOME = "$Crossfire::VARDIR/cfplus-$BerkeleyDB::db_version"; |
|
|
271 | |
|
|
272 | mkdir $HOME, 0777; |
|
|
273 | my $recover = $BerkeleyDB::db_version >= 4.4 |
|
|
274 | ? eval "DB_REGISTER | DB_RECOVER" |
|
|
275 | : 0; |
|
|
276 | |
|
|
277 | $DB_ENV = new BerkeleyDB::Env |
|
|
278 | -Home => $HOME, |
|
|
279 | -Cachesize => 1_000_000, |
|
|
280 | -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt", |
|
|
281 | # -ErrPrefix => "DATABASE", |
|
|
282 | -Verbose => 1, |
|
|
283 | -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover, |
|
|
284 | -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE, |
|
|
285 | or die "unable to create/open database home $HOME: $BerkeleyDB::Error"; |
|
|
286 | |
|
|
287 | $DB_STATE = db_table "state"; |
|
|
288 | } |
|
|
289 | |
|
|
290 | package CFPlus::Layout; |
|
|
291 | |
|
|
292 | $CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { |
|
|
293 | reset_glyph_cache; |
|
|
294 | }; |
|
|
295 | |
|
|
296 | package CFPlus::Item; |
|
|
297 | |
|
|
298 | use strict; |
|
|
299 | use Crossfire::Protocol::Constants; |
|
|
300 | |
|
|
301 | my $last_enter_count = 1; |
|
|
302 | |
|
|
303 | sub desc_string { |
|
|
304 | my ($self) = @_; |
|
|
305 | |
|
|
306 | my $desc = |
|
|
307 | $self->{nrof} < 2 |
|
|
308 | ? $self->{name} |
|
|
309 | : "$self->{nrof} × $self->{name_pl}"; |
|
|
310 | |
|
|
311 | $self->{flags} & F_OPEN |
|
|
312 | and $desc .= " (open)"; |
|
|
313 | $self->{flags} & F_APPLIED |
|
|
314 | and $desc .= " (applied)"; |
|
|
315 | $self->{flags} & F_UNPAID |
|
|
316 | and $desc .= " (unpaid)"; |
|
|
317 | $self->{flags} & F_MAGIC |
|
|
318 | and $desc .= " (magic)"; |
|
|
319 | $self->{flags} & F_CURSED |
|
|
320 | and $desc .= " (cursed)"; |
|
|
321 | $self->{flags} & F_DAMNED |
|
|
322 | and $desc .= " (damned)"; |
|
|
323 | $self->{flags} & F_LOCKED |
|
|
324 | and $desc .= " *"; |
|
|
325 | |
|
|
326 | $desc |
|
|
327 | } |
|
|
328 | |
|
|
329 | sub weight_string { |
|
|
330 | my ($self) = @_; |
|
|
331 | |
|
|
332 | my $weight = ($self->{nrof} || 1) * $self->{weight}; |
|
|
333 | |
|
|
334 | $weight < 0 ? "?" : $weight * 0.001 |
|
|
335 | } |
|
|
336 | |
|
|
337 | sub do_n_dialog { |
|
|
338 | my ($cb) = @_; |
|
|
339 | |
|
|
340 | my $w = new CFPlus::UI::Toplevel |
|
|
341 | on_delete => sub { $_[0]->destroy; 1 }, |
|
|
342 | has_close_button => 1, |
|
|
343 | ; |
|
|
344 | |
|
|
345 | $w->add (my $vb = new CFPlus::UI::VBox x => "center", y => "center"); |
|
|
346 | $vb->add (new CFPlus::UI::Label text => "Enter item count:"); |
|
|
347 | $vb->add (my $entry = new CFPlus::UI::Entry |
|
|
348 | text => $last_enter_count, |
|
|
349 | on_activate => sub { |
|
|
350 | my ($entry) = @_; |
|
|
351 | $last_enter_count = $entry->get_text; |
|
|
352 | $cb->($last_enter_count); |
|
|
353 | $w->hide; |
|
|
354 | $w->destroy; |
|
|
355 | |
|
|
356 | 0 |
|
|
357 | }, |
|
|
358 | on_escape => sub { $w->destroy; 1 }, |
|
|
359 | ); |
|
|
360 | $entry->grab_focus; |
|
|
361 | $w->show; |
|
|
362 | } |
|
|
363 | |
|
|
364 | sub update_widgets { |
|
|
365 | my ($self) = @_; |
|
|
366 | |
|
|
367 | # necessary to avoid cyclic references |
|
|
368 | Scalar::Util::weaken $self; |
|
|
369 | |
|
|
370 | my $button_cb = sub { |
|
|
371 | my (undef, $ev, $x, $y) = @_; |
|
|
372 | |
|
|
373 | my $targ = $::CONN->{player}{tag}; |
|
|
374 | |
|
|
375 | if ($self->{container} == $::CONN->{player}{tag}) { |
|
|
376 | $targ = $::CONN->{open_container}; |
|
|
377 | } |
|
|
378 | |
|
|
379 | if (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 1) { |
|
|
380 | $::CONN->send ("move $targ $self->{tag} 0") |
|
|
381 | if $targ || !($self->{flags} & F_LOCKED); |
|
|
382 | } elsif (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 2) { |
|
|
383 | $self->{flags} & F_LOCKED |
|
|
384 | ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) |
|
|
385 | : $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) |
|
|
386 | } elsif ($ev->{button} == 1) { |
|
|
387 | $::CONN->send ("examine $self->{tag}"); |
|
|
388 | } elsif ($ev->{button} == 2) { |
|
|
389 | $::CONN->send ("apply $self->{tag}"); |
|
|
390 | } elsif ($ev->{button} == 3) { |
|
|
391 | my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop'; |
|
|
392 | if ($self->{container} == $::CONN->{open_container}) { |
|
|
393 | $move_prefix = "take"; |
|
|
394 | } |
|
|
395 | |
|
|
396 | my @menu_items = ( |
|
|
397 | ["examine", sub { $::CONN->send ("examine $self->{tag}") }], |
|
|
398 | ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }], |
|
|
399 | ["ignite/thaw", # first try of an easier use of flint&steel |
|
|
400 | sub { |
|
|
401 | $::CONN->send ("mark ". pack "N", $self->{tag}); |
|
|
402 | $::CONN->send ("command apply flint and steel"); |
|
|
403 | } |
|
|
404 | ], |
|
|
405 | ["inscribe", # first try of an easier use of flint&steel |
|
|
406 | sub { |
|
|
407 | &::open_string_query ("Text to inscribe", sub { |
|
|
408 | my ($entry, $txt) = @_; |
|
|
409 | $::CONN->send ("mark ". pack "N", $self->{tag}); |
|
|
410 | $::CONN->send ("command use_skill inscription $txt"); |
|
|
411 | }); |
|
|
412 | } |
|
|
413 | ], |
|
|
414 | ["rename", # first try of an easier use of flint&steel |
|
|
415 | sub { |
|
|
416 | &::open_string_query ("Rename item to:", sub { |
|
|
417 | my ($entry, $txt) = @_; |
|
|
418 | $::CONN->send ("mark ". pack "N", $self->{tag}); |
|
|
419 | $::CONN->send ("command rename to <$txt>"); |
|
|
420 | }, $self->{name}, |
|
|
421 | "If you input no name or erase the current custom name, the custom name will be unset"); |
|
|
422 | } |
|
|
423 | ], |
|
|
424 | ["apply", sub { $::CONN->send ("apply $self->{tag}") }], |
|
|
425 | ( |
|
|
426 | $self->{flags} & F_LOCKED |
|
|
427 | ? ( |
|
|
428 | ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }], |
|
|
429 | ) |
|
|
430 | : ( |
|
|
431 | ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }], |
|
|
432 | ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }], |
|
|
433 | ["$move_prefix <n>", |
|
|
434 | sub { |
|
|
435 | do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") }) |
|
|
436 | } |
|
|
437 | ] |
|
|
438 | ) |
|
|
439 | ), |
|
|
440 | ["bind <i>apply $self->{name}</i> to a key" => sub { $::BIND_EDITOR->do_quick_binding (["apply $self->{name}"]) }], |
|
|
441 | ); |
|
|
442 | |
|
|
443 | CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev); |
|
|
444 | } |
|
|
445 | |
|
|
446 | 1 |
|
|
447 | }; |
|
|
448 | |
|
|
449 | my $tooltip_std = "<small>" |
|
|
450 | . "Left click - examine item\n" |
|
|
451 | . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n" |
|
|
452 | . "Middle click - apply\n" |
|
|
453 | . "Shift-Middle click - lock/unlock\n" |
|
|
454 | . "Right click - further options" |
|
|
455 | . "</small>\n"; |
|
|
456 | |
|
|
457 | my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5] |
|
|
458 | : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5] |
|
|
459 | : undef; |
|
|
460 | |
|
|
461 | $self->{face_widget} ||= new CFPlus::UI::Face |
|
|
462 | can_events => 1, |
|
|
463 | can_hover => 1, |
|
|
464 | anim => $self->{anim}, |
|
|
465 | animspeed => $self->{animspeed}, # TODO# must be set at creation time |
|
|
466 | on_button_down => $button_cb, |
|
|
467 | ; |
|
|
468 | $self->{face_widget}{bg} = $bg; |
|
|
469 | $self->{face_widget}{face} = $self->{face}; |
|
|
470 | $self->{face_widget}{anim} = $self->{anim}; |
|
|
471 | $self->{face_widget}{animspeed} = $self->{animspeed}; |
|
|
472 | $self->{face_widget}->set_tooltip ( |
|
|
473 | "<b>Face/Animation.</b>\n" |
|
|
474 | . "Item uses face #$self->{face}. " |
|
|
475 | . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ") |
|
|
476 | . "\n\n$tooltip_std" |
|
|
477 | ); |
|
|
478 | |
|
|
479 | $self->{desc_widget} ||= new CFPlus::UI::Label |
|
|
480 | can_events => 1, |
|
|
481 | can_hover => 1, |
|
|
482 | ellipsise => 2, |
|
|
483 | align => -1, |
|
|
484 | on_button_down => $button_cb, |
|
|
485 | ; |
|
|
486 | my $desc = CFPlus::Item::desc_string $self; |
|
|
487 | $self->{desc_widget}{bg} = $bg; |
|
|
488 | $self->{desc_widget}->set_text ($desc); |
|
|
489 | $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std"); |
|
|
490 | |
|
|
491 | $self->{weight_widget} ||= new CFPlus::UI::Label |
|
|
492 | can_events => 1, |
|
|
493 | can_hover => 1, |
|
|
494 | ellipsise => 0, |
|
|
495 | align => 0, |
|
|
496 | on_button_down => $button_cb, |
|
|
497 | ; |
|
|
498 | $self->{weight_widget}{bg} = $bg; |
|
|
499 | $self->{weight_widget}->set_text (CFPlus::Item::weight_string $self); |
|
|
500 | $self->{weight_widget}->set_tooltip ( |
|
|
501 | "<b>Weight</b>.\n" |
|
|
502 | . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ") |
|
|
503 | . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ") |
|
|
504 | . "\n\n$tooltip_std" |
|
|
505 | ); |
22 | } |
506 | } |
23 | |
507 | |
24 | 1; |
508 | 1; |
25 | |
509 | |
26 | =back |
510 | =back |