ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/DC.pm
(Generate patch)

Comparing deliantra/Deliantra-Client/DC.pm (file contents):
Revision 1.131 by root, Tue Dec 5 00:52:56 2006 UTC vs.
Revision 1.217 by root, Wed Nov 21 13:23:10 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3CFPlus - undocumented utility garbage for our crossfire client 3DC - undocumented utility garbage for our deliantra client
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use CFPlus; 7 use DC;
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11=over 4 11=over 4
12 12
13=cut 13=cut
14 14
15package CFPlus; 15package DC;
16 16
17use Carp (); 17use Carp ();
18 18
19our $VERSION;
20
19BEGIN { 21BEGIN {
20 $VERSION = '0.97'; 22 $VERSION = '3.0';
21 23
22 use XSLoader; 24 use XSLoader;
23 XSLoader::load "CFPlus", $VERSION; 25 XSLoader::load "Deliantra::Client", $VERSION;
24} 26}
25 27
26use utf8; 28use utf8;
29use strict qw(vars subs);
27 30
31use Socket ();
28use AnyEvent (); 32use AnyEvent ();
29use BerkeleyDB; 33use AnyEvent::Util ();
30use Pod::POM (); 34use Pod::POM ();
31use Scalar::Util (); 35use File::Path ();
32use Storable (); # finally 36use Storable (); # finally
37use Fcntl ();
38use JSON::XS qw(encode_json decode_json);
39use Guard qw(guard);
33 40
34BEGIN { 41# modules to support other DC::* packages
35 use Crossfire::Protocol::Base (); 42use List::Util ();
36 *to_json = \&Crossfire::Protocol::Base::to_json; 43use IO::AIO ();
37 *from_json = \&Crossfire::Protocol::Base::from_json; 44use Coro::AIO ();
38} 45use AnyEvent::AIO ();
39 46
40=item guard { BLOCK } 47use Deliantra::Util ();
48use Deliantra::Protocol::Constants ();
41 49
42Returns an object that executes the given block as soon as it is destroyed. 50=item shorten $string[, $maxlength]
43 51
44=cut 52=cut
45 53
46sub guard(&) { 54sub shorten($;$) {
47 bless \(my $cb = $_[0]), "CFPlus::Guard" 55 my ($str, $len) = @_;
48} 56 substr $str, $len, (length $str), "..." if $len + 3 <= length $str;
49 57 $str
50sub CFPlus::Guard::DESTROY {
51 ${$_[0]}->()
52} 58}
53 59
54sub asxml($) { 60sub asxml($) {
55 local $_ = $_[0]; 61 local $_ = $_[0];
56 62
59 s/</&lt;/g; 65 s/</&lt;/g;
60 66
61 $_ 67 $_
62} 68}
63 69
64sub socketpipe() { 70sub sanitise_cfxml($) {
65 socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC 71 local $_ = shift;
66 or die "cannot establish bidiretcional pipe: $!\n";
67 72
68 ($fh1, $fh2) 73 # we now weed out all tags we do not support
74 s{ <(?! /?i> | /?u> | /?b> | /?big | /?small | /?s | /?tt | fg\ | /fg>)
75 }{
76 "&lt;"
77 }gex;
78
79 # now all entities
80 s/&(?!amp;|lt;|gt;|apos;|quot;|#[0-9]+;|#x[0-9a-fA-F]+;)/&amp;/g;
81
82 # handle some elements
83 s/<fg name='([^']*)'>(.*?)<\/fg>/<span foreground='$1'>$2<\/span>/gs;
84 s/<fg name="([^"]*)">(.*?)<\/fg>/<span foreground="$1">$2<\/span>/gs;
85
86 s/\s+$//;
87
88 $_
69} 89}
70 90
71sub background(&;&) { 91sub background(&;&) {
72 my ($bg, $cb) = @_; 92 my ($bg, $cb) = @_;
73 93
74 my ($fh_r, $fh_w) = CFPlus::socketpipe; 94 my ($fh_r, $fh_w) = AnyEvent::Util::portable_socketpair
95 or die "unable to create background socketpair: $!";
75 96
76 my $pid = fork; 97 my $pid = fork;
77 98
78 if (defined $pid && !$pid) { 99 if (defined $pid && !$pid) {
79 local $SIG{__DIE__}; 100 local $SIG{__DIE__};
89 110
90 if ($@) { 111 if ($@) {
91 my $msg = $@; 112 my $msg = $@;
92 $msg =~ s/\n+/\n/; 113 $msg =~ s/\n+/\n/;
93 warn "FATAL: $msg"; 114 warn "FATAL: $msg";
94 CFPlus::_exit 1; 115 DC::_exit 1;
95 } 116 }
96 117
97 # win32 is fucked up, of course. exit will clean stuff up, 118 # win32 is fucked up, of course. exit will clean stuff up,
98 # which destroys our database etc. _exit will exit ALL 119 # which destroys our database etc. _exit will exit ALL
99 # forked processes, because of the dreaded fork emulation. 120 # forked processes, because of the dreaded fork emulation.
100 CFPlus::_exit 0; 121 DC::_exit 0;
101 } 122 }
102 123
103 close $fh_w; 124 close $fh_w;
104 125
105 my $buffer; 126 my $buffer;
114 while ($buffer =~ s/^(.*)\n//) { 135 while ($buffer =~ s/^(.*)\n//) {
115 my $line = $1; 136 my $line = $1;
116 $line =~ s/\s+$//; 137 $line =~ s/\s+$//;
117 utf8::decode $line; 138 utf8::decode $line;
118 if ($line =~ /^\x{e877}json_msg (.*)$/s) { 139 if ($line =~ /^\x{e877}json_msg (.*)$/s) {
119 $cb->(from_json $1); 140 $cb->(JSON::XS->new->allow_nonref->decode ($1));
120 } else { 141 } else {
121 ::message ({ 142 ::message ({
122 markup => "background($pid): " . CFPlus::asxml $line, 143 markup => "background($pid): " . DC::asxml $line,
123 }); 144 });
124 } 145 }
125 } 146 }
126 }); 147 });
127} 148}
128 149
129sub background_msg { 150sub background_msg {
130 my ($msg) = @_; 151 my ($msg) = @_;
131 152
132 $msg = "\x{e877}json_msg " . to_json $msg; 153 $msg = "\x{e877}json_msg " . JSON::XS->new->allow_nonref->encode ($msg);
133 $msg =~ s/\n//g; 154 $msg =~ s/\n//g;
134 utf8::encode $msg; 155 utf8::encode $msg;
135 print $msg, "\n"; 156 print $msg, "\n";
136} 157}
137 158
138package CFPlus::Database;
139
140our @ISA = BerkeleyDB::Btree::;
141
142sub get($$) {
143 my $data;
144
145 $_[0]->db_get ($_[1], $data) == 0
146 ? $data
147 : ()
148}
149
150my %DB_SYNC;
151
152sub 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
165package CFPlus; 159package DC;
160
161our $RC_THEME;
162our %THEME;
163our @RC_PATH;
164our $RC_BASE;
165
166for (grep !ref, @INC) {
167 $RC_BASE = "$_/Deliantra/Client/private/resources";
168 last if -d $RC_BASE;
169}
166 170
167sub find_rcfile($) { 171sub find_rcfile($) {
168 my $path; 172 my $path;
169 173
170 for (grep !ref, @INC) { 174 for (@RC_PATH, "") {
171 $path = "$_/CFPlus/resources/$_[0]"; 175 $path = "$RC_BASE/$_/$_[0]";
172 return $path if -r $path; 176 return $path if -e $path;
173 } 177 }
174 178
175 die "FATAL: can't find required file $_[0]\n"; 179 die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n";
176} 180}
177 181
178sub read_cfg { 182sub load_json($) {
179 my ($file) = @_; 183 my ($file) = @_;
180 184
181 open my $fh, $file 185 open my $fh, $file
182 or return; 186 or return;
183 187
184 local $/; 188 local $/;
185 my $CFG = <$fh>; 189 eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) }
190}
186 191
187 if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove 192sub set_theme($) {
188 require YAML; 193 return if $RC_THEME eq $_[0];
189 utf8::decode $CFG; 194 $RC_THEME = $_[0];
190 $::CFG = YAML::Load ($CFG); 195
191 } elsif ($CFG =~ /^\{/) { 196 # kind of hacky, find the main theme file, then load all theme files and merge them
192 $::CFG = from_json $CFG; 197
198 %THEME = ();
199 @RC_PATH = "theme-$RC_THEME";
200
201 my $theme = load_json find_rcfile "theme.json"
202 or die "FATAL: theme resource file not found";
203
204 @RC_PATH = @{ $theme->{path} } if $theme->{path};
205
206 for (@RC_PATH, "") {
207 my $theme = load_json "$RC_BASE/$_/theme.json"
208 or next;
209
210 %THEME = ( %$theme, %THEME );
211 }
212}
213
214sub read_cfg($) {
215 my ($file) = @_;
216
217 $::CFG = (load_json $file) || (load_json "$file.bak");
218}
219
220sub write_cfg($) {
221 my $file = "$Deliantra::VARDIR/client.cf";
222
223 $::CFG->{VERSION} = $::VERSION;
224 $::CFG->{layout} = DC::UI::get_layout ();
225
226 open my $fh, ">:utf8", "$file~"
227 or return;
228 print $fh JSON::XS->new->utf8->pretty->encode ($::CFG);
229 close $fh;
230
231 rename $file, "$file.bak";
232 rename "$file~", $file;
233}
234
235sub load_cfg() {
236 if (-e "$Deliantra::VARDIR/client.cf") {
237 DC::read_cfg "$Deliantra::VARDIR/client.cf";
193 } else { 238 } else {
194 $::CFG = eval $CFG; ## todo comaptibility cruft 239 $::CFG = { cfg_schema => 1, db_schema => 1 };
195 } 240 }
196} 241}
197 242
198sub write_cfg { 243sub save_cfg() {
199 my ($file) = @_; 244 write_cfg "$Deliantra::VARDIR/client.cf";
245}
200 246
201 $::CFG->{VERSION} = $::VERSION; 247sub upgrade_cfg() {
248 my %DEF_CFG = (
249 config_autosave => 1,
250 sdl_mode => undef,
251 fullscreen => 1,
252 fast => 0,
253 force_opengl11 => undef,
254 disable_alpha => 0,
255 smooth_movement => 1,
256 smooth_transitions => 1,
257 texture_compression => 1,
258 map_scale => 1,
259 fow_enable => 1,
260 fow_intensity => 0,
261 fow_texture => 0,
262 map_smoothing => 1,
263 gui_fontsize => 1,
264 log_fontsize => 0.7,
265 gauge_fontsize => 1,
266 gauge_size => 0.35,
267 stat_fontsize => 0.7,
268 mapsize => 100,
269 audio_enable => 1,
270 audio_hw_channels => 0,
271 audio_hw_frequency => 0,
272 audio_hw_chunksize => 0,
273 audio_mix_channels => 8,
274 effects_enable => 1,
275 effects_volume => 1,
276 bgm_enable => 1,
277 bgm_volume => 0.5,
278 output_rate => "",
279 pickup => Deliantra::Protocol::Constants::PICKUP_SPELLBOOK
280 | Deliantra::Protocol::Constants::PICKUP_SKILLSCROLL
281 | Deliantra::Protocol::Constants::PICKUP_VALUABLES,
282 inv_sort => "mtime",
283 default => "profile", # default profile
284 show_tips => 1,
285 logview_max_par => 1000,
286 shift_fire_stop => 0,
287 uitheme => "wood",
288 map_shift_x => -24, # arbitrary
289 map_shift_y => +24, # arbitrary
290 );
202 291
203 open my $fh, ">:utf8", $file 292 while (my ($k, $v) = each %DEF_CFG) {
204 or return; 293 $::CFG->{$k} = $v unless exists $::CFG->{$k};
205 print $fh to_json $::CFG; 294 }
295
296 if ($::CFG->{cfg_schema} < 1) {
297 for my $profile (values %{ $::CFG->{profile} }) {
298 $profile->{password} = unpack "H*", Deliantra::Util::hash_pw $profile->{password};
299 }
300 $::CFG->{cfg_schema} = 1;
301 }
206} 302}
207 303
208sub http_proxy { 304sub http_proxy {
209 my @proxy = win32_proxy_info; 305 my @proxy = win32_proxy_info;
210 306
225} 321}
226 322
227sub lwp_useragent { 323sub lwp_useragent {
228 require LWP::UserAgent; 324 require LWP::UserAgent;
229 325
230 CFPlus::set_proxy; 326 DC::set_proxy;
231 327
232 my $ua = LWP::UserAgent->new ( 328 my $ua = LWP::UserAgent->new (
233 agent => "cfplus $VERSION", 329 agent => "deliantra $VERSION",
234 keep_alive => 1, 330 keep_alive => 1,
235 env_proxy => 1, 331 env_proxy => 1,
236 timeout => 30, 332 timeout => 30,
237 ); 333 );
238} 334}
244 and die $res->status_line; 340 and die $res->status_line;
245 341
246 $res 342 $res
247} 343}
248 344
249our $DB_ENV; 345sub fh_nonblocking($$) {
250our $DB_STATE;
251
252sub db_table($) {
253 my ($table) = @_; 346 my ($fh, $nb) = @_;
254 347
255 $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; 348 if ($^O eq "MSWin32") {
256 349 $nb = (! ! $nb) + 0;
257 new CFPlus::Database 350 ioctl $fh, 0x8004667e, \$nb; # FIONBIO
258 -Env => $DB_ENV, 351 } else {
259 -Filename => $table, 352 fcntl $fh, &Fcntl::F_SETFL, $nb ? &Fcntl::O_NONBLOCK : 0;
260# -Filename => "database", 353 }
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} 354}
266 355
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
290package CFPlus::Layout; 356package DC::Layout;
291 357
292$CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { 358$DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub {
293 reset_glyph_cache; 359 glyph_cache_restore;
294}; 360};
295 361
296package CFPlus::Item; 362$DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub {
297 363 glyph_cache_backup;
298use strict; 364};
299use Crossfire::Protocol::Constants;
300
301my $last_enter_count = 1;
302
303sub 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
329sub weight_string {
330 my ($self) = @_;
331
332 my $weight = ($self->{nrof} || 1) * $self->{weight};
333
334 $weight < 0 ? "?" : $weight * 0.001
335}
336
337sub 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
364sub 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 &lt;n&gt;",
434 sub {
435 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
436 }
437 ]
438 )
439 ),
440 );
441
442 CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev);
443 }
444
445 1
446 };
447
448 my $tooltip_std = "<small>"
449 . "Left click - examine item\n"
450 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
451 . "Middle click - apply\n"
452 . "Shift-Middle click - lock/unlock\n"
453 . "Right click - further options"
454 . "</small>\n";
455
456 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
457 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
458 : undef;
459
460 $self->{face_widget} ||= new CFPlus::UI::Face
461 can_events => 1,
462 can_hover => 1,
463 anim => $self->{anim},
464 animspeed => $self->{animspeed}, # TODO# must be set at creation time
465 on_button_down => $button_cb,
466 ;
467 $self->{face_widget}{bg} = $bg;
468 $self->{face_widget}{face} = $self->{face};
469 $self->{face_widget}{anim} = $self->{anim};
470 $self->{face_widget}{animspeed} = $self->{animspeed};
471 $self->{face_widget}->set_tooltip (
472 "<b>Face/Animation.</b>\n"
473 . "Item uses face #$self->{face}. "
474 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
475 . "\n\n$tooltip_std"
476 );
477
478 $self->{desc_widget} ||= new CFPlus::UI::Label
479 can_events => 1,
480 can_hover => 1,
481 ellipsise => 2,
482 align => -1,
483 on_button_down => $button_cb,
484 ;
485 my $desc = CFPlus::Item::desc_string $self;
486 $self->{desc_widget}{bg} = $bg;
487 $self->{desc_widget}->set_text ($desc);
488 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
489
490 $self->{weight_widget} ||= new CFPlus::UI::Label
491 can_events => 1,
492 can_hover => 1,
493 ellipsise => 0,
494 align => 0,
495 on_button_down => $button_cb,
496 ;
497 $self->{weight_widget}{bg} = $bg;
498 $self->{weight_widget}->set_text (CFPlus::Item::weight_string $self);
499 $self->{weight_widget}->set_tooltip (
500 "<b>Weight</b>.\n"
501 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
502 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
503 . "\n\n$tooltip_std"
504 );
505}
506 365
5071; 3661;
508 367
509=back 368=back
510 369

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines