1 |
=head1 NAME |
2 |
|
3 |
CFPlus - undocumented utility garbage for our crossfire client |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use CFPlus; |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
11 |
=over 4 |
12 |
|
13 |
=cut |
14 |
|
15 |
package CFPlus; |
16 |
|
17 |
use Carp (); |
18 |
|
19 |
BEGIN { |
20 |
$VERSION = '0.96'; |
21 |
|
22 |
use XSLoader; |
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 |
mkdir "$Crossfire::VARDIR/cfplus", 0777; |
271 |
my $recover = $BerkeleyDB::db_version >= 4.4 |
272 |
? eval "DB_REGISTER | DB_RECOVER" |
273 |
: 0; |
274 |
|
275 |
$DB_ENV = new BerkeleyDB::Env |
276 |
-Home => "$Crossfire::VARDIR/cfplus", |
277 |
-Cachesize => 1_000_000, |
278 |
-ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt", |
279 |
# -ErrPrefix => "DATABASE", |
280 |
-Verbose => 1, |
281 |
-Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover, |
282 |
-SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE, |
283 |
or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error"; |
284 |
|
285 |
$DB_STATE = db_table "state"; |
286 |
} |
287 |
|
288 |
package CFPlus::Layout; |
289 |
|
290 |
$CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { |
291 |
reset_glyph_cache; |
292 |
}; |
293 |
|
294 |
package CFPlus::Item; |
295 |
|
296 |
use strict; |
297 |
use Crossfire::Protocol::Constants; |
298 |
|
299 |
my $last_enter_count = 1; |
300 |
|
301 |
sub desc_string { |
302 |
my ($self) = @_; |
303 |
|
304 |
my $desc = |
305 |
$self->{nrof} < 2 |
306 |
? $self->{name} |
307 |
: "$self->{nrof} × $self->{name_pl}"; |
308 |
|
309 |
$self->{flags} & F_OPEN |
310 |
and $desc .= " (open)"; |
311 |
$self->{flags} & F_APPLIED |
312 |
and $desc .= " (applied)"; |
313 |
$self->{flags} & F_UNPAID |
314 |
and $desc .= " (unpaid)"; |
315 |
$self->{flags} & F_MAGIC |
316 |
and $desc .= " (magic)"; |
317 |
$self->{flags} & F_CURSED |
318 |
and $desc .= " (cursed)"; |
319 |
$self->{flags} & F_DAMNED |
320 |
and $desc .= " (damned)"; |
321 |
$self->{flags} & F_LOCKED |
322 |
and $desc .= " *"; |
323 |
|
324 |
$desc |
325 |
} |
326 |
|
327 |
sub weight_string { |
328 |
my ($self) = @_; |
329 |
|
330 |
my $weight = ($self->{nrof} || 1) * $self->{weight}; |
331 |
|
332 |
$weight < 0 ? "?" : $weight * 0.001 |
333 |
} |
334 |
|
335 |
sub do_n_dialog { |
336 |
my ($cb) = @_; |
337 |
|
338 |
my $w = new CFPlus::UI::Toplevel |
339 |
on_delete => sub { $_[0]->destroy; 1 }, |
340 |
has_close_button => 1, |
341 |
; |
342 |
|
343 |
$w->add (my $vb = new CFPlus::UI::VBox x => "center", y => "center"); |
344 |
$vb->add (new CFPlus::UI::Label text => "Enter item count:"); |
345 |
$vb->add (my $entry = new CFPlus::UI::Entry |
346 |
text => $last_enter_count, |
347 |
on_activate => sub { |
348 |
my ($entry) = @_; |
349 |
$last_enter_count = $entry->get_text; |
350 |
$cb->($last_enter_count); |
351 |
$w->hide; |
352 |
$w->destroy; |
353 |
|
354 |
0 |
355 |
}, |
356 |
on_escape => sub { $w->destroy; 1 }, |
357 |
); |
358 |
$entry->grab_focus; |
359 |
$w->show; |
360 |
} |
361 |
|
362 |
sub update_widgets { |
363 |
my ($self) = @_; |
364 |
|
365 |
# necessary to avoid cyclic references |
366 |
Scalar::Util::weaken $self; |
367 |
|
368 |
my $button_cb = sub { |
369 |
my (undef, $ev, $x, $y) = @_; |
370 |
|
371 |
my $targ = $::CONN->{player}{tag}; |
372 |
|
373 |
if ($self->{container} == $::CONN->{player}{tag}) { |
374 |
$targ = $::CONN->{open_container}; |
375 |
} |
376 |
|
377 |
if (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 1) { |
378 |
$::CONN->send ("move $targ $self->{tag} 0") |
379 |
if $targ || !($self->{flags} & F_LOCKED); |
380 |
} elsif (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 2) { |
381 |
$self->{flags} & F_LOCKED |
382 |
? $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) |
383 |
: $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) |
384 |
} elsif ($ev->{button} == 1) { |
385 |
$::CONN->send ("examine $self->{tag}"); |
386 |
} elsif ($ev->{button} == 2) { |
387 |
$::CONN->send ("apply $self->{tag}"); |
388 |
} elsif ($ev->{button} == 3) { |
389 |
my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop'; |
390 |
if ($self->{container} == $::CONN->{open_container}) { |
391 |
$move_prefix = "take"; |
392 |
} |
393 |
|
394 |
my @menu_items = ( |
395 |
["examine", sub { $::CONN->send ("examine $self->{tag}") }], |
396 |
["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }], |
397 |
["ignite/thaw", # first try of an easier use of flint&steel |
398 |
sub { |
399 |
$::CONN->send ("mark ". pack "N", $self->{tag}); |
400 |
$::CONN->send ("command apply flint and steel"); |
401 |
} |
402 |
], |
403 |
["inscribe", # first try of an easier use of flint&steel |
404 |
sub { |
405 |
&::open_string_query ("Text to inscribe", sub { |
406 |
my ($entry, $txt) = @_; |
407 |
$::CONN->send ("mark ". pack "N", $self->{tag}); |
408 |
$::CONN->send ("command use_skill inscription $txt"); |
409 |
}); |
410 |
} |
411 |
], |
412 |
["rename", # first try of an easier use of flint&steel |
413 |
sub { |
414 |
&::open_string_query ("Rename item to:", sub { |
415 |
my ($entry, $txt) = @_; |
416 |
$::CONN->send ("mark ". pack "N", $self->{tag}); |
417 |
$::CONN->send ("command rename to <$txt>"); |
418 |
}, $self->{name}, |
419 |
"If you input no name or erase the current custom name, the custom name will be unset"); |
420 |
} |
421 |
], |
422 |
["apply", sub { $::CONN->send ("apply $self->{tag}") }], |
423 |
( |
424 |
$self->{flags} & F_LOCKED |
425 |
? ( |
426 |
["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }], |
427 |
) |
428 |
: ( |
429 |
["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }], |
430 |
["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }], |
431 |
["$move_prefix <n>", |
432 |
sub { |
433 |
do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") }) |
434 |
} |
435 |
] |
436 |
) |
437 |
), |
438 |
); |
439 |
|
440 |
CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev); |
441 |
} |
442 |
|
443 |
1 |
444 |
}; |
445 |
|
446 |
my $tooltip_std = "<small>" |
447 |
. "Left click - examine item\n" |
448 |
. "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n" |
449 |
. "Middle click - apply\n" |
450 |
. "Shift-Middle click - lock/unlock\n" |
451 |
. "Right click - further options" |
452 |
. "</small>\n"; |
453 |
|
454 |
my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5] |
455 |
: $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5] |
456 |
: undef; |
457 |
|
458 |
$self->{face_widget} ||= new CFPlus::UI::Face |
459 |
can_events => 1, |
460 |
can_hover => 1, |
461 |
anim => $self->{anim}, |
462 |
animspeed => $self->{animspeed}, # TODO# must be set at creation time |
463 |
on_button_down => $button_cb, |
464 |
; |
465 |
$self->{face_widget}{bg} = $bg; |
466 |
$self->{face_widget}{face} = $self->{face}; |
467 |
$self->{face_widget}{anim} = $self->{anim}; |
468 |
$self->{face_widget}{animspeed} = $self->{animspeed}; |
469 |
$self->{face_widget}->set_tooltip ( |
470 |
"<b>Face/Animation.</b>\n" |
471 |
. "Item uses face #$self->{face}. " |
472 |
. ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ") |
473 |
. "\n\n$tooltip_std" |
474 |
); |
475 |
|
476 |
$self->{desc_widget} ||= new CFPlus::UI::Label |
477 |
can_events => 1, |
478 |
can_hover => 1, |
479 |
ellipsise => 2, |
480 |
align => -1, |
481 |
on_button_down => $button_cb, |
482 |
; |
483 |
my $desc = CFPlus::Item::desc_string $self; |
484 |
$self->{desc_widget}{bg} = $bg; |
485 |
$self->{desc_widget}->set_text ($desc); |
486 |
$self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std"); |
487 |
|
488 |
$self->{weight_widget} ||= new CFPlus::UI::Label |
489 |
can_events => 1, |
490 |
can_hover => 1, |
491 |
ellipsise => 0, |
492 |
align => 0, |
493 |
on_button_down => $button_cb, |
494 |
; |
495 |
$self->{weight_widget}{bg} = $bg; |
496 |
$self->{weight_widget}->set_text (CFPlus::Item::weight_string $self); |
497 |
$self->{weight_widget}->set_tooltip ( |
498 |
"<b>Weight</b>.\n" |
499 |
. ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ") |
500 |
. ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ") |
501 |
. "\n\n$tooltip_std" |
502 |
); |
503 |
} |
504 |
|
505 |
1; |
506 |
|
507 |
=back |
508 |
|
509 |
=head1 AUTHOR |
510 |
|
511 |
Marc Lehmann <schmorp@schmorp.de> |
512 |
http://home.schmorp.de/ |
513 |
|
514 |
=cut |
515 |
|