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.107 by root, Mon Jul 24 08:23:27 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 YAML ();
32use Storable (); # finally 36use Storable (); # finally
37use Fcntl ();
38use JSON::XS qw(encode_json decode_json);
39use Guard qw(guard);
33 40
34our %STAT_TOOLTIP = ( 41# modules to support other DC::* packages
35 Str => "<b>Physical Strength</b>, determines damage dealt with weapons, how much you can carry, and how often you can attack", 42use List::Util ();
36 Dex => "<b>Dexterity</b>, your physical agility. Determines chance of being hit and affects armor class and speed", 43use IO::AIO ();
37 Con => "<b>Constitution</b>, physical health and toughness. Determines how many healthpoints you can have", 44use Coro::AIO ();
38 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 ();
39 Wis => "<b>Wisdom</b>, the ability to learn and use divine magic (prayers). Determines how many grace points you can have",
40 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",
41 Cha => "<b>Charisma</b>, how well you are received by NPCs. Affects buying and selling prices in shops.",
42 46
43 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 ();
44 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 ();
45 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.",
46 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.",
47 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.",
48 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.",
49);
50 49
51=item guard { BLOCK } 50=item shorten $string[, $maxlength]
52
53Returns an object that executes the given block as soon as it is destroyed.
54 51
55=cut 52=cut
56 53
57sub guard(&) { 54sub shorten($;$) {
58 bless \(my $cb = $_[0]), "CFClient::Guard" 55 my ($str, $len) = @_;
59} 56 substr $str, $len, (length $str), "..." if $len + 3 <= length $str;
60 57 $str
61sub CFClient::Guard::DESTROY {
62 ${$_[0]}->()
63} 58}
64 59
65sub asxml($) { 60sub asxml($) {
66 local $_ = $_[0]; 61 local $_ = $_[0];
67 62
… …
70 s/</&lt;/g; 65 s/</&lt;/g;
71 66
72 $_ 67 $_
73} 68}
74 69
75package CFClient::Database; 70sub sanitise_cfxml($) {
71 local $_ = shift;
76 72
77our @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;
78 78
79sub get($$) { 79 # now all entities
80 my $data; 80 s/&(?!amp;|lt;|gt;|apos;|quot;|#[0-9]+;|#x[0-9a-fA-F]+;)/&amp;/g;
81 81
82 $_[0]->db_get ($_[1], $data) == 0 82 # handle some elements
83 ? $data 83 s/<fg name='([^']*)'>(.*?)<\/fg>/<span foreground='$1'>$2<\/span>/gs;
84 : () 84 s/<fg name="([^"]*)">(.*?)<\/fg>/<span foreground="$1">$2<\/span>/gs;
85}
86 85
87my %DB_SYNC; 86 s/\s+$//;
88 87
89sub put($$$) { 88 $_
90 my ($db, $key, $data) = @_;
91
92 $DB_SYNC{$db} = AnyEvent->timer (after => 5, cb => sub { $db->db_sync });
93
94 $db->db_put ($key => $data)
95} 89}
96 90
97package 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}
98 170
99sub find_rcfile($) { 171sub find_rcfile($) {
100 my $path; 172 my $path;
101 173
102 for (grep !ref, @INC) { 174 for (@RC_PATH, "") {
103 $path = "$_/CFClient/resources/$_[0]"; 175 $path = "$RC_BASE/$_/$_[0]";
104 return $path if -r $path; 176 return $path if -e $path;
105 } 177 }
106 178
107 die "FATAL: can't find required file $_[0]\n"; 179 die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n";
108} 180}
109 181
110sub parse_yaml { 182sub load_json($) {
111 my $text = shift;
112
113 utf8::decode $text;
114
115 YAML::Load $text
116}
117
118sub read_cfg {
119 my ($file) = @_; 183 my ($file) = @_;
120 184
121 open my $fh, $file 185 open my $fh, $file
122 or return; 186 or return;
123 187
124 local $/; 188 local $/;
125 my $CFG = <$fh>; 189 eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) }
190}
126 191
127 if ($CFG =~ /^---/) { 192sub set_theme($) {
128 $::CFG = parse_yaml $CFG; 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
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";
129 } else { 238 } else {
130 $::CFG = eval $CFG; 239 $::CFG = { cfg_schema => 1, db_schema => 1 };
131 } 240 }
132} 241}
133 242
134sub write_cfg { 243sub save_cfg() {
135 my ($file) = @_; 244 write_cfg "$Deliantra::VARDIR/client.cf";
245}
136 246
137 $::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 );
138 291
139 open my $fh, ">:utf8", $file 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
140 or return; 318 or return;
141 print $fh YAML::Dump $::CFG;
142}
143 319
144our $DB_ENV; 320 $ENV{http_proxy} = $proxy;
145
146{
147 use strict;
148
149 mkdir "$Crossfire::VARDIR/cfplus", 0777;
150 my $recover = $BerkeleyDB::db_version >= 4.4
151 ? eval "DB_REGISTER | DB_RECOVER"
152 : 0;
153
154 $DB_ENV = new BerkeleyDB::Env
155 -Home => "$Crossfire::VARDIR/cfplus",
156 -Cachesize => 1_000_000,
157 -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt",
158# -ErrPrefix => "DATABASE",
159 -Verbose => 1,
160 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover,
161 -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE,
162 or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error";
163} 321}
164 322
165sub db_table($) { 323sub lwp_useragent {
324 require LWP::UserAgent;
325
326 DC::set_proxy;
327
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 CFClient::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
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
180package CFClient::Layout; 356package DC::Layout;
181 357
182$CFClient::OpenGL::SHUTDOWN_HOOK{"CFClient::Layout"} = sub { 358$DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub {
183 reset_glyph_cache; 359 glyph_cache_restore;
184}; 360};
185 361
186package CFClient::Item; 362$DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub {
187 363 glyph_cache_backup;
188use strict; 364};
189use Crossfire::Protocol::Constants;
190
191my $last_enter_count = 1;
192
193sub desc_string {
194 my ($self) = @_;
195
196 my $desc =
197 $self->{nrof} < 2
198 ? $self->{name}
199 : "$self->{nrof} × $self->{name_pl}";
200
201 $self->{flags} & F_OPEN
202 and $desc .= " (open)";
203 $self->{flags} & F_APPLIED
204 and $desc .= " (applied)";
205 $self->{flags} & F_UNPAID
206 and $desc .= " (unpaid)";
207 $self->{flags} & F_MAGIC
208 and $desc .= " (magic)";
209 $self->{flags} & F_CURSED
210 and $desc .= " (cursed)";
211 $self->{flags} & F_DAMNED
212 and $desc .= " (damned)";
213 $self->{flags} & F_LOCKED
214 and $desc .= " *";
215
216 $desc
217}
218
219sub weight_string {
220 my ($self) = @_;
221
222 my $weight = ($self->{nrof} || 1) * $self->{weight};
223
224 $weight < 0 ? "?" : $weight * 0.001
225}
226
227sub do_n_dialog {
228 my ($cb) = @_;
229
230 my $w = new CFClient::UI::FancyFrame
231 on_delete => sub { $_[0]->destroy; 1 },
232 has_close_button => 1,
233 ;
234
235 $w->add (my $vb = new CFClient::UI::VBox x => "center", y => "center");
236 $vb->add (new CFClient::UI::Label text => "Enter item count:");
237 $vb->add (my $entry = new CFClient::UI::Entry
238 text => $last_enter_count,
239 on_activate => sub {
240 my ($entry) = @_;
241 $last_enter_count = $entry->get_text;
242 $cb->($last_enter_count);
243 $w->hide;
244 $w->destroy;
245
246 0
247 },
248 on_escape => sub { $w->destroy; 1 },
249 );
250 $entry->grab_focus;
251 $w->show;
252}
253
254sub update_widgets {
255 my ($self) = @_;
256
257 # necessary to avoid cyclic references
258 Scalar::Util::weaken $self;
259
260 my $button_cb = sub {
261 my (undef, $ev, $x, $y) = @_;
262
263 my $targ = $::CONN->{player}{tag};
264
265 if ($self->{container} == $::CONN->{player}{tag}) {
266 $targ = $::CONN->{open_container};
267 }
268
269 if (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 1) {
270 $::CONN->send ("move $targ $self->{tag} 0")
271 if $targ || !($self->{flags} & F_LOCKED);
272 } elsif (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 2) {
273 $self->{flags} & F_LOCKED
274 ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag})
275 : $::CONN->send ("lock " . pack "CN", 1, $self->{tag})
276 } elsif ($ev->{button} == 1) {
277 $::CONN->send ("examine $self->{tag}");
278 } elsif ($ev->{button} == 2) {
279 $::CONN->send ("apply $self->{tag}");
280 } elsif ($ev->{button} == 3) {
281 my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop';
282 if ($self->{container} == $::CONN->{open_container}) {
283 $move_prefix = "take";
284 }
285
286 my @menu_items = (
287 ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
288 ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
289 ["ignite/thaw", # first try of an easier use of flint&steel
290 sub {
291 $::CONN->send ("mark ". pack "N", $self->{tag});
292 $::CONN->send ("command apply flint and steel");
293 }
294 ],
295 ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
296 (
297 $self->{flags} & F_LOCKED
298 ? (
299 ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
300 )
301 : (
302 ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
303 ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }],
304 ["$move_prefix &lt;n&gt;",
305 sub {
306 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
307 }
308 ]
309 )
310 ),
311 );
312
313 CFClient::UI::Menu->new (items => \@menu_items)->popup ($ev);
314 }
315
316 1
317 };
318
319 my $tooltip_std = "<small>"
320 . "Left click - examine item\n"
321 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
322 . "Middle click - apply\n"
323 . "Shift-Middle click - lock/unlock\n"
324 . "Right click - further options"
325 . "</small>\n";
326
327 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
328 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
329 : undef;
330
331 $self->{face_widget} ||= new CFClient::UI::Face
332 can_events => 1,
333 can_hover => 1,
334 anim => $self->{anim},
335 animspeed => $self->{animspeed}, # TODO# must be set at creation time
336 on_button_down => $button_cb,
337 ;
338 $self->{face_widget}{bg} = $bg;
339 $self->{face_widget}{face} = $self->{face};
340 $self->{face_widget}{anim} = $self->{anim};
341 $self->{face_widget}{animspeed} = $self->{animspeed};
342 $self->{face_widget}->set_tooltip (
343 "<b>Face/Animation.</b>\n"
344 . "Item uses face #$self->{face}. "
345 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
346 . "\n\n$tooltip_std"
347 );
348
349 $self->{desc_widget} ||= new CFClient::UI::Label
350 can_events => 1,
351 can_hover => 1,
352 ellipsise => 2,
353 align => -1,
354 on_button_down => $button_cb,
355 ;
356 my $desc = CFClient::Item::desc_string $self;
357 $self->{desc_widget}{bg} = $bg;
358 $self->{desc_widget}->set_text ($desc);
359 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
360
361 $self->{weight_widget} ||= new CFClient::UI::Label
362 can_events => 1,
363 can_hover => 1,
364 ellipsise => 0,
365 align => 0,
366 on_button_down => $button_cb,
367 ;
368 $self->{weight_widget}{bg} = $bg;
369 $self->{weight_widget}->set_text (CFClient::Item::weight_string $self);
370 $self->{weight_widget}->set_tooltip (
371 "<b>Weight</b>.\n"
372 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
373 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
374 . "\n\n$tooltip_std"
375 );
376}
377 365
3781; 3661;
379 367
380=back 368=back
381 369

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines