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