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.106 by root, Mon Jul 24 04:24:42 2006 UTC vs.
Revision 1.217 by root, Wed Nov 21 13:23:10 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3CFClient - 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 CFClient; 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 CFClient; 15package DC;
16
17use Carp ();
18
19our $VERSION;
16 20
17BEGIN { 21BEGIN {
18 $VERSION = '0.1'; 22 $VERSION = '3.0';
19 23
20 use XSLoader; 24 use XSLoader;
21 XSLoader::load "CFClient", $VERSION; 25 XSLoader::load "Deliantra::Client", $VERSION;
22} 26}
23 27
24use utf8; 28use utf8;
29use strict qw(vars subs);
25 30
26use Carp (); 31use Socket ();
27use AnyEvent (); 32use AnyEvent ();
28use BerkeleyDB; 33use AnyEvent::Util ();
29use Pod::POM (); 34use Pod::POM ();
30use Scalar::Util (); 35use File::Path ();
31use Storable (); # finally 36use Storable (); # finally
37use Fcntl ();
38use JSON::XS qw(encode_json decode_json);
39use Guard qw(guard);
32 40
33our %STAT_TOOLTIP = ( 41# modules to support other DC::* packages
34 Str => "<b>Physical Strength</b>, determines damage dealt with weapons, how much you can carry, and how often you can attack", 42use List::Util ();
35 Dex => "<b>Dexterity</b>, your physical agility. Determines chance of being hit and affects armor class and speed", 43use IO::AIO ();
36 Con => "<b>Constitution</b>, physical health and toughness. Determines how many healthpoints you can have", 44use Coro::AIO ();
37 Int => "<b>Intelligence</b>, your ability to learn and use skills and incantations (both prayers and magic) and determines how much spell points you can have", 45use AnyEvent::AIO ();
38 Wis => "<b>Wisdom</b>, the ability to learn and use divine magic (prayers). Determines how many grace points you can have",
39 Pow => "<b>Power</b>, your magical potential. Influences the strength of spell effects, and also how much your spell and grace points increase when leveling up",
40 Cha => "<b>Charisma</b>, how well you are received by NPCs. Affects buying and selling prices in shops.",
41 46
42 Wc => "<b>Weapon Class</b>, effectiveness of melee/missile attacks. Lower is more potent. Current weapon, level and Str are some things which effect the value of Wc. The value of Wc may range between 25 and -72.", 47use Deliantra::Util ();
43 Ac => "<b>Armour Class</b>, how protected you are from being hit by any attack. Lower values are better. Ac is based on your race and is modified by the Dex and current armour worn. For characters that cannot wear armour, Ac improves as their level increases.", 48use Deliantra::Protocol::Constants ();
44 Dam => "<b>Damage</b>, how much damage your melee/missile attack inflicts. Higher values indicate a greater amount of damage will be inflicted with each attack.",
45 Arm => "<b>Armour</b>, how much damage (from physical attacks) will be subtracted from successful hits made upon you. This value ranges between 0 to 99%. Current armour worn primarily determines Arm value. This is the same as the physical resistance.",
46 Spd => "<b>Speed</b>, how fast you can move. The value of speed may range between nearly 0 (\"very slow\") to higher than 5 (\"lightning fast\"). Base speed is determined from the Dex and modified downward proportionally by the amount of weight carried which exceeds the Max Carry limit. The armour worn also sets the upper limit on speed.",
47 WSp => "<b>Weapon Speed</b>, how many attacks you may make per unit of time (0.120s). Higher values indicate faster attack speed. Current weapon and Dex effect the value of weapon speed.",
48);
49 49
50=item guard { BLOCK } 50=item shorten $string[, $maxlength]
51
52Returns an object that executes the given block as soon as it is destroyed.
53 51
54=cut 52=cut
55 53
56sub guard(&) { 54sub shorten($;$) {
57 bless \(my $cb = $_[0]), "CFClient::Guard" 55 my ($str, $len) = @_;
58} 56 substr $str, $len, (length $str), "..." if $len + 3 <= length $str;
59 57 $str
60sub CFClient::Guard::DESTROY {
61 ${$_[0]}->()
62} 58}
63 59
64sub asxml($) { 60sub asxml($) {
65 local $_ = $_[0]; 61 local $_ = $_[0];
66 62
69 s/</&lt;/g; 65 s/</&lt;/g;
70 66
71 $_ 67 $_
72} 68}
73 69
74package CFClient::Database; 70sub sanitise_cfxml($) {
71 local $_ = shift;
75 72
76our @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;
77 78
78sub get($$) { 79 # now all entities
79 my $data; 80 s/&(?!amp;|lt;|gt;|apos;|quot;|#[0-9]+;|#x[0-9a-fA-F]+;)/&amp;/g;
80 81
81 $_[0]->db_get ($_[1], $data) == 0 82 # handle some elements
82 ? $data 83 s/<fg name='([^']*)'>(.*?)<\/fg>/<span foreground='$1'>$2<\/span>/gs;
83 : () 84 s/<fg name="([^"]*)">(.*?)<\/fg>/<span foreground="$1">$2<\/span>/gs;
84}
85 85
86my %DB_SYNC; 86 s/\s+$//;
87 87
88sub put($$$) { 88 $_
89 my ($db, $key, $data) = @_;
90
91 $DB_SYNC{$db} = AnyEvent->timer (after => 5, cb => sub { $db->db_sync });
92
93 $db->db_put ($key => $data)
94} 89}
95 90
96package CFClient; 91sub background(&;&) {
92 my ($bg, $cb) = @_;
93
94 my ($fh_r, $fh_w) = AnyEvent::Util::portable_socketpair
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 }
147 });
148}
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
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}
97 170
98sub find_rcfile($) { 171sub find_rcfile($) {
99 my $path; 172 my $path;
100 173
101 for (grep !ref, @INC) { 174 for (@RC_PATH, "") {
102 $path = "$_/CFClient/resources/$_[0]"; 175 $path = "$RC_BASE/$_/$_[0]";
103 return $path if -r $path; 176 return $path if -e $path;
104 } 177 }
105 178
106 die "FATAL: can't find required file $_[0]\n"; 179 die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n";
107} 180}
108 181
109sub read_cfg { 182sub load_json($) {
110 my ($file) = @_; 183 my ($file) = @_;
111 184
112 open CFG, $file 185 open my $fh, $file
113 or return; 186 or return;
114 187
115 my $CFG;
116
117 local $/; 188 local $/;
118 $CFG = eval <CFG>; 189 eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) }
119
120 $::CFG = $CFG;
121
122 close CFG;
123} 190}
124 191
192sub set_theme($) {
193 return if $RC_THEME eq $_[0];
194 $RC_THEME = $_[0];
195
196 # kind of hacky, find the main theme file, then load all theme files and merge them
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
125sub write_cfg { 214sub read_cfg($) {
126 my ($file) = @_; 215 my ($file) = @_;
127 216
128 open CFG, ">$file" 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~"
129 or return; 227 or return;
228 print $fh JSON::XS->new->utf8->pretty->encode ($::CFG);
229 close $fh;
130 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";
238 } else {
239 $::CFG = { cfg_schema => 1, db_schema => 1 };
240 }
241}
242
243sub save_cfg() {
244 write_cfg "$Deliantra::VARDIR/client.cf";
245}
246
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 );
291
292 while (my ($k, $v) = each %DEF_CFG) {
293 $::CFG->{$k} = $v unless exists $::CFG->{$k};
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 }
302}
303
304sub http_proxy {
305 my @proxy = win32_proxy_info;
306
307 if (@proxy) {
308 "http://" . (@proxy < 2 ? "" : @proxy < 3 ? "$proxy[1]\@" : "$proxy[1]:$proxy[2]\@") . $proxy[0]
309 } elsif (exists $ENV{http_proxy}) {
310 $ENV{http_proxy}
311 } else {
312 ()
313 }
314}
315
316sub set_proxy {
317 my $proxy = http_proxy
318 or return;
319
320 $ENV{http_proxy} = $proxy;
321}
322
323sub lwp_useragent {
324 require LWP::UserAgent;
131 { 325
132 require Data::Dumper; 326 DC::set_proxy;
133 local $Data::Dumper::Purity = 1;
134 $::CFG->{VERSION} = $::VERSION;
135 print CFG Data::Dumper->Dump ([$::CFG], [qw/CFG/]);
136 }
137 327
138 close CFG; 328 my $ua = LWP::UserAgent->new (
329 agent => "deliantra $VERSION",
330 keep_alive => 1,
331 env_proxy => 1,
332 timeout => 30,
333 );
139} 334}
140 335
141our $DB_ENV; 336sub lwp_check($) {
142
143{
144 use strict;
145
146 mkdir "$Crossfire::VARDIR/cfplus", 0777;
147 my $recover = $BerkeleyDB::db_version >= 4.4
148 ? eval "DB_REGISTER | DB_RECOVER"
149 : 0;
150
151 $DB_ENV = new BerkeleyDB::Env
152 -Home => "$Crossfire::VARDIR/cfplus",
153 -Cachesize => 1_000_000,
154 -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt",
155# -ErrPrefix => "DATABASE",
156 -Verbose => 1,
157 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover,
158 -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE,
159 or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error";
160}
161
162sub db_table($) {
163 my ($table) = @_; 337 my ($res) = @_;
164 338
165 $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; 339 $res->is_error
340 and die $res->status_line;
166 341
167 new CFClient::Database 342 $res
168 -Env => $DB_ENV,
169 -Filename => $table,
170# -Filename => "database",
171# -Subname => $table,
172 -Property => DB_CHKSUM,
173 -Flags => DB_CREATE | DB_UPGRADE,
174 or die "unable to create/open database table $_[0]: $BerkeleyDB::Error"
175} 343}
176 344
345sub fh_nonblocking($$) {
346 my ($fh, $nb) = @_;
347
348 if ($^O eq "MSWin32") {
349 $nb = (! ! $nb) + 0;
350 ioctl $fh, 0x8004667e, \$nb; # FIONBIO
351 } else {
352 fcntl $fh, &Fcntl::F_SETFL, $nb ? &Fcntl::O_NONBLOCK : 0;
353 }
354}
355
177package CFClient::Layout; 356package DC::Layout;
178 357
179$CFClient::OpenGL::SHUTDOWN_HOOK{"CFClient::Layout"} = sub { 358$DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub {
180 reset_glyph_cache; 359 glyph_cache_restore;
181}; 360};
182 361
183package CFClient::Item; 362$DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub {
184 363 glyph_cache_backup;
185use strict; 364};
186use Crossfire::Protocol::Constants;
187
188my $last_enter_count = 1;
189
190sub desc_string {
191 my ($self) = @_;
192
193 my $desc =
194 $self->{nrof} < 2
195 ? $self->{name}
196 : "$self->{nrof} × $self->{name_pl}";
197
198 $self->{flags} & F_OPEN
199 and $desc .= " (open)";
200 $self->{flags} & F_APPLIED
201 and $desc .= " (applied)";
202 $self->{flags} & F_UNPAID
203 and $desc .= " (unpaid)";
204 $self->{flags} & F_MAGIC
205 and $desc .= " (magic)";
206 $self->{flags} & F_CURSED
207 and $desc .= " (cursed)";
208 $self->{flags} & F_DAMNED
209 and $desc .= " (damned)";
210 $self->{flags} & F_LOCKED
211 and $desc .= " *";
212
213 $desc
214}
215
216sub weight_string {
217 my ($self) = @_;
218
219 my $weight = ($self->{nrof} || 1) * $self->{weight};
220
221 $weight < 0 ? "?" : $weight * 0.001
222}
223
224sub do_n_dialog {
225 my ($cb) = @_;
226
227 my $w = new CFClient::UI::FancyFrame
228 on_delete => sub { $_[0]->destroy; 1 },
229 has_close_button => 1,
230 ;
231
232 $w->add (my $vb = new CFClient::UI::VBox x => "center", y => "center");
233 $vb->add (new CFClient::UI::Label text => "Enter item count:");
234 $vb->add (my $entry = new CFClient::UI::Entry
235 text => $last_enter_count,
236 on_activate => sub {
237 my ($entry) = @_;
238 $last_enter_count = $entry->get_text;
239 $cb->($last_enter_count);
240 $w->hide;
241 $w->destroy;
242
243 0
244 },
245 on_escape => sub { $w->destroy; 1 },
246 );
247 $entry->grab_focus;
248 $w->show;
249}
250
251sub update_widgets {
252 my ($self) = @_;
253
254 # necessary to avoid cyclic references
255 Scalar::Util::weaken $self;
256
257 my $button_cb = sub {
258 my (undef, $ev, $x, $y) = @_;
259
260 my $targ = $::CONN->{player}{tag};
261
262 if ($self->{container} == $::CONN->{player}{tag}) {
263 $targ = $::CONN->{open_container};
264 }
265
266 if (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 1) {
267 $::CONN->send ("move $targ $self->{tag} 0")
268 if $targ || !($self->{flags} & F_LOCKED);
269 } elsif (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 2) {
270 $self->{flags} & F_LOCKED
271 ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag})
272 : $::CONN->send ("lock " . pack "CN", 1, $self->{tag})
273 } elsif ($ev->{button} == 1) {
274 $::CONN->send ("examine $self->{tag}");
275 } elsif ($ev->{button} == 2) {
276 $::CONN->send ("apply $self->{tag}");
277 } elsif ($ev->{button} == 3) {
278 my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop';
279 if ($self->{container} == $::CONN->{open_container}) {
280 $move_prefix = "take";
281 }
282
283 my @menu_items = (
284 ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
285 ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
286 ["ignite/thaw", # first try of an easier use of flint&steel
287 sub {
288 $::CONN->send ("mark ". pack "N", $self->{tag});
289 $::CONN->send ("command apply flint and steel");
290 }
291 ],
292 ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
293 (
294 $self->{flags} & F_LOCKED
295 ? (
296 ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
297 )
298 : (
299 ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
300 ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }],
301 ["$move_prefix &lt;n&gt;",
302 sub {
303 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
304 }
305 ]
306 )
307 ),
308 );
309
310 CFClient::UI::Menu->new (items => \@menu_items)->popup ($ev);
311 }
312
313 1
314 };
315
316 my $tooltip_std = "<small>"
317 . "Left click - examine item\n"
318 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
319 . "Middle click - apply\n"
320 . "Shift-Middle click - lock/unlock\n"
321 . "Right click - further options"
322 . "</small>\n";
323
324 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
325 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
326 : undef;
327
328 $self->{face_widget} ||= new CFClient::UI::Face
329 can_events => 1,
330 can_hover => 1,
331 anim => $self->{anim},
332 animspeed => $self->{animspeed}, # TODO# must be set at creation time
333 on_button_down => $button_cb,
334 ;
335 $self->{face_widget}{bg} = $bg;
336 $self->{face_widget}{face} = $self->{face};
337 $self->{face_widget}{anim} = $self->{anim};
338 $self->{face_widget}{animspeed} = $self->{animspeed};
339 $self->{face_widget}->set_tooltip (
340 "<b>Face/Animation.</b>\n"
341 . "Item uses face #$self->{face}. "
342 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
343 . "\n\n$tooltip_std"
344 );
345
346 $self->{desc_widget} ||= new CFClient::UI::Label
347 can_events => 1,
348 can_hover => 1,
349 ellipsise => 2,
350 align => -1,
351 on_button_down => $button_cb,
352 ;
353 my $desc = CFClient::Item::desc_string $self;
354 $self->{desc_widget}{bg} = $bg;
355 $self->{desc_widget}->set_text ($desc);
356 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
357
358 $self->{weight_widget} ||= new CFClient::UI::Label
359 can_events => 1,
360 can_hover => 1,
361 ellipsise => 0,
362 align => 0,
363 on_button_down => $button_cb,
364 ;
365 $self->{weight_widget}{bg} = $bg;
366 $self->{weight_widget}->set_text (CFClient::Item::weight_string $self);
367 $self->{weight_widget}->set_tooltip (
368 "<b>Weight</b>.\n"
369 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
370 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
371 . "\n\n$tooltip_std"
372 );
373}
374 365
3751; 3661;
376 367
377=back 368=back
378 369

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines