| 1 | =head1 NAME |
1 | =head1 NAME |
| 2 | |
2 | |
| 3 | CFPlus - undocumented utility garbage for our crossfire client |
3 | DC - 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 | |
| 15 | package CFPlus; |
15 | package DC; |
| 16 | |
16 | |
| 17 | use Carp (); |
17 | use Carp (); |
| 18 | |
18 | |
|
|
19 | our $VERSION; |
|
|
20 | |
| 19 | BEGIN { |
21 | BEGIN { |
| 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 | |
| 26 | use utf8; |
28 | use utf8; |
|
|
29 | use strict qw(vars subs); |
| 27 | |
30 | |
|
|
31 | use Socket (); |
| 28 | use AnyEvent (); |
32 | use AnyEvent (); |
| 29 | use BerkeleyDB; |
33 | use AnyEvent::Util (); |
| 30 | use Pod::POM (); |
34 | use Pod::POM (); |
| 31 | use Scalar::Util (); |
|
|
| 32 | use File::Path (); |
35 | use File::Path (); |
| 33 | use Storable (); # finally |
36 | use Storable (); # finally |
|
|
37 | use Fcntl (); |
|
|
38 | use JSON::XS qw(encode_json decode_json); |
|
|
39 | use Guard qw(guard); |
| 34 | |
40 | |
| 35 | BEGIN { |
41 | # modules to support other DC::* packages |
| 36 | use Crossfire::Protocol::Base (); |
42 | use List::Util (); |
| 37 | *to_json = \&Crossfire::Protocol::Base::to_json; |
43 | use IO::AIO (); |
| 38 | *from_json = \&Crossfire::Protocol::Base::from_json; |
44 | use Coro::AIO (); |
| 39 | } |
45 | use AnyEvent::AIO (); |
| 40 | |
46 | |
| 41 | =item guard { BLOCK } |
47 | use Deliantra::Util (); |
| 42 | |
48 | use Deliantra::Protocol::Constants (); |
| 43 | Returns an object that executes the given block as soon as it is destroyed. |
|
|
| 44 | |
|
|
| 45 | =cut |
|
|
| 46 | |
|
|
| 47 | sub guard(&) { |
|
|
| 48 | bless \(my $cb = $_[0]), "CFPlus::Guard" |
|
|
| 49 | } |
|
|
| 50 | |
|
|
| 51 | sub CFPlus::Guard::DESTROY { |
|
|
| 52 | ${$_[0]}->() |
|
|
| 53 | } |
|
|
| 54 | |
49 | |
| 55 | =item shorten $string[, $maxlength] |
50 | =item shorten $string[, $maxlength] |
| 56 | |
51 | |
| 57 | =cut |
52 | =cut |
| 58 | |
53 | |
| … | |
… | |
| 70 | s/</</g; |
65 | s/</</g; |
| 71 | |
66 | |
| 72 | $_ |
67 | $_ |
| 73 | } |
68 | } |
| 74 | |
69 | |
| 75 | sub socketpipe() { |
70 | sub sanitise_cfxml($) { |
| 76 | socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC |
71 | local $_ = shift; |
| 77 | or die "cannot establish bidiretcional pipe: $!\n"; |
|
|
| 78 | |
72 | |
| 79 | ($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 | "<" |
|
|
77 | }gex; |
|
|
78 | |
|
|
79 | # now all entities |
|
|
80 | s/&(?!amp;|lt;|gt;|apos;|quot;|#[0-9]+;|#x[0-9a-fA-F]+;)/&/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 | $_ |
| 80 | } |
89 | } |
| 81 | |
90 | |
| 82 | sub background(&;&) { |
91 | sub background(&;&) { |
| 83 | my ($bg, $cb) = @_; |
92 | my ($bg, $cb) = @_; |
| 84 | |
93 | |
| 85 | 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: $!"; |
| 86 | |
96 | |
| 87 | my $pid = fork; |
97 | my $pid = fork; |
| 88 | |
98 | |
| 89 | if (defined $pid && !$pid) { |
99 | if (defined $pid && !$pid) { |
| 90 | local $SIG{__DIE__}; |
100 | local $SIG{__DIE__}; |
| … | |
… | |
| 100 | |
110 | |
| 101 | if ($@) { |
111 | if ($@) { |
| 102 | my $msg = $@; |
112 | my $msg = $@; |
| 103 | $msg =~ s/\n+/\n/; |
113 | $msg =~ s/\n+/\n/; |
| 104 | warn "FATAL: $msg"; |
114 | warn "FATAL: $msg"; |
| 105 | CFPlus::_exit 1; |
115 | DC::_exit 1; |
| 106 | } |
116 | } |
| 107 | |
117 | |
| 108 | # win32 is fucked up, of course. exit will clean stuff up, |
118 | # win32 is fucked up, of course. exit will clean stuff up, |
| 109 | # which destroys our database etc. _exit will exit ALL |
119 | # which destroys our database etc. _exit will exit ALL |
| 110 | # forked processes, because of the dreaded fork emulation. |
120 | # forked processes, because of the dreaded fork emulation. |
| 111 | CFPlus::_exit 0; |
121 | DC::_exit 0; |
| 112 | } |
122 | } |
| 113 | |
123 | |
| 114 | close $fh_w; |
124 | close $fh_w; |
| 115 | |
125 | |
| 116 | my $buffer; |
126 | my $buffer; |
| … | |
… | |
| 125 | while ($buffer =~ s/^(.*)\n//) { |
135 | while ($buffer =~ s/^(.*)\n//) { |
| 126 | my $line = $1; |
136 | my $line = $1; |
| 127 | $line =~ s/\s+$//; |
137 | $line =~ s/\s+$//; |
| 128 | utf8::decode $line; |
138 | utf8::decode $line; |
| 129 | if ($line =~ /^\x{e877}json_msg (.*)$/s) { |
139 | if ($line =~ /^\x{e877}json_msg (.*)$/s) { |
| 130 | $cb->(from_json $1); |
140 | $cb->(JSON::XS->new->allow_nonref->decode ($1)); |
| 131 | } else { |
141 | } else { |
| 132 | ::message ({ |
142 | ::message ({ |
| 133 | markup => "background($pid): " . CFPlus::asxml $line, |
143 | markup => "background($pid): " . DC::asxml $line, |
| 134 | }); |
144 | }); |
| 135 | } |
145 | } |
| 136 | } |
146 | } |
| 137 | }); |
147 | }); |
| 138 | } |
148 | } |
| 139 | |
149 | |
| 140 | sub background_msg { |
150 | sub background_msg { |
| 141 | my ($msg) = @_; |
151 | my ($msg) = @_; |
| 142 | |
152 | |
| 143 | $msg = "\x{e877}json_msg " . to_json $msg; |
153 | $msg = "\x{e877}json_msg " . JSON::XS->new->allow_nonref->encode ($msg); |
| 144 | $msg =~ s/\n//g; |
154 | $msg =~ s/\n//g; |
| 145 | utf8::encode $msg; |
155 | utf8::encode $msg; |
| 146 | print $msg, "\n"; |
156 | print $msg, "\n"; |
| 147 | } |
157 | } |
| 148 | |
158 | |
| 149 | package CFPlus::Database; |
|
|
| 150 | |
|
|
| 151 | our @ISA = BerkeleyDB::Btree::; |
|
|
| 152 | |
|
|
| 153 | sub get($$) { |
|
|
| 154 | my $data; |
|
|
| 155 | |
|
|
| 156 | $_[0]->db_get ($_[1], $data) == 0 |
|
|
| 157 | ? $data |
|
|
| 158 | : () |
|
|
| 159 | } |
|
|
| 160 | |
|
|
| 161 | my %DB_SYNC; |
|
|
| 162 | |
|
|
| 163 | sub put($$$) { |
|
|
| 164 | my ($db, $key, $data) = @_; |
|
|
| 165 | |
|
|
| 166 | my $hkey = $db + 0; |
|
|
| 167 | Scalar::Util::weaken $db; |
|
|
| 168 | $DB_SYNC{$hkey} ||= AnyEvent->timer (after => 5, cb => sub { |
|
|
| 169 | delete $DB_SYNC{$hkey}; |
|
|
| 170 | $db->db_sync if $db; |
|
|
| 171 | }); |
|
|
| 172 | |
|
|
| 173 | $db->db_put ($key => $data) |
|
|
| 174 | } |
|
|
| 175 | |
|
|
| 176 | package CFPlus; |
159 | package DC; |
|
|
160 | |
|
|
161 | our $RC_THEME; |
|
|
162 | our %THEME; |
|
|
163 | our @RC_PATH; |
|
|
164 | our $RC_BASE; |
|
|
165 | |
|
|
166 | for (grep !ref, @INC) { |
|
|
167 | $RC_BASE = "$_/Deliantra/Client/private/resources"; |
|
|
168 | last if -d $RC_BASE; |
|
|
169 | } |
| 177 | |
170 | |
| 178 | sub find_rcfile($) { |
171 | sub find_rcfile($) { |
| 179 | my $path; |
172 | my $path; |
| 180 | |
173 | |
| 181 | for (grep !ref, @INC) { |
174 | for (@RC_PATH, "") { |
| 182 | $path = "$_/CFPlus/resources/$_[0]"; |
175 | $path = "$RC_BASE/$_/$_[0]"; |
| 183 | return $path if -r $path; |
176 | return $path if -e $path; |
| 184 | } |
177 | } |
| 185 | |
178 | |
| 186 | die "FATAL: can't find required file $_[0]\n"; |
179 | die "FATAL: can't find required file \"$_[0]\" in \"$RC_BASE\"\n"; |
| 187 | } |
180 | } |
| 188 | |
181 | |
| 189 | sub read_cfg { |
182 | sub load_json($) { |
| 190 | my ($file) = @_; |
183 | my ($file) = @_; |
| 191 | |
184 | |
| 192 | open my $fh, $file |
185 | open my $fh, $file |
| 193 | or return; |
186 | or return; |
| 194 | |
187 | |
| 195 | local $/; |
188 | local $/; |
| 196 | my $CFG = <$fh>; |
189 | eval { JSON::XS->new->utf8->relaxed->decode (<$fh>) } |
|
|
190 | } |
| 197 | |
191 | |
| 198 | if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove |
192 | sub set_theme($) { |
| 199 | require YAML; |
193 | return if $RC_THEME eq $_[0]; |
| 200 | utf8::decode $CFG; |
194 | $RC_THEME = $_[0]; |
| 201 | $::CFG = YAML::Load ($CFG); |
195 | |
| 202 | } elsif ($CFG =~ /^\{/) { |
196 | # kind of hacky, find the main theme file, then load all theme files and merge them |
| 203 | $::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 | |
|
|
214 | sub read_cfg($) { |
|
|
215 | my ($file) = @_; |
|
|
216 | |
|
|
217 | $::CFG = (load_json $file) || (load_json "$file.bak"); |
|
|
218 | } |
|
|
219 | |
|
|
220 | sub 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 | |
|
|
235 | sub load_cfg() { |
|
|
236 | if (-e "$Deliantra::VARDIR/client.cf") { |
|
|
237 | DC::read_cfg "$Deliantra::VARDIR/client.cf"; |
| 204 | } else { |
238 | } else { |
| 205 | $::CFG = eval $CFG; ## todo comaptibility cruft |
239 | $::CFG = { cfg_schema => 1, db_schema => 1 }; |
| 206 | } |
240 | } |
| 207 | } |
241 | } |
| 208 | |
242 | |
| 209 | sub write_cfg { |
243 | sub save_cfg() { |
| 210 | my ($file) = @_; |
244 | write_cfg "$Deliantra::VARDIR/client.cf"; |
|
|
245 | } |
| 211 | |
246 | |
| 212 | $::CFG->{VERSION} = $::VERSION; |
247 | sub 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 | ); |
| 213 | |
291 | |
| 214 | open my $fh, ">:utf8", $file |
292 | while (my ($k, $v) = each %DEF_CFG) { |
| 215 | or return; |
293 | $::CFG->{$k} = $v unless exists $::CFG->{$k}; |
| 216 | 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 | } |
| 217 | } |
302 | } |
| 218 | |
303 | |
| 219 | sub http_proxy { |
304 | sub http_proxy { |
| 220 | my @proxy = win32_proxy_info; |
305 | my @proxy = win32_proxy_info; |
| 221 | |
306 | |
| … | |
… | |
| 236 | } |
321 | } |
| 237 | |
322 | |
| 238 | sub lwp_useragent { |
323 | sub lwp_useragent { |
| 239 | require LWP::UserAgent; |
324 | require LWP::UserAgent; |
| 240 | |
325 | |
| 241 | CFPlus::set_proxy; |
326 | DC::set_proxy; |
| 242 | |
327 | |
| 243 | my $ua = LWP::UserAgent->new ( |
328 | my $ua = LWP::UserAgent->new ( |
| 244 | agent => "cfplus $VERSION", |
329 | agent => "deliantra $VERSION", |
| 245 | keep_alive => 1, |
330 | keep_alive => 1, |
| 246 | env_proxy => 1, |
331 | env_proxy => 1, |
| 247 | timeout => 30, |
332 | timeout => 30, |
| 248 | ); |
333 | ); |
| 249 | } |
334 | } |
| … | |
… | |
| 255 | and die $res->status_line; |
340 | and die $res->status_line; |
| 256 | |
341 | |
| 257 | $res |
342 | $res |
| 258 | } |
343 | } |
| 259 | |
344 | |
| 260 | our $DB_ENV; |
345 | sub fh_nonblocking($$) { |
| 261 | our $DB_STATE; |
|
|
| 262 | |
|
|
| 263 | sub db_table($) { |
|
|
| 264 | my ($table) = @_; |
346 | my ($fh, $nb) = @_; |
| 265 | |
347 | |
| 266 | $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; |
348 | if ($^O eq "MSWin32") { |
| 267 | |
349 | $nb = (! ! $nb) + 0; |
| 268 | new CFPlus::Database |
350 | ioctl $fh, 0x8004667e, \$nb; # FIONBIO |
| 269 | -Env => $DB_ENV, |
351 | } else { |
| 270 | -Filename => $table, |
352 | fcntl $fh, &Fcntl::F_SETFL, $nb ? &Fcntl::O_NONBLOCK : 0; |
| 271 | # -Filename => "database", |
|
|
| 272 | # -Subname => $table, |
|
|
| 273 | -Property => DB_CHKSUM, |
|
|
| 274 | -Flags => DB_CREATE | DB_UPGRADE, |
|
|
| 275 | or die "unable to create/open database table $_[0]: $BerkeleyDB::Error" |
|
|
| 276 | } |
|
|
| 277 | |
|
|
| 278 | our $DB_HOME = "$Crossfire::VARDIR/cfplus"; |
|
|
| 279 | |
|
|
| 280 | sub open_db { |
|
|
| 281 | use strict; |
|
|
| 282 | |
|
|
| 283 | mkdir $DB_HOME, 0777; |
|
|
| 284 | my $recover = $BerkeleyDB::db_version >= 4.4 |
|
|
| 285 | ? eval "DB_REGISTER | DB_RECOVER" |
|
|
| 286 | : 0; |
|
|
| 287 | |
|
|
| 288 | $DB_ENV = new BerkeleyDB::Env |
|
|
| 289 | -Home => $DB_HOME, |
|
|
| 290 | -Cachesize => 1_000_000, |
|
|
| 291 | -ErrFile => "$DB_HOME/errorlog.txt", |
|
|
| 292 | # -ErrPrefix => "DATABASE", |
|
|
| 293 | -Verbose => 1, |
|
|
| 294 | -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover, |
|
|
| 295 | -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE, |
|
|
| 296 | or die "unable to create/open database home $DB_HOME: $BerkeleyDB::Error"; |
|
|
| 297 | |
|
|
| 298 | $DB_STATE = db_table "state"; |
|
|
| 299 | |
|
|
| 300 | 1 |
353 | } |
| 301 | } |
354 | } |
| 302 | |
355 | |
| 303 | unless (eval { open_db }) { |
|
|
| 304 | File::Path::rmtree $DB_HOME; |
|
|
| 305 | open_db; |
|
|
| 306 | } |
|
|
| 307 | |
|
|
| 308 | package CFPlus::Layout; |
356 | package DC::Layout; |
| 309 | |
357 | |
|
|
358 | $DC::OpenGL::INIT_HOOK{"DC::Layout"} = sub { |
|
|
359 | glyph_cache_restore; |
|
|
360 | }; |
|
|
361 | |
| 310 | $CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub { |
362 | $DC::OpenGL::SHUTDOWN_HOOK{"DC::Layout"} = sub { |
| 311 | reset_glyph_cache; |
363 | glyph_cache_backup; |
| 312 | }; |
364 | }; |
| 313 | |
365 | |
| 314 | 1; |
366 | 1; |
| 315 | |
367 | |
| 316 | =back |
368 | =back |
