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.122 by root, Sun Oct 1 14:48:50 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.52'; 22 $VERSION = '3.0';
21 23
22 use XSLoader; 24 use XSLoader;
23 XSLoader::load "CFPlus", $VERSION; 25 XSLoader::load "Deliantra::Client", $VERSION;
24}
25
26BEGIN {
27 $SIG{__DIE__} = sub {
28 return if CFPlus::in_destruct;
29 #CFPlus::fatal $_[0];#d#
30 CFPlus::error Carp::longmess $_[0];#d#
31 die;#d#
32 };
33} 26}
34 27
35use utf8; 28use utf8;
29use strict qw(vars subs);
36 30
31use Socket ();
37use AnyEvent (); 32use AnyEvent ();
38use BerkeleyDB; 33use AnyEvent::Util ();
39use Pod::POM (); 34use Pod::POM ();
40use Scalar::Util (); 35use File::Path ();
41use Storable (); # finally 36use Storable (); # finally
37use Fcntl ();
38use JSON::XS qw(encode_json decode_json);
39use Guard qw(guard);
42 40
43=item guard { BLOCK } 41# modules to support other DC::* packages
42use List::Util ();
43use IO::AIO ();
44use Coro::AIO ();
45use AnyEvent::AIO ();
44 46
45Returns an object that executes the given block as soon as it is destroyed. 47use Deliantra::Util ();
48use Deliantra::Protocol::Constants ();
49
50=item shorten $string[, $maxlength]
46 51
47=cut 52=cut
48 53
49sub guard(&) { 54sub shorten($;$) {
50 bless \(my $cb = $_[0]), "CFPlus::Guard" 55 my ($str, $len) = @_;
51} 56 substr $str, $len, (length $str), "..." if $len + 3 <= length $str;
52 57 $str
53sub CFPlus::Guard::DESTROY {
54 ${$_[0]}->()
55} 58}
56 59
57sub asxml($) { 60sub asxml($) {
58 local $_ = $_[0]; 61 local $_ = $_[0];
59 62
62 s/</&lt;/g; 65 s/</&lt;/g;
63 66
64 $_ 67 $_
65} 68}
66 69
67package CFPlus::Database; 70sub sanitise_cfxml($) {
71 local $_ = shift;
68 72
69our @ISA = BerkeleyDB::Btree::; 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;
70 78
71sub get($$) { 79 # now all entities
72 my $data; 80 s/&(?!amp;|lt;|gt;|apos;|quot;|#[0-9]+;|#x[0-9a-fA-F]+;)/&amp;/g;
73 81
74 $_[0]->db_get ($_[1], $data) == 0 82 # handle some elements
75 ? $data 83 s/<fg name='([^']*)'>(.*?)<\/fg>/<span foreground='$1'>$2<\/span>/gs;
76 : () 84 s/<fg name="([^"]*)">(.*?)<\/fg>/<span foreground="$1">$2<\/span>/gs;
77}
78 85
79my %DB_SYNC; 86 s/\s+$//;
80 87
81sub put($$$) { 88 $_
82 my ($db, $key, $data) = @_; 89}
83 90
84 my $hkey = $db + 0; 91sub background(&;&) {
85 Scalar::Util::weaken $db; 92 my ($bg, $cb) = @_;
86 $DB_SYNC{$hkey} ||= AnyEvent->timer (after => 5, cb => sub { 93
87 delete $DB_SYNC{$hkey}; 94 my ($fh_r, $fh_w) = AnyEvent::Util::portable_socketpair
88 $db->db_sync if $db; 95 or die "unable to create background socketpair: $!";
96
97 my $pid = fork;
98
99 if (defined $pid && !$pid) {
100 local $SIG{__DIE__};
101
102 open STDOUT, ">&", $fh_w;
103 open STDERR, ">&", $fh_w;
104 close $fh_r;
105 close $fh_w;
106
107 $| = 1;
108
109 eval { $bg->() };
110
111 if ($@) {
112 my $msg = $@;
113 $msg =~ s/\n+/\n/;
114 warn "FATAL: $msg";
115 DC::_exit 1;
116 }
117
118 # win32 is fucked up, of course. exit will clean stuff up,
119 # which destroys our database etc. _exit will exit ALL
120 # forked processes, because of the dreaded fork emulation.
121 DC::_exit 0;
122 }
123
124 close $fh_w;
125
126 my $buffer;
127
128 my $w; $w = AnyEvent->io (fh => $fh_r, poll => 'r', cb => sub {
129 unless (sysread $fh_r, $buffer, 4096, length $buffer) {
130 undef $w;
131 $cb->();
132 return;
133 }
134
135 while ($buffer =~ s/^(.*)\n//) {
136 my $line = $1;
137 $line =~ s/\s+$//;
138 utf8::decode $line;
139 if ($line =~ /^\x{e877}json_msg (.*)$/s) {
140 $cb->(JSON::XS->new->allow_nonref->decode ($1));
141 } else {
142 ::message ({
143 markup => "background($pid): " . DC::asxml $line,
144 });
145 }
146 }
89 }); 147 });
90
91 $db->db_put ($key => $data)
92} 148}
93 149
150sub background_msg {
151 my ($msg) = @_;
152
153 $msg = "\x{e877}json_msg " . JSON::XS->new->allow_nonref->encode ($msg);
154 $msg =~ s/\n//g;
155 utf8::encode $msg;
156 print $msg, "\n";
157}
158
94package 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}
95 170
96sub find_rcfile($) { 171sub find_rcfile($) {
97 my $path; 172 my $path;
98 173
99 for (grep !ref, @INC) { 174 for (@RC_PATH, "") {
100 $path = "$_/CFPlus/resources/$_[0]"; 175 $path = "$RC_BASE/$_/$_[0]";
101 return $path if -r $path; 176 return $path if -e $path;
102 } 177 }
103 178
104 die "FATAL: can't find required file $_[0]\n"; 179 die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n";
105} 180}
106 181
107BEGIN { 182sub load_json($) {
108 use Crossfire::Protocol::Base ();
109 *to_json = \&Crossfire::Protocol::Base::to_json;
110 *from_json = \&Crossfire::Protocol::Base::from_json;
111}
112
113sub read_cfg {
114 my ($file) = @_; 183 my ($file) = @_;
115 184
116 open my $fh, $file 185 open my $fh, $file
117 or return; 186 or return;
118 187
119 local $/; 188 local $/;
120 my $CFG = <$fh>; 189 eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) }
190}
121 191
122 if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove 192sub set_theme($) {
123 require YAML; 193 return if $RC_THEME eq $_[0];
124 utf8::decode $CFG; 194 $RC_THEME = $_[0];
125 $::CFG = YAML::Load ($CFG); 195
126 } elsif ($CFG =~ /^\{/) { 196 # kind of hacky, find the main theme file, then load all theme files and merge them
127 $::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";
128 } else { 238 } else {
129 $::CFG = eval $CFG; ## todo comaptibility cruft 239 $::CFG = { cfg_schema => 1, db_schema => 1 };
130 } 240 }
131} 241}
132 242
133sub write_cfg { 243sub save_cfg() {
134 my ($file) = @_; 244 write_cfg "$Deliantra::VARDIR/client.cf";
245}
135 246
136 $::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 );
137 291
138 open my $fh, ">:utf8", $file 292 while (my ($k, $v) = each %DEF_CFG) {
139 or return; 293 $::CFG->{$k} = $v unless exists $::CFG->{$k};
140 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 }
141} 302}
142 303
143sub http_proxy { 304sub http_proxy {
144 my @proxy = win32_proxy_info; 305 my @proxy = win32_proxy_info;
145 306
157 or return; 318 or return;
158 319
159 $ENV{http_proxy} = $proxy; 320 $ENV{http_proxy} = $proxy;
160} 321}
161 322
162our $DB_ENV; 323sub lwp_useragent {
163our $DB_STATE; 324 require LWP::UserAgent;
325
326 DC::set_proxy;
164 327
165sub db_table($) { 328 my $ua = LWP::UserAgent->new (
329 agent => "deliantra $VERSION",
330 keep_alive => 1,
331 env_proxy => 1,
332 timeout => 30,
333 );
334}
335
336sub lwp_check($) {
166 my ($table) = @_; 337 my ($res) = @_;
167 338
168 $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; 339 $res->is_error
340 and die $res->status_line;
169 341
170 new CFPlus::Database 342 $res
171 -Env => $DB_ENV,
172 -Filename => $table,
173# -Filename => "database",
174# -Subname => $table,
175 -Property => DB_CHKSUM,
176 -Flags => DB_CREATE | DB_UPGRADE,
177 or die "unable to create/open database table $_[0]: $BerkeleyDB::Error"
178} 343}
179 344
180{ 345sub fh_nonblocking($$) {
181 use strict; 346 my ($fh, $nb) = @_;
182 347
183 mkdir "$Crossfire::VARDIR/cfplus", 0777; 348 if ($^O eq "MSWin32") {
184 my $recover = $BerkeleyDB::db_version >= 4.4 349 $nb = (! ! $nb) + 0;
185 ? eval "DB_REGISTER | DB_RECOVER" 350 ioctl $fh, 0x8004667e, \$nb; # FIONBIO
186 : 0; 351 } else {
187 352 fcntl $fh, &Fcntl::F_SETFL, $nb ? &Fcntl::O_NONBLOCK : 0;
188 $DB_ENV = new BerkeleyDB::Env 353 }
189 -Home => "$Crossfire::VARDIR/cfplus",
190 -Cachesize => 1_000_000,
191 -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt",
192# -ErrPrefix => "DATABASE",
193 -Verbose => 1,
194 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover,
195 -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE,
196 or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error";
197
198 $DB_STATE = db_table "state";
199} 354}
200 355
201package CFPlus::Layout; 356package DC::Layout;
202 357
203$CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { 358$DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub {
204 reset_glyph_cache; 359 glyph_cache_restore;
205}; 360};
206 361
207package CFPlus::Item; 362$DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub {
208 363 glyph_cache_backup;
209use strict; 364};
210use Crossfire::Protocol::Constants;
211
212my $last_enter_count = 1;
213
214sub desc_string {
215 my ($self) = @_;
216
217 my $desc =
218 $self->{nrof} < 2
219 ? $self->{name}
220 : "$self->{nrof} × $self->{name_pl}";
221
222 $self->{flags} & F_OPEN
223 and $desc .= " (open)";
224 $self->{flags} & F_APPLIED
225 and $desc .= " (applied)";
226 $self->{flags} & F_UNPAID
227 and $desc .= " (unpaid)";
228 $self->{flags} & F_MAGIC
229 and $desc .= " (magic)";
230 $self->{flags} & F_CURSED
231 and $desc .= " (cursed)";
232 $self->{flags} & F_DAMNED
233 and $desc .= " (damned)";
234 $self->{flags} & F_LOCKED
235 and $desc .= " *";
236
237 $desc
238}
239
240sub weight_string {
241 my ($self) = @_;
242
243 my $weight = ($self->{nrof} || 1) * $self->{weight};
244
245 $weight < 0 ? "?" : $weight * 0.001
246}
247
248sub do_n_dialog {
249 my ($cb) = @_;
250
251 my $w = new CFPlus::UI::Toplevel
252 on_delete => sub { $_[0]->destroy; 1 },
253 has_close_button => 1,
254 ;
255
256 $w->add (my $vb = new CFPlus::UI::VBox x => "center", y => "center");
257 $vb->add (new CFPlus::UI::Label text => "Enter item count:");
258 $vb->add (my $entry = new CFPlus::UI::Entry
259 text => $last_enter_count,
260 on_activate => sub {
261 my ($entry) = @_;
262 $last_enter_count = $entry->get_text;
263 $cb->($last_enter_count);
264 $w->hide;
265 $w->destroy;
266
267 0
268 },
269 on_escape => sub { $w->destroy; 1 },
270 );
271 $entry->grab_focus;
272 $w->show;
273}
274
275sub update_widgets {
276 my ($self) = @_;
277
278 # necessary to avoid cyclic references
279 Scalar::Util::weaken $self;
280
281 my $button_cb = sub {
282 my (undef, $ev, $x, $y) = @_;
283
284 my $targ = $::CONN->{player}{tag};
285
286 if ($self->{container} == $::CONN->{player}{tag}) {
287 $targ = $::CONN->{open_container};
288 }
289
290 if (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 1) {
291 $::CONN->send ("move $targ $self->{tag} 0")
292 if $targ || !($self->{flags} & F_LOCKED);
293 } elsif (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 2) {
294 $self->{flags} & F_LOCKED
295 ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag})
296 : $::CONN->send ("lock " . pack "CN", 1, $self->{tag})
297 } elsif ($ev->{button} == 1) {
298 $::CONN->send ("examine $self->{tag}");
299 } elsif ($ev->{button} == 2) {
300 $::CONN->send ("apply $self->{tag}");
301 } elsif ($ev->{button} == 3) {
302 my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop';
303 if ($self->{container} == $::CONN->{open_container}) {
304 $move_prefix = "take";
305 }
306
307 my @menu_items = (
308 ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
309 ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
310 ["ignite/thaw", # first try of an easier use of flint&steel
311 sub {
312 $::CONN->send ("mark ". pack "N", $self->{tag});
313 $::CONN->send ("command apply flint and steel");
314 }
315 ],
316 ["inscribe", # first try of an easier use of flint&steel
317 sub {
318 &::open_string_query ("Text to inscribe", sub {
319 my ($entry, $txt) = @_;
320 $::CONN->send ("mark ". pack "N", $self->{tag});
321 $::CONN->send ("command use_skill inscription $txt");
322 });
323 }
324 ],
325 ["rename", # first try of an easier use of flint&steel
326 sub {
327 &::open_string_query ("Rename item to:", sub {
328 my ($entry, $txt) = @_;
329 $::CONN->send ("mark ". pack "N", $self->{tag});
330 $::CONN->send ("command rename to <$txt>");
331 }, $self->{name},
332 "If you input no name or erase the current custom name, the custom name will be unset");
333 }
334 ],
335 ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
336 (
337 $self->{flags} & F_LOCKED
338 ? (
339 ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
340 )
341 : (
342 ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
343 ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }],
344 ["$move_prefix &lt;n&gt;",
345 sub {
346 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
347 }
348 ]
349 )
350 ),
351 );
352
353 CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev);
354 }
355
356 1
357 };
358
359 my $tooltip_std = "<small>"
360 . "Left click - examine item\n"
361 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
362 . "Middle click - apply\n"
363 . "Shift-Middle click - lock/unlock\n"
364 . "Right click - further options"
365 . "</small>\n";
366
367 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
368 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
369 : undef;
370
371 $self->{face_widget} ||= new CFPlus::UI::Face
372 can_events => 1,
373 can_hover => 1,
374 anim => $self->{anim},
375 animspeed => $self->{animspeed}, # TODO# must be set at creation time
376 on_button_down => $button_cb,
377 ;
378 $self->{face_widget}{bg} = $bg;
379 $self->{face_widget}{face} = $self->{face};
380 $self->{face_widget}{anim} = $self->{anim};
381 $self->{face_widget}{animspeed} = $self->{animspeed};
382 $self->{face_widget}->set_tooltip (
383 "<b>Face/Animation.</b>\n"
384 . "Item uses face #$self->{face}. "
385 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
386 . "\n\n$tooltip_std"
387 );
388
389 $self->{desc_widget} ||= new CFPlus::UI::Label
390 can_events => 1,
391 can_hover => 1,
392 ellipsise => 2,
393 align => -1,
394 on_button_down => $button_cb,
395 ;
396 my $desc = CFPlus::Item::desc_string $self;
397 $self->{desc_widget}{bg} = $bg;
398 $self->{desc_widget}->set_text ($desc);
399 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
400
401 $self->{weight_widget} ||= new CFPlus::UI::Label
402 can_events => 1,
403 can_hover => 1,
404 ellipsise => 0,
405 align => 0,
406 on_button_down => $button_cb,
407 ;
408 $self->{weight_widget}{bg} = $bg;
409 $self->{weight_widget}->set_text (CFPlus::Item::weight_string $self);
410 $self->{weight_widget}->set_tooltip (
411 "<b>Weight</b>.\n"
412 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
413 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
414 . "\n\n$tooltip_std"
415 );
416}
417 365
4181; 3661;
419 367
420=back 368=back
421 369

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines