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.111 by root, Sun Jul 30 18:23:50 2006 UTC vs.
Revision 1.216 by root, Sat Nov 17 10:40:08 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
17use Carp ();
18
19our $VERSION;
16 20
17BEGIN { 21BEGIN {
18 $VERSION = '0.2'; 22 $VERSION = '3.0';
19 23
20 use XSLoader; 24 use XSLoader;
21 XSLoader::load "CFPlus", $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]), "CFPlus::Guard" 55 my ($str, $len) = @_;
58} 56 substr $str, $len, (length $str), "..." if $len + 3 <= length $str;
59 57 $str
60sub CFPlus::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 CFPlus::Database; 70sub background(&;&) {
71 my ($bg, $cb) = @_;
75 72
76our @ISA = BerkeleyDB::Btree::; 73 my ($fh_r, $fh_w) = AnyEvent::Util::portable_socketpair
74 or die "unable to create background socketpair: $!";
77 75
78sub get($$) { 76 my $pid = fork;
79 my $data;
80 77
81 $_[0]->db_get ($_[1], $data) == 0 78 if (defined $pid && !$pid) {
82 ? $data 79 local $SIG{__DIE__};
83 : ()
84}
85 80
86my %DB_SYNC; 81 open STDOUT, ">&", $fh_w;
82 open STDERR, ">&", $fh_w;
83 close $fh_r;
84 close $fh_w;
87 85
88sub put($$$) { 86 $| = 1;
89 my ($db, $key, $data) = @_;
90 87
91 $DB_SYNC{$db} = AnyEvent->timer (after => 5, cb => sub { $db->db_sync }); 88 eval { $bg->() };
92 89
93 $db->db_put ($key => $data) 90 if ($@) {
94} 91 my $msg = $@;
92 $msg =~ s/\n+/\n/;
93 warn "FATAL: $msg";
94 DC::_exit 1;
95 }
95 96
97 # win32 is fucked up, of course. exit will clean stuff up,
98 # which destroys our database etc. _exit will exit ALL
99 # forked processes, because of the dreaded fork emulation.
100 DC::_exit 0;
101 }
102
103 close $fh_w;
104
105 my $buffer;
106
107 my $w; $w = AnyEvent->io (fh => $fh_r, poll => 'r', cb => sub {
108 unless (sysread $fh_r, $buffer, 4096, length $buffer) {
109 undef $w;
110 $cb->();
111 return;
112 }
113
114 while ($buffer =~ s/^(.*)\n//) {
115 my $line = $1;
116 $line =~ s/\s+$//;
117 utf8::decode $line;
118 if ($line =~ /^\x{e877}json_msg (.*)$/s) {
119 $cb->(JSON::XS->new->allow_nonref->decode ($1));
120 } else {
121 ::message ({
122 markup => "background($pid): " . DC::asxml $line,
123 });
124 }
125 }
126 });
127}
128
129sub background_msg {
130 my ($msg) = @_;
131
132 $msg = "\x{e877}json_msg " . JSON::XS->new->allow_nonref->encode ($msg);
133 $msg =~ s/\n//g;
134 utf8::encode $msg;
135 print $msg, "\n";
136}
137
96package CFPlus; 138package DC;
139
140our $RC_THEME;
141our %THEME;
142our @RC_PATH;
143our $RC_BASE;
144
145for (grep !ref, @INC) {
146 $RC_BASE = "$_/Deliantra/Client/private/resources";
147 last if -d $RC_BASE;
148}
97 149
98sub find_rcfile($) { 150sub find_rcfile($) {
99 my $path; 151 my $path;
100 152
101 for (grep !ref, @INC) { 153 for (@RC_PATH, "") {
102 $path = "$_/CFPlus/resources/$_[0]"; 154 $path = "$RC_BASE/$_/$_[0]";
103 return $path if -r $path; 155 return $path if -e $path;
104 } 156 }
105 157
106 die "FATAL: can't find required file $_[0]\n"; 158 die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n";
107} 159}
108 160
109BEGIN { 161sub load_json($) {
110 use Crossfire::Protocol::Base ();
111 *to_json = \&Crossfire::Protocol::Base::to_json;
112 *from_json = \&Crossfire::Protocol::Base::from_json;
113}
114
115sub read_cfg {
116 my ($file) = @_; 162 my ($file) = @_;
117 163
118 open my $fh, $file 164 open my $fh, $file
119 or return; 165 or return;
120 166
121 local $/; 167 local $/;
122 my $CFG = <$fh>; 168 eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) }
169}
123 170
124 if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove 171sub set_theme($) {
125 require YAML; 172 return if $RC_THEME eq $_[0];
126 utf8::decode $CFG; 173 $RC_THEME = $_[0];
127 $::CFG = YAML::Load ($CFG); 174
128 } elsif ($CFG =~ /^\{/) { 175 # kind of hacky, find the main theme file, then load all theme files and merge them
129 $::CFG = from_json $CFG; 176
177 %THEME = ();
178 @RC_PATH = "theme-$RC_THEME";
179
180 my $theme = load_json find_rcfile "theme.json"
181 or die "FATAL: theme resource file not found";
182
183 @RC_PATH = @{ $theme->{path} } if $theme->{path};
184
185 for (@RC_PATH, "") {
186 my $theme = load_json "$RC_BASE/$_/theme.json"
187 or next;
188
189 %THEME = ( %$theme, %THEME );
190 }
191}
192
193sub read_cfg($) {
194 my ($file) = @_;
195
196 $::CFG = (load_json $file) || (load_json "$file.bak");
197}
198
199sub write_cfg($) {
200 my $file = "$Deliantra::VARDIR/client.cf";
201
202 $::CFG->{VERSION} = $::VERSION;
203 $::CFG->{layout} = DC::UI::get_layout ();
204
205 open my $fh, ">:utf8", "$file~"
206 or return;
207 print $fh JSON::XS->new->utf8->pretty->encode ($::CFG);
208 close $fh;
209
210 rename $file, "$file.bak";
211 rename "$file~", $file;
212}
213
214sub load_cfg() {
215 if (-e "$Deliantra::VARDIR/client.cf") {
216 DC::read_cfg "$Deliantra::VARDIR/client.cf";
130 } else { 217 } else {
131 $::CFG = eval $CFG; ## todo comaptibility cruft 218 $::CFG = { cfg_schema => 1, db_schema => 1 };
132 } 219 }
133} 220}
134 221
135sub write_cfg { 222sub save_cfg() {
136 my ($file) = @_; 223 write_cfg "$Deliantra::VARDIR/client.cf";
224}
137 225
138 $::CFG->{VERSION} = $::VERSION; 226sub upgrade_cfg() {
227 my %DEF_CFG = (
228 config_autosave => 1,
229 sdl_mode => undef,
230 fullscreen => 1,
231 fast => 0,
232 force_opengl11 => undef,
233 disable_alpha => 0,
234 smooth_movement => 1,
235 smooth_transitions => 1,
236 texture_compression => 1,
237 map_scale => 1,
238 fow_enable => 1,
239 fow_intensity => 0,
240 fow_texture => 0,
241 map_smoothing => 1,
242 gui_fontsize => 1,
243 log_fontsize => 0.7,
244 gauge_fontsize => 1,
245 gauge_size => 0.35,
246 stat_fontsize => 0.7,
247 mapsize => 100,
248 audio_enable => 1,
249 audio_hw_channels => 0,
250 audio_hw_frequency => 0,
251 audio_hw_chunksize => 0,
252 audio_mix_channels => 8,
253 effects_enable => 1,
254 effects_volume => 1,
255 bgm_enable => 1,
256 bgm_volume => 0.5,
257 output_rate => "",
258 pickup => Deliantra::Protocol::Constants::PICKUP_SPELLBOOK
259 | Deliantra::Protocol::Constants::PICKUP_SKILLSCROLL
260 | Deliantra::Protocol::Constants::PICKUP_VALUABLES,
261 inv_sort => "mtime",
262 default => "profile", # default profile
263 show_tips => 1,
264 logview_max_par => 1000,
265 shift_fire_stop => 0,
266 uitheme => "wood",
267 map_shift_x => -24, # arbitrary
268 map_shift_y => +24, # arbitrary
269 );
139 270
140 open my $fh, ">:utf8", $file 271 while (my ($k, $v) = each %DEF_CFG) {
272 $::CFG->{$k} = $v unless exists $::CFG->{$k};
273 }
274
275 if ($::CFG->{cfg_schema} < 1) {
276 for my $profile (values %{ $::CFG->{profile} }) {
277 $profile->{password} = unpack "H*", Deliantra::Util::hash_pw $profile->{password};
278 }
279 $::CFG->{cfg_schema} = 1;
280 }
281}
282
283sub http_proxy {
284 my @proxy = win32_proxy_info;
285
286 if (@proxy) {
287 "http://" . (@proxy < 2 ? "" : @proxy < 3 ? "$proxy[1]\@" : "$proxy[1]:$proxy[2]\@") . $proxy[0]
288 } elsif (exists $ENV{http_proxy}) {
289 $ENV{http_proxy}
290 } else {
291 ()
292 }
293}
294
295sub set_proxy {
296 my $proxy = http_proxy
141 or return; 297 or return;
142 print $fh to_json $::CFG;
143}
144 298
145our $DB_ENV; 299 $ENV{http_proxy} = $proxy;
146
147{
148 use strict;
149
150 mkdir "$Crossfire::VARDIR/cfplus", 0777;
151 my $recover = $BerkeleyDB::db_version >= 4.4
152 ? eval "DB_REGISTER | DB_RECOVER"
153 : 0;
154
155 $DB_ENV = new BerkeleyDB::Env
156 -Home => "$Crossfire::VARDIR/cfplus",
157 -Cachesize => 1_000_000,
158 -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt",
159# -ErrPrefix => "DATABASE",
160 -Verbose => 1,
161 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover,
162 -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE,
163 or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error";
164} 300}
165 301
166sub db_table($) { 302sub lwp_useragent {
303 require LWP::UserAgent;
304
305 DC::set_proxy;
306
307 my $ua = LWP::UserAgent->new (
308 agent => "deliantra $VERSION",
309 keep_alive => 1,
310 env_proxy => 1,
311 timeout => 30,
312 );
313}
314
315sub lwp_check($) {
167 my ($table) = @_; 316 my ($res) = @_;
168 317
169 $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; 318 $res->is_error
319 and die $res->status_line;
170 320
171 new CFPlus::Database 321 $res
172 -Env => $DB_ENV,
173 -Filename => $table,
174# -Filename => "database",
175# -Subname => $table,
176 -Property => DB_CHKSUM,
177 -Flags => DB_CREATE | DB_UPGRADE,
178 or die "unable to create/open database table $_[0]: $BerkeleyDB::Error"
179} 322}
180 323
324sub fh_nonblocking($$) {
325 my ($fh, $nb) = @_;
326
327 if ($^O eq "MSWin32") {
328 $nb = (! ! $nb) + 0;
329 ioctl $fh, 0x8004667e, \$nb; # FIONBIO
330 } else {
331 fcntl $fh, &Fcntl::F_SETFL, $nb ? &Fcntl::O_NONBLOCK : 0;
332 }
333}
334
181package CFPlus::Layout; 335package DC::Layout;
182 336
183$CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { 337$DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub {
184 reset_glyph_cache; 338 glyph_cache_restore;
185}; 339};
186 340
187package CFPlus::Item; 341$DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub {
188 342 glyph_cache_backup;
189use strict; 343};
190use Crossfire::Protocol::Constants;
191
192my $last_enter_count = 1;
193
194sub desc_string {
195 my ($self) = @_;
196
197 my $desc =
198 $self->{nrof} < 2
199 ? $self->{name}
200 : "$self->{nrof} × $self->{name_pl}";
201
202 $self->{flags} & F_OPEN
203 and $desc .= " (open)";
204 $self->{flags} & F_APPLIED
205 and $desc .= " (applied)";
206 $self->{flags} & F_UNPAID
207 and $desc .= " (unpaid)";
208 $self->{flags} & F_MAGIC
209 and $desc .= " (magic)";
210 $self->{flags} & F_CURSED
211 and $desc .= " (cursed)";
212 $self->{flags} & F_DAMNED
213 and $desc .= " (damned)";
214 $self->{flags} & F_LOCKED
215 and $desc .= " *";
216
217 $desc
218}
219
220sub weight_string {
221 my ($self) = @_;
222
223 my $weight = ($self->{nrof} || 1) * $self->{weight};
224
225 $weight < 0 ? "?" : $weight * 0.001
226}
227
228sub do_n_dialog {
229 my ($cb) = @_;
230
231 my $w = new CFPlus::UI::FancyFrame
232 on_delete => sub { $_[0]->destroy; 1 },
233 has_close_button => 1,
234 ;
235
236 $w->add (my $vb = new CFPlus::UI::VBox x => "center", y => "center");
237 $vb->add (new CFPlus::UI::Label text => "Enter item count:");
238 $vb->add (my $entry = new CFPlus::UI::Entry
239 text => $last_enter_count,
240 on_activate => sub {
241 my ($entry) = @_;
242 $last_enter_count = $entry->get_text;
243 $cb->($last_enter_count);
244 $w->hide;
245 $w->destroy;
246
247 0
248 },
249 on_escape => sub { $w->destroy; 1 },
250 );
251 $entry->grab_focus;
252 $w->show;
253}
254
255sub update_widgets {
256 my ($self) = @_;
257
258 # necessary to avoid cyclic references
259 Scalar::Util::weaken $self;
260
261 my $button_cb = sub {
262 my (undef, $ev, $x, $y) = @_;
263
264 my $targ = $::CONN->{player}{tag};
265
266 if ($self->{container} == $::CONN->{player}{tag}) {
267 $targ = $::CONN->{open_container};
268 }
269
270 if (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 1) {
271 $::CONN->send ("move $targ $self->{tag} 0")
272 if $targ || !($self->{flags} & F_LOCKED);
273 } elsif (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 2) {
274 $self->{flags} & F_LOCKED
275 ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag})
276 : $::CONN->send ("lock " . pack "CN", 1, $self->{tag})
277 } elsif ($ev->{button} == 1) {
278 $::CONN->send ("examine $self->{tag}");
279 } elsif ($ev->{button} == 2) {
280 $::CONN->send ("apply $self->{tag}");
281 } elsif ($ev->{button} == 3) {
282 my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop';
283 if ($self->{container} == $::CONN->{open_container}) {
284 $move_prefix = "take";
285 }
286
287 my @menu_items = (
288 ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
289 ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
290 ["ignite/thaw", # first try of an easier use of flint&steel
291 sub {
292 $::CONN->send ("mark ". pack "N", $self->{tag});
293 $::CONN->send ("command apply flint and steel");
294 }
295 ],
296 ["inscribe", # first try of an easier use of flint&steel
297 sub {
298 &::open_string_query ("Text to inscribe", sub {
299 my ($entry, $txt) = @_;
300 $::CONN->send ("mark ". pack "N", $self->{tag});
301 $::CONN->send ("command use_skill inscription $txt");
302 });
303 }
304 ],
305 ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
306 (
307 $self->{flags} & F_LOCKED
308 ? (
309 ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
310 )
311 : (
312 ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
313 ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }],
314 ["$move_prefix &lt;n&gt;",
315 sub {
316 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
317 }
318 ]
319 )
320 ),
321 );
322
323 CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev);
324 }
325
326 1
327 };
328
329 my $tooltip_std = "<small>"
330 . "Left click - examine item\n"
331 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
332 . "Middle click - apply\n"
333 . "Shift-Middle click - lock/unlock\n"
334 . "Right click - further options"
335 . "</small>\n";
336
337 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
338 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
339 : undef;
340
341 $self->{face_widget} ||= new CFPlus::UI::Face
342 can_events => 1,
343 can_hover => 1,
344 anim => $self->{anim},
345 animspeed => $self->{animspeed}, # TODO# must be set at creation time
346 on_button_down => $button_cb,
347 ;
348 $self->{face_widget}{bg} = $bg;
349 $self->{face_widget}{face} = $self->{face};
350 $self->{face_widget}{anim} = $self->{anim};
351 $self->{face_widget}{animspeed} = $self->{animspeed};
352 $self->{face_widget}->set_tooltip (
353 "<b>Face/Animation.</b>\n"
354 . "Item uses face #$self->{face}. "
355 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
356 . "\n\n$tooltip_std"
357 );
358
359 $self->{desc_widget} ||= new CFPlus::UI::Label
360 can_events => 1,
361 can_hover => 1,
362 ellipsise => 2,
363 align => -1,
364 on_button_down => $button_cb,
365 ;
366 my $desc = CFPlus::Item::desc_string $self;
367 $self->{desc_widget}{bg} = $bg;
368 $self->{desc_widget}->set_text ($desc);
369 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
370
371 $self->{weight_widget} ||= new CFPlus::UI::Label
372 can_events => 1,
373 can_hover => 1,
374 ellipsise => 0,
375 align => 0,
376 on_button_down => $button_cb,
377 ;
378 $self->{weight_widget}{bg} = $bg;
379 $self->{weight_widget}->set_text (CFPlus::Item::weight_string $self);
380 $self->{weight_widget}->set_tooltip (
381 "<b>Weight</b>.\n"
382 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
383 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
384 . "\n\n$tooltip_std"
385 );
386}
387 344
3881; 3451;
389 346
390=back 347=back
391 348

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines