ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.132 by root, Thu Jan 4 01:35:56 2007 UTC vs.
Revision 1.273 by root, Mon Jun 4 12:19:08 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use BDB ();
26use Data::Dumper;
20use Digest::MD5; 27use Digest::MD5;
21use Fcntl; 28use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
24use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
25 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
27 41
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
30 44
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 46
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 48
35our %COMMAND = (); 49our %COMMAND = ();
36our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
38 56
57our $RELOAD; # number of reloads so far
39our @EVENT; 58our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 59
42our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 76our $NEXT_TICK;
45our $NOW; 77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
46 82
47our %CFG; 83our %CFG;
48 84
49our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 86our $RUNTIME;
51 87
88our %PLAYER; # all users
52our %MAP; # all maps 89our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 90our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE; 91
55our $RANDOM_MAPS = cf::localdir . "/random"; 92# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
57 98
58binmode STDOUT; 99binmode STDOUT;
59binmode STDERR; 100binmode STDERR;
60 101
61# read virtual server time, if available 102# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
66} 107}
67 108
68mkdir cf::localdir; 109mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 111
74# a special map that is always available
75our $LINK_MAP;
76our $EMERGENCY_POSITION; 112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
77 115
78############################################################################# 116#############################################################################
79 117
80=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
81 119
88=item $cf::RUNTIME 126=item $cf::RUNTIME
89 127
90The time this server has run, starts at 0 and is increased by $cf::TICK on 128The time this server has run, starts at 0 and is increased by $cf::TICK on
91every server tick. 129every server tick.
92 130
93=item $cf::LIBDIR 131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
94 134
95The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
96be found. It will be added to C<@INC> automatically. 136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
97 139
98=item $cf::NOW 140=item $cf::NOW
99 141
100The time of the last (current) server tick. 142The time of the last (current) server tick.
101 143
102=item $cf::TICK 144=item $cf::TICK
103 145
104The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
105 157
106=item %cf::CFG 158=item %cf::CFG
107 159
108Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
109from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
110 168
111=back 169=back
112 170
113=cut 171=cut
114 172
115BEGIN { 173BEGIN {
116 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
117 my $msg = join "", @_; 175 my $msg = join "", @_;
118 utf8::encode $msg;
119 176
120 $msg .= "\n" 177 $msg .= "\n"
121 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
122 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
123 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
124 }; 184 };
125} 185}
126 186
127@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
132@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
133 194
134# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
135# within the Safe compartment. 196# within the Safe compartment.
136for my $pkg (qw( 197for my $pkg (qw(
137 cf::global cf::attachable 198 cf::global cf::attachable
146 207
147$Event::DIED = sub { 208$Event::DIED = sub {
148 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
149}; 210};
150 211
151my %ext_pkg;
152my @exts;
153my @hook;
154
155=head2 UTILITY FUNCTIONS 212=head2 UTILITY FUNCTIONS
156 213
157=over 4 214=over 4
158 215
159=cut 216=item dumpval $ref
160 217
218=cut
219
220sub dumpval {
221 eval {
222 local $SIG{__DIE__};
223 my $d;
224 if (1) {
225 $d = new Data::Dumper([$_[0]], ["*var"]);
226 $d->Terse(1);
227 $d->Indent(2);
228 $d->Quotekeys(0);
229 $d->Useqq(1);
230 #$d->Bless(...);
231 $d->Seen($_[1]) if @_ > 1;
232 $d = $d->Dump();
233 }
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d
236 } || "[unable to dump $_[0]: '$@']";
237}
238
161use JSON::Syck (); # TODO# replace by JSON::PC once working 239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
162 240
163=item $ref = cf::from_json $json 241=item $ref = cf::from_json $json
164 242
165Converts a JSON string into the corresponding perl data structure. 243Converts a JSON string into the corresponding perl data structure.
166 244
167=cut
168
169sub from_json($) {
170 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171 JSON::Syck::Load $_[0]
172}
173
174=item $json = cf::to_json $ref 245=item $json = cf::to_json $ref
175 246
176Converts a perl data structure into its JSON representation. 247Converts a perl data structure into its JSON representation.
177 248
178=cut
179
180sub to_json($) {
181 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
182 JSON::Syck::Dump $_[0]
183}
184
185=item my $guard = cf::guard { BLOCK }
186
187Run the given callback when the guard object gets destroyed (useful for
188coroutine cancellations).
189
190You can call C<< ->cancel >> on the guard object to stop the block from
191being executed.
192
193=cut
194
195sub guard(&) {
196 bless \(my $cb = $_[0]), cf::guard::;
197}
198
199sub cf::guard::cancel {
200 ${$_[0]} = sub { };
201}
202
203sub cf::guard::DESTROY {
204 ${$_[0]}->();
205}
206
207=item cf::lock_wait $string 249=item cf::lock_wait $string
208 250
209Wait until the given lock is available. See cf::lock_acquire. 251Wait until the given lock is available. See cf::lock_acquire.
210 252
211=item my $lock = cf::lock_acquire $string 253=item my $lock = cf::lock_acquire $string
212 254
213Wait until the given lock is available and then acquires it and returns 255Wait until the given lock is available and then acquires it and returns
214a guard object. If the guard object gets destroyed (goes out of scope, 256a Coro::guard object. If the guard object gets destroyed (goes out of scope,
215for example when the coroutine gets canceled), the lock is automatically 257for example when the coroutine gets canceled), the lock is automatically
216returned. 258returned.
217 259
218Lock names should begin with a unique identifier (for example, find_map 260Lock names should begin with a unique identifier (for example, cf::map::find
219uses map_find and load_map uses map_load). 261uses map_find and cf::map::load uses map_load).
262
263=item $locked = cf::lock_active $string
264
265Return true if the lock is currently active, i.e. somebody has locked it.
220 266
221=cut 267=cut
222 268
223our %LOCK; 269our %LOCK;
224 270
238 # wait, to be sure we are not locked 284 # wait, to be sure we are not locked
239 lock_wait $key; 285 lock_wait $key;
240 286
241 $LOCK{$key} = []; 287 $LOCK{$key} = [];
242 288
243 cf::guard { 289 Coro::guard {
244 # wake up all waiters, to be on the safe side 290 # wake up all waiters, to be on the safe side
245 $_->ready for @{ delete $LOCK{$key} }; 291 $_->ready for @{ delete $LOCK{$key} };
246 } 292 }
247} 293}
248 294
295sub lock_active($) {
296 my ($key) = @_;
297
298 ! ! $LOCK{$key}
299}
300
301sub freeze_mainloop {
302 return unless $TICK_WATCHER->is_active;
303
304 my $guard = Coro::guard {
305 $TICK_WATCHER->start;
306 };
307 $TICK_WATCHER->stop;
308 $guard
309}
310
249=item cf::async { BLOCK } 311=item cf::async { BLOCK }
250 312
251Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the 313Currently the same as Coro::async_pool, meaning you cannot use
252error instead of exiting the server in case of a problem. 314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it.
253 316
254=cut 317=cut
255 318
256sub async(&) { 319BEGIN { *async = \&Coro::async_pool }
257 my ($cb) = @_;
258
259 Coro::async {
260 eval { $cb->() };
261 warn $@ if $@;
262 }
263}
264 320
265=item cf::sync_job { BLOCK } 321=item cf::sync_job { BLOCK }
266 322
267The design of crossfire+ requires that the main coro ($Coro::main) is 323The design of crossfire+ requires that the main coro ($Coro::main) is
268always able to handle events or runnable, as crossfire+ is only partly 324always able to handle events or runnable, as crossfire+ is only partly
277 333
278sub sync_job(&) { 334sub sync_job(&) {
279 my ($job) = @_; 335 my ($job) = @_;
280 336
281 if ($Coro::current == $Coro::main) { 337 if ($Coro::current == $Coro::main) {
338 my $time = Event::time;
339
282 # this is the main coro, too bad, we have to block 340 # this is the main coro, too bad, we have to block
283 # till the operation succeeds, freezing the server :/ 341 # till the operation succeeds, freezing the server :/
284 342
285 # TODO: use suspend/resume instead 343 # TODO: use suspend/resume instead
286 # (but this is cancel-safe) 344 # (but this is cancel-safe)
287 local $FREEZE = 1; 345 my $freeze_guard = freeze_mainloop;
288 346
289 my $busy = 1; 347 my $busy = 1;
290 my @res; 348 my @res;
291 349
292 (Coro::async { 350 (async {
293 @res = eval { $job->() }; 351 @res = eval { $job->() };
294 warn $@ if $@; 352 warn $@ if $@;
295 undef $busy; 353 undef $busy;
296 })->prio (Coro::PRIO_MAX); 354 })->prio (Coro::PRIO_MAX);
297 355
298 while ($busy) { 356 while ($busy) {
299 Coro::cede_notself; 357 Coro::cede or Event::one_event;
300 Event::one_event unless Coro::nready;
301 } 358 }
359
360 $time = Event::time - $time;
361
362 LOG llevError | logBacktrace, Carp::longmess "long sync job"
363 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
364
365 $tick_start += $time; # do not account sync jobs to server load
302 366
303 wantarray ? @res : $res[0] 367 wantarray ? @res : $res[0]
304 } else { 368 } else {
305 # we are in another coroutine, how wonderful, everything just works 369 # we are in another coroutine, how wonderful, everything just works
306 370
307 $job->() 371 $job->()
308 } 372 }
309} 373}
310 374
311=item $coro = cf::coro { BLOCK } 375=item $coro = cf::async_ext { BLOCK }
312 376
313Creates and returns a new coro. This coro is automcatially being canceled 377Like async, but this coro is automatically being canceled when the
314when the extension calling this is being unloaded. 378extension calling this is being unloaded.
315 379
316=cut 380=cut
317 381
318sub coro(&) { 382sub async_ext(&) {
319 my $cb = shift; 383 my $cb = shift;
320 384
321 my $coro = &cf::async ($cb); 385 my $coro = &Coro::async ($cb);
322 386
323 $coro->on_destroy (sub { 387 $coro->on_destroy (sub {
324 delete $EXT_CORO{$coro+0}; 388 delete $EXT_CORO{$coro+0};
325 }); 389 });
326 $EXT_CORO{$coro+0} = $coro; 390 $EXT_CORO{$coro+0} = $coro;
327 391
328 $coro 392 $coro
329} 393}
330 394
331sub write_runtime { 395sub write_runtime {
332 my $runtime = cf::localdir . "/runtime"; 396 my $runtime = "$LOCALDIR/runtime";
397
398 # first touch the runtime file to show we are still running:
399 # the fsync below can take a very very long time.
400
401 IO::AIO::aio_utime $runtime, undef, undef;
402
403 my $guard = cf::lock_acquire "write_runtime";
333 404
334 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
335 or return; 406 or return;
336 407
408 my $value = $cf::RUNTIME + 90 + 10;
337 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
338 (aio_write $fh, 0, (length $value), $value, 0) <= 0 412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
339 and return; 413 and return;
340 414
415 # always fsync - this file is important
341 aio_fsync $fh 416 aio_fsync $fh
342 and return; 417 and return;
343 418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
344 close $fh 422 close $fh
345 or return; 423 or return;
346 424
347 aio_rename "$runtime~", $runtime 425 aio_rename "$runtime~", $runtime
348 and return; 426 and return;
349 427
428 warn "runtime file written.\n";#d#
429
350 1 430 1
351} 431}
352 432
433=item cf::datalog type => key => value, ...
434
435Log a datalog packet of the given type with the given key-value pairs.
436
437=cut
438
439sub datalog($@) {
440 my ($type, %kv) = @_;
441 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
442}
443
353=back 444=back
354 445
355=cut 446=cut
356
357#############################################################################
358
359package cf::path;
360
361sub new {
362 my ($class, $path, $base) = @_;
363
364 $path = $path->as_string if ref $path;
365
366 my $self = bless { }, $class;
367
368 # {... are special paths that are not touched
369 # ?xxx/... are special absolute paths
370 # ?random/... random maps
371 # /! non-realised random map exit
372 # /... normal maps
373 # ~/... per-player maps without a specific player (DO NOT USE)
374 # ~user/... per-player map of a specific user
375
376 if ($path =~ /^{/) {
377 # fine as it is
378 } elsif ($path =~ s{^\?random/}{}) {
379 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
380 $self->{random} = cf::from_json $data;
381 } else {
382 if ($path =~ s{^~([^/]+)?}{}) {
383 $self->{user_rel} = 1;
384
385 if (defined $1) {
386 $self->{user} = $1;
387 } elsif ($base =~ m{^~([^/]+)/}) {
388 $self->{user} = $1;
389 } else {
390 warn "cannot resolve user-relative path without user <$path,$base>\n";
391 }
392 } elsif ($path =~ /^\//) {
393 # already absolute
394 } else {
395 $base =~ s{[^/]+/?$}{};
396 return $class->new ("$base/$path");
397 }
398
399 for ($path) {
400 redo if s{/\.?/}{/};
401 redo if s{/[^/]+/\.\./}{/};
402 }
403 }
404
405 $self->{path} = $path;
406
407 $self
408}
409
410# the name / primary key / in-game path
411sub as_string {
412 my ($self) = @_;
413
414 $self->{user_rel} ? "~$self->{user}$self->{path}"
415 : $self->{random} ? "?random/$self->{path}"
416 : $self->{path}
417}
418
419# the displayed name, this is a one way mapping
420sub visible_name {
421 my ($self) = @_;
422
423# if (my $rmp = $self->{random}) {
424# # todo: be more intelligent about this
425# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
426# } else {
427 $self->as_string
428# }
429}
430
431# escape the /'s in the path
432sub _escaped_path {
433 # ∕ is U+2215
434 (my $path = $_[0]{path}) =~ s/\//∕/g;
435 $path
436}
437
438# the original (read-only) location
439sub load_path {
440 my ($self) = @_;
441
442 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
443}
444
445# the temporary/swap location
446sub save_path {
447 my ($self) = @_;
448
449 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
450 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
451 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
452}
453
454# the unique path, might be eq to save_path
455sub uniq_path {
456 my ($self) = @_;
457
458 $self->{user_rel} || $self->{random}
459 ? undef
460 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
461}
462
463# return random map parameters, or undef
464sub random_map_params {
465 my ($self) = @_;
466
467 $self->{random}
468}
469
470# this is somewhat ugly, but style maps do need special treatment
471sub is_style_map {
472 $_[0]{path} =~ m{^/styles/}
473}
474
475package cf;
476 447
477############################################################################# 448#############################################################################
478 449
479=head2 ATTACHABLE OBJECTS 450=head2 ATTACHABLE OBJECTS
480 451
606our @CB_TYPE = (); # registry for type (cf-object class) based events 577our @CB_TYPE = (); # registry for type (cf-object class) based events
607our @CB_MAP = (); 578our @CB_MAP = ();
608 579
609my %attachment; 580my %attachment;
610 581
582sub cf::attachable::thawer_merge {
583 # simply override everything except _meta
584 local $_[0]{_meta};
585 %{$_[0]} = %{$_[1]};
586}
587
611sub _attach_cb($$$$) { 588sub _attach_cb($$$$) {
612 my ($registry, $event, $prio, $cb) = @_; 589 my ($registry, $event, $prio, $cb) = @_;
613 590
614 use sort 'stable'; 591 use sort 'stable';
615 592
649 $registry = $CB_TYPE[$object_type] ||= []; 626 $registry = $CB_TYPE[$object_type] ||= [];
650 627
651 } elsif ($type eq "subtype") { 628 } elsif ($type eq "subtype") {
652 defined $object_type or Carp::croak "subtype specified without type"; 629 defined $object_type or Carp::croak "subtype specified without type";
653 my $object_subtype = shift @arg; 630 my $object_subtype = shift @arg;
654 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 631 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
655 632
656 } elsif ($type eq "package") { 633 } elsif ($type eq "package") {
657 my $pkg = shift @arg; 634 my $pkg = shift @arg;
658 635
659 while (my ($name, $id) = each %cb_id) { 636 while (my ($name, $id) = each %cb_id) {
700 if (ref $_[0]) { 677 if (ref $_[0]) {
701 _object_attach @_; 678 _object_attach @_;
702 } else { 679 } else {
703 _attach shift->_attach_registry, @_; 680 _attach shift->_attach_registry, @_;
704 } 681 }
682 _recalc_want;
705}; 683};
706 684
707# all those should be optimised 685# all those should be optimised
708sub cf::attachable::detach { 686sub cf::attachable::detach {
709 my ($obj, $name) = @_; 687 my ($obj, $name) = @_;
712 delete $obj->{_attachment}{$name}; 690 delete $obj->{_attachment}{$name};
713 reattach ($obj); 691 reattach ($obj);
714 } else { 692 } else {
715 Carp::croak "cannot, currently, detach class attachments"; 693 Carp::croak "cannot, currently, detach class attachments";
716 } 694 }
695 _recalc_want;
717}; 696};
718 697
719sub cf::attachable::attached { 698sub cf::attachable::attached {
720 my ($obj, $name) = @_; 699 my ($obj, $name) = @_;
721 700
786# object support 765# object support
787 766
788sub reattach { 767sub reattach {
789 # basically do the same as instantiate, without calling instantiate 768 # basically do the same as instantiate, without calling instantiate
790 my ($obj) = @_; 769 my ($obj) = @_;
770
771 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
791 772
792 my $registry = $obj->registry; 773 my $registry = $obj->registry;
793 774
794 @$registry = (); 775 @$registry = ();
795 776
842 $filename, length $$rdata, scalar @$objs; 823 $filename, length $$rdata, scalar @$objs;
843 824
844 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
845 chmod SAVE_MODE, $fh; 826 chmod SAVE_MODE, $fh;
846 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 827 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
847 aio_fsync $fh; 828 aio_fsync $fh if $cf::USE_FSYNC;
848 close $fh; 829 close $fh;
849 830
850 if (@$objs) { 831 if (@$objs) {
851 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 832 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
852 chmod SAVE_MODE, $fh; 833 chmod SAVE_MODE, $fh;
853 my $data = Storable::nfreeze { version => 1, objs => $objs }; 834 my $data = Storable::nfreeze { version => 1, objs => $objs };
854 aio_write $fh, 0, (length $data), $data, 0; 835 aio_write $fh, 0, (length $data), $data, 0;
855 aio_fsync $fh; 836 aio_fsync $fh if $cf::USE_FSYNC;
856 close $fh; 837 close $fh;
857 aio_rename "$filename.pst~", "$filename.pst"; 838 aio_rename "$filename.pst~", "$filename.pst";
858 } 839 }
859 } else { 840 } else {
860 aio_unlink "$filename.pst"; 841 aio_unlink "$filename.pst";
927=cut 908=cut
928 909
929sub register_extcmd { 910sub register_extcmd {
930 my ($name, $cb) = @_; 911 my ($name, $cb) = @_;
931 912
932 my $caller = caller;
933 #warn "registering extcmd '$name' to '$caller'";
934
935 $EXTCMD{$name} = [$cb, $caller]; 913 $EXTCMD{$name} = $cb;
936} 914}
937 915
938cf::player->attach ( 916cf::player->attach (
939 on_command => sub { 917 on_command => sub {
940 my ($pl, $name, $params) = @_; 918 my ($pl, $name, $params) = @_;
953 931
954 my $msg = eval { from_json $buf }; 932 my $msg = eval { from_json $buf };
955 933
956 if (ref $msg) { 934 if (ref $msg) {
957 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 935 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
958 if (my %reply = $cb->[0]->($pl, $msg)) { 936 if (my %reply = $cb->($pl, $msg)) {
959 $pl->ext_reply ($msg->{msgid}, %reply); 937 $pl->ext_reply ($msg->{msgid}, %reply);
960 } 938 }
961 } 939 }
962 } else { 940 } else {
963 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
965 943
966 cf::override; 944 cf::override;
967 }, 945 },
968); 946);
969 947
970sub register {
971 my ($base, $pkg) = @_;
972
973 #TODO
974}
975
976sub load_extension { 948sub load_extension {
977 my ($path) = @_; 949 my ($path) = @_;
978 950
979 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
980 my $base = $1; 952 my $base = $1;
981 my $pkg = $1; 953 my $pkg = $1;
982 $pkg =~ s/[^[:word:]]/_/g; 954 $pkg =~ s/[^[:word:]]/_/g;
983 $pkg = "ext::$pkg"; 955 $pkg = "ext::$pkg";
984 956
985 warn "loading '$path' into '$pkg'\n"; 957 warn "... loading '$path' into '$pkg'\n";
986 958
987 open my $fh, "<:utf8", $path 959 open my $fh, "<:utf8", $path
988 or die "$path: $!"; 960 or die "$path: $!";
989 961
990 my $source = 962 my $source =
991 "package $pkg; use strict; use utf8;\n" 963 "package $pkg; use strict; use utf8;\n"
992 . "#line 1 \"$path\"\n{\n" 964 . "#line 1 \"$path\"\n{\n"
993 . (do { local $/; <$fh> }) 965 . (do { local $/; <$fh> })
994 . "\n};\n1"; 966 . "\n};\n1";
995 967
996 eval $source 968 unless (eval $source) {
997 or die $@ ? "$path: $@\n" 969 my $msg = $@ ? "$path: $@\n"
998 : "extension disabled.\n"; 970 : "extension disabled.\n";
999 971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
1000 push @exts, $pkg; 972 warn $@;
1001 $ext_pkg{$base} = $pkg; 973 warn "mandatory extension failed to load, exiting.\n";
1002 974 exit 1;
1003# no strict 'refs'; 975 }
1004# @{"$pkg\::ISA"} = ext::; 976 die $@;
1005
1006 register $base, $pkg;
1007}
1008
1009sub unload_extension {
1010 my ($pkg) = @_;
1011
1012 warn "removing extension $pkg\n";
1013
1014 # remove hooks
1015 #TODO
1016# for my $idx (0 .. $#PLUGIN_EVENT) {
1017# delete $hook[$idx]{$pkg};
1018# } 977 }
1019 978
1020 # remove commands 979 push @EXTS, $pkg;
1021 for my $name (keys %COMMAND) {
1022 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1023
1024 if (@cb) {
1025 $COMMAND{$name} = \@cb;
1026 } else {
1027 delete $COMMAND{$name};
1028 }
1029 }
1030
1031 # remove extcmds
1032 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1033 delete $EXTCMD{$name};
1034 }
1035
1036 if (my $cb = $pkg->can ("unload")) {
1037 eval {
1038 $cb->($pkg);
1039 1
1040 } or warn "$pkg unloaded, but with errors: $@";
1041 }
1042
1043 Symbol::delete_package $pkg;
1044} 980}
1045 981
1046sub load_extensions { 982sub load_extensions {
1047 for my $ext (<$LIBDIR/*.ext>) { 983 for my $ext (<$LIBDIR/*.ext>) {
1048 next unless -r $ext; 984 next unless -r $ext;
1052 } or warn "$ext not loaded: $@"; 988 } or warn "$ext not loaded: $@";
1053 } 989 }
1054} 990}
1055 991
1056############################################################################# 992#############################################################################
1057# load/save/clean perl data associated with a map
1058
1059*cf::mapsupport::on_clean = sub {
1060 my ($map) = @_;
1061
1062 my $path = $map->tmpname;
1063 defined $path or return;
1064
1065 unlink "$path.pst";
1066};
1067
1068cf::map->attach (prio => -10000, package => cf::mapsupport::);
1069
1070#############################################################################
1071# load/save perl data associated with player->ob objects
1072
1073sub all_objects(@) {
1074 @_, map all_objects ($_->inv), @_
1075}
1076
1077# TODO: compatibility cruft, remove when no longer needed
1078cf::player->attach (
1079 on_load => sub {
1080 my ($pl, $path) = @_;
1081
1082 for my $o (all_objects $pl->ob) {
1083 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1084 $o->set_ob_key_value ("_perl_data");
1085
1086 %$o = %{ Storable::thaw pack "H*", $value };
1087 }
1088 }
1089 },
1090);
1091
1092#############################################################################
1093 993
1094=head2 CORE EXTENSIONS 994=head2 CORE EXTENSIONS
1095 995
1096Functions and methods that extend core crossfire objects. 996Functions and methods that extend core crossfire objects.
1097 997
998=cut
999
1000package cf::player;
1001
1002use Coro::AIO;
1003
1098=head3 cf::player 1004=head3 cf::player
1099 1005
1100=over 4 1006=over 4
1101 1007
1102=item cf::player::exists $login 1008=item cf::player::find $login
1103 1009
1104Returns true when the given account exists. 1010Returns the given player object, loading it if necessary (might block).
1105 1011
1106=cut 1012=cut
1107 1013
1108sub cf::player::exists($) { 1014sub playerdir($) {
1109 cf::player::find $_[0] 1015 "$PLAYERDIR/"
1110 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1016 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1111} 1017}
1112 1018
1019sub path($) {
1020 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1021
1022 (playerdir $login) . "/playerdata"
1023}
1024
1025sub find_active($) {
1026 $cf::PLAYER{$_[0]}
1027 and $cf::PLAYER{$_[0]}->active
1028 and $cf::PLAYER{$_[0]}
1029}
1030
1031sub exists($) {
1032 my ($login) = @_;
1033
1034 $cf::PLAYER{$login}
1035 or cf::sync_job { !aio_stat path $login }
1036}
1037
1038sub find($) {
1039 return $cf::PLAYER{$_[0]} || do {
1040 my $login = $_[0];
1041
1042 my $guard = cf::lock_acquire "user_find:$login";
1043
1044 $cf::PLAYER{$_[0]} || do {
1045 # rename old playerfiles to new ones
1046 #TODO: remove when no longer required
1047 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1048 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1049 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1050 aio_unlink +(playerdir $login) . "/$login.pl";
1051
1052 my $pl = load_pl path $login
1053 or return;
1054 $cf::PLAYER{$login} = $pl
1055 }
1056 }
1057}
1058
1059sub save($) {
1060 my ($pl) = @_;
1061
1062 return if $pl->{deny_save};
1063
1064 my $path = path $pl;
1065 my $guard = cf::lock_acquire "user_save:$path";
1066
1067 return if $pl->{deny_save};
1068
1069 aio_mkdir playerdir $pl, 0770;
1070 $pl->{last_save} = $cf::RUNTIME;
1071
1072 $pl->save_pl ($path);
1073 Coro::cede;
1074}
1075
1076sub new($) {
1077 my ($login) = @_;
1078
1079 my $self = create;
1080
1081 $self->ob->name ($login);
1082 $self->{deny_save} = 1;
1083
1084 $cf::PLAYER{$login} = $self;
1085
1086 $self
1087}
1088
1089=item $pl->quit_character
1090
1091Nukes the player without looking back. If logged in, the connection will
1092be destroyed. May block for a long time.
1093
1094=cut
1095
1096sub quit_character {
1097 my ($pl) = @_;
1098
1099 my $name = $pl->ob->name;
1100
1101 $pl->{deny_save} = 1;
1102 $pl->password ("*"); # this should lock out the player until we nuked the dir
1103
1104 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1105 $pl->deactivate;
1106 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1107 $pl->ns->destroy if $pl->ns;
1108
1109 my $path = playerdir $pl;
1110 my $temp = "$path~$cf::RUNTIME~deleting~";
1111 aio_rename $path, $temp;
1112 delete $cf::PLAYER{$pl->ob->name};
1113 $pl->destroy;
1114
1115 my $prefix = qr<^~\Q$name\E/>;
1116
1117 # nuke player maps
1118 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1119
1120 IO::AIO::aio_rmtree $temp;
1121}
1122
1123=item $pl->kick
1124
1125Kicks a player out of the game. This destroys the connection.
1126
1127=cut
1128
1129sub kick {
1130 my ($pl, $kicker) = @_;
1131
1132 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1133 $pl->killer ("kicked");
1134 $pl->ns->destroy;
1135}
1136
1137=item cf::player::list_logins
1138
1139Returns am arrayref of all valid playernames in the system, can take a
1140while and may block, so not sync_job-capable, ever.
1141
1142=cut
1143
1144sub list_logins {
1145 my $dirs = aio_readdir $PLAYERDIR
1146 or return [];
1147
1148 my @logins;
1149
1150 for my $login (@$dirs) {
1151 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1152 aio_read $fh, 0, 512, my $buf, 0 or next;
1153 $buf !~ /^password -------------$/m or next; # official not-valid tag
1154
1155 utf8::decode $login;
1156 push @logins, $login;
1157 }
1158
1159 \@logins
1160}
1161
1162=item $player->maps
1163
1164Returns an arrayref of map paths that are private for this
1165player. May block.
1166
1167=cut
1168
1169sub maps($) {
1170 my ($pl) = @_;
1171
1172 $pl = ref $pl ? $pl->ob->name : $pl;
1173
1174 my $files = aio_readdir playerdir $pl
1175 or return;
1176
1177 my @paths;
1178
1179 for (@$files) {
1180 utf8::decode $_;
1181 next if /\.(?:pl|pst)$/;
1182 next unless /^$PATH_SEP/o;
1183
1184 push @paths, cf::map::normalise "~$pl/$_";
1185 }
1186
1187 \@paths
1188}
1189
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1190=item $player->ext_reply ($msgid, %msg)
1114 1191
1115Sends an ext reply to the player. 1192Sends an ext reply to the player.
1116 1193
1117=cut 1194=cut
1118 1195
1119sub cf::player::ext_reply($$$%) { 1196sub ext_reply($$%) {
1120 my ($self, $id, %msg) = @_; 1197 my ($self, $id, %msg) = @_;
1121 1198
1122 $msg{msgid} = $id; 1199 $msg{msgid} = $id;
1123 1200
1124 $self->send ("ext " . to_json \%msg); 1201 $self->send ("ext " . cf::to_json \%msg);
1202}
1203
1204=item $player->ext_event ($type, %msg)
1205
1206Sends an ext event to the client.
1207
1208=cut
1209
1210sub ext_event($$%) {
1211 my ($self, $type, %msg) = @_;
1212
1213 $self->ns->ext_event ($type, %msg);
1214}
1215
1216=head3 cf::region
1217
1218=over 4
1219
1220=cut
1221
1222package cf::region;
1223
1224=item cf::region::find_by_path $path
1225
1226Tries to decuce the probable region for a map knowing only its path.
1227
1228=cut
1229
1230sub find_by_path($) {
1231 my ($path) = @_;
1232
1233 my ($match, $specificity);
1234
1235 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) {
1237 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity;
1239 }
1240 }
1241
1242 $match
1125} 1243}
1126 1244
1127=back 1245=back
1128
1129 1246
1130=head3 cf::map 1247=head3 cf::map
1131 1248
1132=over 4 1249=over 4
1133 1250
1136package cf::map; 1253package cf::map;
1137 1254
1138use Fcntl; 1255use Fcntl;
1139use Coro::AIO; 1256use Coro::AIO;
1140 1257
1258use overload
1259 '""' => \&as_string,
1260 fallback => 1;
1261
1141our $MAX_RESET = 7200; 1262our $MAX_RESET = 3600;
1142our $DEFAULT_RESET = 3600; 1263our $DEFAULT_RESET = 3000;
1143 1264
1144sub generate_random_map { 1265sub generate_random_map {
1145 my ($path, $rmp) = @_; 1266 my ($self, $rmp) = @_;
1146
1147 # mit "rum" bekleckern, nicht 1267 # mit "rum" bekleckern, nicht
1148 cf::map::_create_random_map 1268 $self->_create_random_map (
1149 $path,
1150 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1269 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1151 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1270 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1152 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1271 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1153 $rmp->{exit_on_final_map}, 1272 $rmp->{exit_on_final_map},
1154 $rmp->{xsize}, $rmp->{ysize}, 1273 $rmp->{xsize}, $rmp->{ysize},
1155 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1274 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1156 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1275 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1157 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1276 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1158 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1277 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1159 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1278 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1160 (cf::region::find $rmp->{region}) 1279 (cf::region::find $rmp->{region}), $rmp->{custom}
1280 )
1281}
1282
1283=item cf::map->register ($regex, $prio)
1284
1285Register a handler for the map path matching the given regex at the
1286givne priority (higher is better, built-in handlers have priority 0, the
1287default).
1288
1289=cut
1290
1291sub register {
1292 my (undef, $regex, $prio) = @_;
1293 my $pkg = caller;
1294
1295 no strict;
1296 push @{"$pkg\::ISA"}, __PACKAGE__;
1297
1298 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1299}
1300
1301# also paths starting with '/'
1302$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1303
1304sub thawer_merge {
1305 my ($self, $merge) = @_;
1306
1307 # we have to keep some variables in memory intact
1308 local $self->{path};
1309 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312
1313 $self->SUPER::thawer_merge ($merge);
1314}
1315
1316sub normalise {
1317 my ($path, $base) = @_;
1318
1319 $path = "$path"; # make sure its a string
1320
1321 $path =~ s/\.map$//;
1322
1323 # map plan:
1324 #
1325 # /! non-realised random map exit (special hack!)
1326 # {... are special paths that are not being touched
1327 # ?xxx/... are special absolute paths
1328 # ?random/... random maps
1329 # /... normal maps
1330 # ~user/... per-player map of a specific user
1331
1332 $path =~ s/$PATH_SEP/\//go;
1333
1334 # treat it as relative path if it starts with
1335 # something that looks reasonable
1336 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1337 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1338
1339 $base =~ s{[^/]+/?$}{};
1340 $path = "$base/$path";
1341 }
1342
1343 for ($path) {
1344 redo if s{//}{/};
1345 redo if s{/\.?/}{/};
1346 redo if s{/[^/]+/\.\./}{/};
1347 }
1348
1349 $path
1350}
1351
1352sub new_from_path {
1353 my (undef, $path, $base) = @_;
1354
1355 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1356
1357 $path = normalise $path, $base;
1358
1359 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1360 if ($path =~ $EXT_MAP{$pkg}[1]) {
1361 my $self = bless cf::map::new, $pkg;
1362 $self->{path} = $path; $self->path ($path);
1363 $self->init; # pass $1 etc.
1364 return $self;
1365 }
1366 }
1367
1368 Carp::carp "unable to resolve path '$path' (base '$base').";
1369 ()
1370}
1371
1372sub init {
1373 my ($self) = @_;
1374
1375 $self
1376}
1377
1378sub as_string {
1379 my ($self) = @_;
1380
1381 "$self->{path}"
1382}
1383
1384# the displayed name, this is a one way mapping
1385sub visible_name {
1386 &as_string
1387}
1388
1389# the original (read-only) location
1390sub load_path {
1391 my ($self) = @_;
1392
1393 "$MAPDIR/$self->{path}.map"
1394}
1395
1396# the temporary/swap location
1397sub save_path {
1398 my ($self) = @_;
1399
1400 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1401 "$TMPDIR/$path.map"
1402}
1403
1404# the unique path, undef == no special unique path
1405sub uniq_path {
1406 my ($self) = @_;
1407
1408 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1409 "$UNIQUEDIR/$path"
1161} 1410}
1162 1411
1163# and all this just because we cannot iterate over 1412# and all this just because we cannot iterate over
1164# all maps in C++... 1413# all maps in C++...
1165sub change_all_map_light { 1414sub change_all_map_light {
1167 1416
1168 $_->change_map_light ($change) 1417 $_->change_map_light ($change)
1169 for grep $_->outdoor, values %cf::MAP; 1418 for grep $_->outdoor, values %cf::MAP;
1170} 1419}
1171 1420
1421sub unlink_save {
1422 my ($self) = @_;
1423
1424 utf8::encode (my $save = $self->save_path);
1425 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1426 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1427}
1428
1172sub try_load_header($) { 1429sub load_header_from($) {
1173 my ($path) = @_; 1430 my ($self, $path) = @_;
1174 1431
1175 utf8::encode $path; 1432 utf8::encode $path;
1176 aio_open $path, O_RDONLY, 0 1433 #aio_open $path, O_RDONLY, 0
1434 # or return;
1435
1436 $self->_load_header ($path)
1177 or return; 1437 or return;
1178 1438
1179 my $map = cf::map::new 1439 $self->{load_path} = $path;
1440
1441 1
1442}
1443
1444sub load_header_orig {
1445 my ($self) = @_;
1446
1447 $self->load_header_from ($self->load_path)
1448}
1449
1450sub load_header_temp {
1451 my ($self) = @_;
1452
1453 $self->load_header_from ($self->save_path)
1454}
1455
1456sub prepare_temp {
1457 my ($self) = @_;
1458
1459 $self->last_access ((delete $self->{last_access})
1460 || $cf::RUNTIME); #d#
1461 # safety
1462 $self->{instantiate_time} = $cf::RUNTIME
1463 if $self->{instantiate_time} > $cf::RUNTIME;
1464}
1465
1466sub prepare_orig {
1467 my ($self) = @_;
1468
1469 $self->{load_original} = 1;
1470 $self->{instantiate_time} = $cf::RUNTIME;
1471 $self->last_access ($cf::RUNTIME);
1472 $self->instantiate;
1473}
1474
1475sub load_header {
1476 my ($self) = @_;
1477
1478 if ($self->load_header_temp) {
1479 $self->prepare_temp;
1480 } else {
1481 $self->load_header_orig
1180 or return; 1482 or return;
1483 $self->prepare_orig;
1484 }
1181 1485
1182 $map->load_header ($path) 1486 $self->default_region (cf::region::find_by_path $self->{path})
1183 or return; 1487 unless $self->default_region;
1184 1488
1185 $map->{load_path} = $path; 1489 1
1186
1187 $map
1188} 1490}
1189 1491
1190sub find_map; 1492sub find;
1191sub find_map { 1493sub find {
1192 my ($path, $origin) = @_; 1494 my ($path, $origin) = @_;
1193 1495
1194 #warn "find_map<$path,$origin>\n";#d#
1195
1196 $path = new cf::path $path, $origin && $origin->path; 1496 $path = normalise $path, $origin && $origin->path;
1197 my $key = $path->as_string;
1198 1497
1199 cf::lock_wait "map_find:$key"; 1498 cf::lock_wait "map_find:$path";
1200 1499
1201 $cf::MAP{$key} || do { 1500 $cf::MAP{$path} || do {
1202 my $guard = cf::lock_acquire "map_find:$key"; 1501 my $guard = cf::lock_acquire "map_find:$path";
1203 1502 my $map = new_from_path cf::map $path
1204 # do it the slow way
1205 my $map = try_load_header $path->save_path;
1206
1207 if ($map) {
1208 $map->last_access ((delete $map->{last_access})
1209 || $cf::RUNTIME); #d#
1210 # safety
1211 $map->{instantiate_time} = $cf::RUNTIME
1212 if $map->{instantiate_time} > $cf::RUNTIME;
1213 } else {
1214 if (my $rmp = $path->random_map_params) {
1215 $map = generate_random_map $key, $rmp;
1216 } else {
1217 $map = try_load_header $path->load_path;
1218 }
1219
1220 $map or return; 1503 or return;
1221 1504
1222 $map->{load_original} = 1;
1223 $map->{instantiate_time} = $cf::RUNTIME;
1224 $map->last_access ($cf::RUNTIME);
1225 $map->instantiate;
1226
1227 # per-player maps become, after loading, normal maps
1228 $map->per_player (0) if $path->{user_rel};
1229 }
1230
1231 $map->path ($key);
1232 $map->{path} = $path;
1233 $map->{last_save} = $cf::RUNTIME; 1505 $map->{last_save} = $cf::RUNTIME;
1234 1506
1235 if ($map->should_reset) { 1507 $map->load_header
1508 or return;
1509
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait;
1236 $map->reset; 1513 $map->reset;
1237 undef $guard; 1514 undef $guard;
1238 $map = find_map $path 1515 return find $path;
1239 or return;
1240 } 1516 }
1241 1517
1242 $cf::MAP{$key} = $map 1518 $cf::MAP{$path} = $map
1243 } 1519 }
1244} 1520}
1521
1522sub pre_load { }
1523sub post_load { }
1245 1524
1246sub load { 1525sub load {
1247 my ($self) = @_; 1526 my ($self) = @_;
1248 1527
1528 local $self->{deny_reset} = 1; # loading can take a long time
1529
1249 my $path = $self->{path}; 1530 my $path = $self->{path};
1531
1532 {
1250 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1533 my $guard = cf::lock_acquire "map_load:$path";
1251 1534
1252 return if $self->in_memory != cf::MAP_SWAPPED; 1535 return if $self->in_memory != cf::MAP_SWAPPED;
1253 1536
1254 $self->in_memory (cf::MAP_LOADING); 1537 $self->in_memory (cf::MAP_LOADING);
1255 1538
1256 $self->alloc; 1539 $self->alloc;
1540
1541 $self->pre_load;
1542 Coro::cede;
1543
1257 $self->load_objects ($self->{load_path}, 1) 1544 $self->_load_objects ($self->{load_path}, 1)
1258 or return; 1545 or return;
1259 1546
1260 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1547 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1261 if delete $self->{load_original}; 1548 if delete $self->{load_original};
1262 1549
1263 if (my $uniq = $path->uniq_path) { 1550 if (my $uniq = $self->uniq_path) {
1264 utf8::encode $uniq; 1551 utf8::encode $uniq;
1265 if (aio_open $uniq, O_RDONLY, 0) { 1552 if (aio_open $uniq, O_RDONLY, 0) {
1266 $self->clear_unique_items; 1553 $self->clear_unique_items;
1267 $self->load_objects ($uniq, 0); 1554 $self->_load_objects ($uniq, 0);
1268 } 1555 }
1269 } 1556 }
1270 1557
1558 Coro::cede;
1271 # now do the right thing for maps 1559 # now do the right thing for maps
1272 $self->link_multipart_objects; 1560 $self->link_multipart_objects;
1273
1274 if ($self->{path}->is_style_map) {
1275 $self->{deny_save} = 1;
1276 $self->{deny_reset} = 1;
1277 } else {
1278 $self->fix_auto_apply;
1279 $self->decay_objects;
1280 $self->update_buttons;
1281 $self->set_darkness_map;
1282 $self->difficulty ($self->estimate_difficulty) 1561 $self->difficulty ($self->estimate_difficulty)
1283 unless $self->difficulty; 1562 unless $self->difficulty;
1563 Coro::cede;
1564
1565 unless ($self->{deny_activate}) {
1566 $self->decay_objects;
1567 $self->fix_auto_apply;
1568 $self->update_buttons;
1569 Coro::cede;
1570 $self->set_darkness_map;
1571 Coro::cede;
1284 $self->activate; 1572 $self->activate;
1285 } 1573 }
1286 1574
1287 $self->in_memory (cf::MAP_IN_MEMORY); 1575 $self->in_memory (cf::MAP_IN_MEMORY);
1288} 1576 }
1289 1577
1290sub load_map_sync { 1578 $self->post_load;
1579}
1580
1581sub customise_for {
1582 my ($self, $ob) = @_;
1583
1584 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player;
1586
1587 $self
1588}
1589
1590# find and load all maps in the 3x3 area around a map
1591sub load_diag {
1592 my ($map) = @_;
1593
1594 my @diag; # diagonal neighbours
1595
1596 for (0 .. 3) {
1597 my $neigh = $map->tile_path ($_)
1598 or next;
1599 $neigh = find $neigh, $map
1600 or next;
1601 $neigh->load;
1602
1603 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1604 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1605 }
1606
1607 for (@diag) {
1608 my $neigh = find @$_
1609 or next;
1610 $neigh->load;
1611 }
1612}
1613
1614sub find_sync {
1291 my ($path, $origin) = @_; 1615 my ($path, $origin) = @_;
1292 1616
1293 #warn "load_map_sync<$path, $origin>\n";#d# 1617 cf::sync_job { find $path, $origin }
1618}
1294 1619
1295 cf::sync_job { 1620sub do_load_sync {
1296 my $map = cf::map::find_map $path, $origin 1621 my ($map) = @_;
1297 or return; 1622
1623 cf::sync_job { $map->load };
1624}
1625
1626our %MAP_PREFETCH;
1627our $MAP_PREFETCHER = undef;
1628
1629sub find_async {
1630 my ($path, $origin) = @_;
1631
1632 $path = normalise $path, $origin && $origin->{path};
1633
1634 if (my $map = $cf::MAP{$path}) {
1635 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1636 }
1637
1638 undef $MAP_PREFETCH{$path};
1639 $MAP_PREFETCHER ||= cf::async {
1640 while (%MAP_PREFETCH) {
1641 for my $path (keys %MAP_PREFETCH) {
1642 my $map = find $path
1643 or next;
1298 $map->load; 1644 $map->load;
1299 $map 1645
1646 delete $MAP_PREFETCH{$path};
1647 }
1648 }
1649 undef $MAP_PREFETCHER;
1300 } 1650 };
1651 $MAP_PREFETCHER->prio (6);
1652
1653 ()
1301} 1654}
1302 1655
1303sub save { 1656sub save {
1304 my ($self) = @_; 1657 my ($self) = @_;
1305 1658
1659 my $lock = cf::lock_acquire "map_data:" . $self->path;
1660
1306 $self->{last_save} = $cf::RUNTIME; 1661 $self->{last_save} = $cf::RUNTIME;
1307 1662
1308 return unless $self->dirty; 1663 return unless $self->dirty;
1309 1664
1310 my $save = $self->{path}->save_path; utf8::encode $save; 1665 my $save = $self->save_path; utf8::encode $save;
1311 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1666 my $uniq = $self->uniq_path; utf8::encode $uniq;
1312 1667
1313 $self->{load_path} = $save; 1668 $self->{load_path} = $save;
1314 1669
1315 return if $self->{deny_save}; 1670 return if $self->{deny_save};
1316 1671
1317 local $self->{last_access} = $self->last_access;#d# 1672 local $self->{last_access} = $self->last_access;#d#
1318 1673
1674 cf::async {
1675 $_->contr->save for $self->players;
1676 };
1677
1319 if ($uniq) { 1678 if ($uniq) {
1320 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1679 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1321 $self->save_objects ($uniq, cf::IO_UNIQUES); 1680 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1322 } else { 1681 } else {
1323 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1682 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1324 } 1683 }
1325} 1684}
1326 1685
1327sub swap_out { 1686sub swap_out {
1328 my ($self) = @_; 1687 my ($self) = @_;
1329 1688
1330 # save first because save cedes 1689 # save first because save cedes
1331 $self->save; 1690 $self->save;
1691
1692 my $lock = cf::lock_acquire "map_data:" . $self->path;
1332 1693
1333 return if $self->players; 1694 return if $self->players;
1334 return if $self->in_memory != cf::MAP_IN_MEMORY; 1695 return if $self->in_memory != cf::MAP_IN_MEMORY;
1335 return if $self->{deny_save}; 1696 return if $self->{deny_save};
1336 1697
1340 1701
1341sub reset_at { 1702sub reset_at {
1342 my ($self) = @_; 1703 my ($self) = @_;
1343 1704
1344 # TODO: safety, remove and allow resettable per-player maps 1705 # TODO: safety, remove and allow resettable per-player maps
1345 return 1e99 if $self->{path}{user_rel}; 1706 return 1e99 if $self->isa ("ext::map_per_player");#d#
1346 return 1e99 if $self->{deny_reset}; 1707 return 1e99 if $self->{deny_reset};
1347 1708
1348 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1349 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1350 1711
1355 my ($self) = @_; 1716 my ($self) = @_;
1356 1717
1357 $self->reset_at <= $cf::RUNTIME 1718 $self->reset_at <= $cf::RUNTIME
1358} 1719}
1359 1720
1360sub unlink_save {
1361 my ($self) = @_;
1362
1363 utf8::encode (my $save = $self->{path}->save_path);
1364 aioreq_pri 3; IO::AIO::aio_unlink $save;
1365 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1366}
1367
1368sub rename {
1369 my ($self, $new_path) = @_;
1370
1371 $self->unlink_save;
1372
1373 delete $cf::MAP{$self->path};
1374 $self->{path} = new cf::path $new_path;
1375 $self->path ($self->{path}->as_string);
1376 $cf::MAP{$self->path} = $self;
1377
1378 $self->save;
1379}
1380
1381sub reset { 1721sub reset {
1382 my ($self) = @_; 1722 my ($self) = @_;
1383 1723
1724 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725
1384 return if $self->players; 1726 return if $self->players;
1385 return if $self->{path}{user_rel};#d# 1727 return if $self->isa ("ext::map_per_player");#d#
1386 1728
1387 warn "resetting map ", $self->path;#d# 1729 warn "resetting map ", $self->path;#d#
1388 1730
1731 $self->in_memory (cf::MAP_SWAPPED);
1732
1733 # need to save uniques path
1734 unless ($self->{deny_save}) {
1735 my $uniq = $self->uniq_path; utf8::encode $uniq;
1736
1737 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1738 if $uniq;
1739 }
1740
1389 delete $cf::MAP{$self->path}; 1741 delete $cf::MAP{$self->path};
1742
1743 $self->clear;
1390 1744
1391 $_->clear_links_to ($self) for values %cf::MAP; 1745 $_->clear_links_to ($self) for values %cf::MAP;
1392 1746
1393 $self->unlink_save; 1747 $self->unlink_save;
1394 $self->destroy; 1748 $self->destroy;
1397my $nuke_counter = "aaaa"; 1751my $nuke_counter = "aaaa";
1398 1752
1399sub nuke { 1753sub nuke {
1400 my ($self) = @_; 1754 my ($self) = @_;
1401 1755
1756 delete $cf::MAP{$self->path};
1757
1758 $self->unlink_save;
1759
1760 bless $self, "cf::map";
1761 delete $self->{deny_reset};
1402 $self->{deny_save} = 1; 1762 $self->{deny_save} = 1;
1403 $self->reset_timeout (1); 1763 $self->reset_timeout (1);
1404 $self->rename ("{nuke}/" . ($nuke_counter++)); 1764 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1765
1766 $cf::MAP{$self->path} = $self;
1767
1405 $self->reset; # polite request, might not happen 1768 $self->reset; # polite request, might not happen
1406} 1769}
1407 1770
1408sub customise_for { 1771=item cf::map::unique_maps
1409 my ($map, $ob) = @_;
1410 1772
1411 if ($map->per_player) { 1773Returns an arrayref of paths of all shared maps that have
1412 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1774instantiated unique items. May block.
1413 }
1414 1775
1415 $map 1776=cut
1416}
1417 1777
1418sub emergency_save { 1778sub unique_maps() {
1419 local $cf::FREEZE = 1; 1779 my $files = aio_readdir $UNIQUEDIR
1780 or return;
1420 1781
1421 warn "enter emergency map save\n"; 1782 my @paths;
1422 1783
1423 cf::sync_job { 1784 for (@$files) {
1424 warn "begin emergency map save\n"; 1785 utf8::decode $_;
1425 $_->save for values %cf::MAP; 1786 next if /\.pst$/;
1787 next unless /^$PATH_SEP/o;
1788
1789 push @paths, cf::map::normalise $_;
1426 }; 1790 }
1427 1791
1428 warn "end emergency map save\n"; 1792 \@paths
1429} 1793}
1430 1794
1431package cf; 1795package cf;
1432 1796
1433=back 1797=back
1434 1798
1799=head3 cf::object
1800
1801=cut
1802
1803package cf::object;
1804
1805=over 4
1806
1807=item $ob->inv_recursive
1808
1809Returns the inventory of the object _and_ their inventories, recursively.
1810
1811=cut
1812
1813sub inv_recursive_;
1814sub inv_recursive_ {
1815 map { $_, inv_recursive_ $_->inv } @_
1816}
1817
1818sub inv_recursive {
1819 inv_recursive_ inv $_[0]
1820}
1821
1822package cf;
1823
1824=back
1435 1825
1436=head3 cf::object::player 1826=head3 cf::object::player
1437 1827
1438=over 4 1828=over 4
1439 1829
1479 1869
1480=item $player_object->enter_link 1870=item $player_object->enter_link
1481 1871
1482Freezes the player and moves him/her to a special map (C<{link}>). 1872Freezes the player and moves him/her to a special map (C<{link}>).
1483 1873
1484The player should be reaosnably safe there for short amounts of time. You 1874The player should be reasonably safe there for short amounts of time. You
1485I<MUST> call C<leave_link> as soon as possible, though. 1875I<MUST> call C<leave_link> as soon as possible, though.
1486 1876
1877Will never block.
1878
1487=item $player_object->leave_link ($map, $x, $y) 1879=item $player_object->leave_link ($map, $x, $y)
1488 1880
1489Moves the player out of the specila link map onto the given map. If the 1881Moves the player out of the special C<{link}> map onto the specified
1490map is not valid (or omitted), the player will be moved back to the 1882map. If the map is not valid (or omitted), the player will be moved back
1491location he/she was before the call to C<enter_link>, or, if that fails, 1883to the location he/she was before the call to C<enter_link>, or, if that
1492to the emergency map position. 1884fails, to the emergency map position.
1493 1885
1494Might block. 1886Might block.
1495 1887
1496=cut 1888=cut
1889
1890sub link_map {
1891 unless ($LINK_MAP) {
1892 $LINK_MAP = cf::map::find "{link}"
1893 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1894 $LINK_MAP->load;
1895 }
1896
1897 $LINK_MAP
1898}
1497 1899
1498sub cf::object::player::enter_link { 1900sub cf::object::player::enter_link {
1499 my ($self) = @_; 1901 my ($self) = @_;
1500 1902
1501 $self->deactivate_recursive; 1903 $self->deactivate_recursive;
1502 1904
1503 return if $self->map == $LINK_MAP; 1905 return if UNIVERSAL::isa $self->map, "ext::map_link";
1504 1906
1505 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1907 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1506 if $self->map; 1908 if $self->map && $self->map->{path} ne "{link}";
1507 1909
1508 $self->enter_map ($LINK_MAP, 20, 20); 1910 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1509} 1911}
1510 1912
1511sub cf::object::player::leave_link { 1913sub cf::object::player::leave_link {
1512 my ($self, $map, $x, $y) = @_; 1914 my ($self, $map, $x, $y) = @_;
1915
1916 return unless $self->contr->active;
1513 1917
1514 my $link_pos = delete $self->{_link_pos}; 1918 my $link_pos = delete $self->{_link_pos};
1515 1919
1516 unless ($map) { 1920 unless ($map) {
1517 # restore original map position 1921 # restore original map position
1518 ($map, $x, $y) = @{ $link_pos || [] }; 1922 ($map, $x, $y) = @{ $link_pos || [] };
1519 $map = cf::map::find_map $map; 1923 $map = cf::map::find $map;
1520 1924
1521 unless ($map) { 1925 unless ($map) {
1522 ($map, $x, $y) = @$EMERGENCY_POSITION; 1926 ($map, $x, $y) = @$EMERGENCY_POSITION;
1523 $map = cf::map::find_map $map 1927 $map = cf::map::find $map
1524 or die "FATAL: cannot load emergency map\n"; 1928 or die "FATAL: cannot load emergency map\n";
1525 } 1929 }
1526 } 1930 }
1527 1931
1528 ($x, $y) = (-1, -1) 1932 ($x, $y) = (-1, -1)
1531 # use -1 or undef as default coordinates, not 0, 0 1935 # use -1 or undef as default coordinates, not 0, 0
1532 ($x, $y) = ($map->enter_x, $map->enter_y) 1936 ($x, $y) = ($map->enter_x, $map->enter_y)
1533 if $x <=0 && $y <= 0; 1937 if $x <=0 && $y <= 0;
1534 1938
1535 $map->load; 1939 $map->load;
1940 $map->load_diag;
1536 1941
1942 return unless $self->contr->active;
1537 $self->activate_recursive; 1943 $self->activate_recursive;
1944
1945 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1538 $self->enter_map ($map, $x, $y); 1946 $self->enter_map ($map, $x, $y);
1539} 1947}
1540 1948
1541cf::player->attach (
1542 on_logout => sub {
1543 my ($pl) = @_;
1544
1545 # abort map switching before logout
1546 if ($pl->ob->{_link_pos}) {
1547 cf::sync_job {
1548 $pl->ob->leave_link
1549 };
1550 }
1551 },
1552 on_login => sub {
1553 my ($pl) = @_;
1554
1555 # try to abort aborted map switching on player login :)
1556 # should happen only on crashes
1557 if ($pl->ob->{_link_pos}) {
1558 $pl->ob->enter_link;
1559 cf::async {
1560 # we need this sleep as the login has a concurrent enter_exit running
1561 # and this sleep increases chances of the player not ending up in scorn
1562 Coro::Timer::sleep 1;
1563 $pl->ob->leave_link;
1564 };
1565 }
1566 },
1567);
1568
1569=item $player_object->goto_map ($path, $x, $y) 1949=item $player_object->goto ($path, $x, $y[, $check->($map)])
1570 1950
1571=cut 1951Moves the player to the given map-path and coordinates by first freezing
1952her, loading and preparing them map, calling the provided $check callback
1953that has to return the map if sucecssful, and then unfreezes the player on
1954the new (success) or old (failed) map position.
1572 1955
1956=cut
1957
1958our $GOTOGEN;
1959
1573sub cf::object::player::goto_map { 1960sub cf::object::player::goto {
1574 my ($self, $path, $x, $y) = @_; 1961 my ($self, $path, $x, $y, $check) = @_;
1962
1963 # do generation counting so two concurrent goto's will be executed in-order
1964 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1575 1965
1576 $self->enter_link; 1966 $self->enter_link;
1577 1967
1578 (cf::async { 1968 (async {
1579 $path = new cf::path $path; 1969 my $map = eval {
1580
1581 my $map = cf::map::find_map $path->as_string; 1970 my $map = cf::map::find $path;
1971
1972 if ($map) {
1582 $map = $map->customise_for ($self) if $map; 1973 $map = $map->customise_for ($self);
1583 1974 $map = $check->($map) if $check && $map;
1584# warn "entering ", $map->path, " at ($x, $y)\n" 1975 } else {
1585# if $map;
1586
1587 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 1976 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1977 }
1588 1978
1979 $map
1980 };
1981
1982 if ($@) {
1983 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
1984 LOG llevError | logBacktrace, Carp::longmess $@;
1985 }
1986
1987 if ($gen == $self->{_goto_generation}) {
1988 delete $self->{_goto_generation};
1589 $self->leave_link ($map, $x, $y); 1989 $self->leave_link ($map, $x, $y);
1990 }
1590 })->prio (1); 1991 })->prio (1);
1591} 1992}
1592 1993
1593=item $player_object->enter_exit ($exit_object) 1994=item $player_object->enter_exit ($exit_object)
1594 1995
1596 1997
1597sub parse_random_map_params { 1998sub parse_random_map_params {
1598 my ($spec) = @_; 1999 my ($spec) = @_;
1599 2000
1600 my $rmp = { # defaults 2001 my $rmp = { # defaults
1601 xsize => 10, 2002 xsize => (cf::rndm 15, 40),
1602 ysize => 10, 2003 ysize => (cf::rndm 15, 40),
2004 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2005 #layout => string,
1603 }; 2006 };
1604 2007
1605 for (split /\n/, $spec) { 2008 for (split /\n/, $spec) {
1606 my ($k, $v) = split /\s+/, $_, 2; 2009 my ($k, $v) = split /\s+/, $_, 2;
1607 2010
1611 $rmp 2014 $rmp
1612} 2015}
1613 2016
1614sub prepare_random_map { 2017sub prepare_random_map {
1615 my ($exit) = @_; 2018 my ($exit) = @_;
2019
2020 my $guard = cf::lock_acquire "exit_prepare:$exit";
1616 2021
1617 # all this does is basically replace the /! path by 2022 # all this does is basically replace the /! path by
1618 # a new random map path (?random/...) with a seed 2023 # a new random map path (?random/...) with a seed
1619 # that depends on the exit object 2024 # that depends on the exit object
1620 2025
1621 my $rmp = parse_random_map_params $exit->msg; 2026 my $rmp = parse_random_map_params $exit->msg;
1622 2027
1623 if ($exit->map) { 2028 if ($exit->map) {
1624 $rmp->{region} = $exit->map->region_name; 2029 $rmp->{region} = $exit->region->name;
1625 $rmp->{origin_map} = $exit->map->path; 2030 $rmp->{origin_map} = $exit->map->path;
1626 $rmp->{origin_x} = $exit->x; 2031 $rmp->{origin_x} = $exit->x;
1627 $rmp->{origin_y} = $exit->y; 2032 $rmp->{origin_y} = $exit->y;
1628 } 2033 }
1629 2034
1630 $rmp->{random_seed} ||= $exit->random_seed; 2035 $rmp->{random_seed} ||= $exit->random_seed;
1631 2036
1632 my $data = cf::to_json $rmp; 2037 my $data = cf::to_json $rmp;
1633 my $md5 = Digest::MD5::md5_hex $data; 2038 my $md5 = Digest::MD5::md5_hex $data;
2039 my $meta = "$RANDOMDIR/$md5.meta";
1634 2040
1635 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2041 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1636 aio_write $fh, 0, (length $data), $data, 0; 2042 aio_write $fh, 0, (length $data), $data, 0;
2043 undef $fh;
2044 aio_rename "$meta~", $meta;
1637 2045
1638 $exit->slaying ("?random/$md5"); 2046 $exit->slaying ("?random/$md5");
1639 $exit->msg (undef); 2047 $exit->msg (undef);
1640 } 2048 }
1641} 2049}
1643sub cf::object::player::enter_exit { 2051sub cf::object::player::enter_exit {
1644 my ($self, $exit) = @_; 2052 my ($self, $exit) = @_;
1645 2053
1646 return unless $self->type == cf::PLAYER; 2054 return unless $self->type == cf::PLAYER;
1647 2055
2056 if ($exit->slaying eq "/!") {
2057 #TODO: this should de-fi-ni-te-ly not be a sync-job
2058 # the problem is that $exit might not survive long enough
2059 # so it needs to be done right now, right here
2060 cf::sync_job { prepare_random_map $exit };
2061 }
2062
2063 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2064 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp;
2066
1648 $self->enter_link; 2067 $self->enter_link;
1649 2068
1650 (cf::async { 2069 (async {
2070 $self->deactivate_recursive; # just to be sure
1651 unless (eval { 2071 unless (eval {
1652 prepare_random_map $exit 2072 $self->goto ($slaying, $hp, $sp);
1653 if $exit->slaying eq "/!";
1654
1655 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1656 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1657 2073
1658 1; 2074 1;
1659 }) { 2075 }) {
1660 $self->message ("Something went wrong deep within the crossfire server. " 2076 $self->message ("Something went wrong deep within the crossfire server. "
1661 . "I'll try to bring you back to the map you were before. " 2077 . "I'll try to bring you back to the map you were before. "
1662 . "Please report this to the dungeon master", 2078 . "Please report this to the dungeon master!",
1663 cf::NDI_UNIQUE | cf::NDI_RED); 2079 cf::NDI_UNIQUE | cf::NDI_RED);
1664 2080
1665 warn "ERROR in enter_exit: $@"; 2081 warn "ERROR in enter_exit: $@";
1666 $self->leave_link; 2082 $self->leave_link;
1667 } 2083 }
1668 })->prio (1); 2084 })->prio (1);
1681 2097
1682sub cf::client::send_drawinfo { 2098sub cf::client::send_drawinfo {
1683 my ($self, $text, $flags) = @_; 2099 my ($self, $text, $flags) = @_;
1684 2100
1685 utf8::encode $text; 2101 utf8::encode $text;
1686 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1687} 2103}
1688 2104
2105=item $client->ext_event ($type, %msg)
2106
2107Sends an exti event to the client.
2108
2109=cut
2110
2111sub cf::client::ext_event($$%) {
2112 my ($self, $type, %msg) = @_;
2113
2114 $msg{msgtype} = "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg);
2116}
1689 2117
1690=item $success = $client->query ($flags, "text", \&cb) 2118=item $success = $client->query ($flags, "text", \&cb)
1691 2119
1692Queues a query to the client, calling the given callback with 2120Queues a query to the client, calling the given callback with
1693the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1722 # get handled first 2150 # get handled first
1723 my $queue = delete $ns->{query_queue} 2151 my $queue = delete $ns->{query_queue}
1724 or return; # be conservative, not sure how that can happen, but we saw a crash here 2152 or return; # be conservative, not sure how that can happen, but we saw a crash here
1725 2153
1726 (shift @$queue)->[1]->($msg); 2154 (shift @$queue)->[1]->($msg);
2155 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1727 2156
1728 push @{ $ns->{query_queue} }, @$queue; 2157 push @{ $ns->{query_queue} }, @$queue;
1729 2158
1730 if (@{ $ns->{query_queue} } == @$queue) { 2159 if (@{ $ns->{query_queue} } == @$queue) {
1731 if (@$queue) { 2160 if (@$queue) {
1735 } 2164 }
1736 } 2165 }
1737 }, 2166 },
1738); 2167);
1739 2168
1740=item $client->coro (\&cb) 2169=item $client->async (\&cb)
1741 2170
1742Create a new coroutine, running the specified callback. The coroutine will 2171Create a new coroutine, running the specified callback. The coroutine will
1743be automatically cancelled when the client gets destroyed (e.g. on logout, 2172be automatically cancelled when the client gets destroyed (e.g. on logout,
1744or loss of connection). 2173or loss of connection).
1745 2174
1746=cut 2175=cut
1747 2176
1748sub cf::client::coro { 2177sub cf::client::async {
1749 my ($self, $cb) = @_; 2178 my ($self, $cb) = @_;
1750 2179
1751 my $coro = &cf::async ($cb); 2180 my $coro = &Coro::async ($cb);
1752 2181
1753 $coro->on_destroy (sub { 2182 $coro->on_destroy (sub {
1754 delete $self->{_coro}{$coro+0}; 2183 delete $self->{_coro}{$coro+0};
1755 }); 2184 });
1756 2185
1789 2218
1790# here we export the classes and methods available to script code 2219# here we export the classes and methods available to script code
1791 2220
1792=pod 2221=pod
1793 2222
1794The following fucntions and emthods are available within a safe environment: 2223The following functions and methods are available within a safe environment:
1795 2224
1796 cf::object contr pay_amount pay_player map 2225 cf::object contr pay_amount pay_player map
1797 cf::object::player player 2226 cf::object::player player
1798 cf::player peaceful 2227 cf::player peaceful
1799 cf::map trigger 2228 cf::map trigger
1884############################################################################# 2313#############################################################################
1885 2314
1886=head2 EXTENSION DATABASE SUPPORT 2315=head2 EXTENSION DATABASE SUPPORT
1887 2316
1888Crossfire maintains a very simple database for extension use. It can 2317Crossfire maintains a very simple database for extension use. It can
1889currently store anything that can be serialised using Storable, which 2318currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1890excludes objects. 2319convert to/from binary).
1891 2320
1892The parameter C<$family> should best start with the name of the extension 2321The parameter C<$family> should best start with the name of the extension
1893using it, it should be unique. 2322using it, it should be unique.
1894 2323
1895=over 4 2324=over 4
1896 2325
1897=item $hashref = cf::db_get $family
1898
1899Return a hashref for use by the extension C<$family>, which can be
1900modified. After modifications, you have to call C<cf::db_dirty> or
1901C<cf::db_sync>.
1902
1903=item $value = cf::db_get $family => $key 2326=item $value = cf::db_get $family => $key
1904 2327
1905Returns a single value from the database 2328Returns a single value from the database.
1906
1907=item cf::db_put $family => $hashref
1908
1909Stores the given family hashref into the database. Updates are delayed, if
1910you want the data to be synced to disk immediately, use C<cf::db_sync>.
1911 2329
1912=item cf::db_put $family => $key => $value 2330=item cf::db_put $family => $key => $value
1913 2331
1914Stores the given C<$value> in the family hash. Updates are delayed, if you 2332Stores the given C<$value> in the family.
1915want the data to be synced to disk immediately, use C<cf::db_sync>.
1916
1917=item cf::db_dirty
1918
1919Marks the database as dirty, to be updated at a later time.
1920
1921=item cf::db_sync
1922
1923Immediately write the database to disk I<if it is dirty>.
1924 2333
1925=cut 2334=cut
1926 2335
1927our $DB; 2336our $DB;
1928 2337
1929{ 2338sub db_init {
1930 my $path = cf::localdir . "/database.pst"; 2339 unless ($DB) {
2340 $DB = BDB::db_create $DB_ENV;
1931 2341
1932 sub db_load() { 2342 cf::sync_job {
1933 $DB = stat $path ? Storable::retrieve $path : { }; 2343 eval {
1934 } 2344 $DB->set_flags (BDB::CHKSUM);
1935 2345
1936 my $pid; 2346 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1937 2347 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1938 sub db_save() { 2348 cf::cleanup "db_open(db): $!" if $!;
1939 waitpid $pid, 0 if $pid; 2349 };
1940 if (0 == ($pid = fork)) { 2350 cf::cleanup "db_open(db): $@" if $@;
1941 $DB->{_meta}{version} = 1;
1942 Storable::nstore $DB, "$path~";
1943 rename "$path~", $path;
1944 cf::_exit 0 if defined $pid;
1945 } 2351 };
1946 }
1947
1948 my $dirty;
1949
1950 sub db_sync() {
1951 db_save if $dirty;
1952 undef $dirty;
1953 }
1954
1955 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1956 db_sync;
1957 }); 2352 }
2353}
1958 2354
1959 sub db_dirty() {
1960 $dirty = 1;
1961 $idle->start;
1962 }
1963
1964 sub db_get($;$) { 2355sub db_get($$) {
1965 @_ >= 2 2356 my $key = "$_[0]/$_[1]";
1966 ? $DB->{$_[0]}{$_[1]}
1967 : ($DB->{$_[0]} ||= { })
1968 }
1969 2357
2358 cf::sync_job {
2359 BDB::db_get $DB, undef, $key, my $data;
2360
2361 $! ? ()
2362 : $data
2363 }
2364}
2365
1970 sub db_put($$;$) { 2366sub db_put($$$) {
1971 if (@_ >= 3) { 2367 BDB::dbreq_pri 4;
1972 $DB->{$_[0]}{$_[1]} = $_[2]; 2368 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1973 } else { 2369}
1974 $DB->{$_[0]} = $_[1];
1975 }
1976 db_dirty;
1977 }
1978 2370
1979 cf::global->attach ( 2371=item cf::cache $id => [$paths...], $processversion => $process
1980 prio => 10000, 2372
1981 on_cleanup => sub { 2373Generic caching function that returns the value of the resource $id,
1982 db_sync; 2374caching and regenerating as required.
2375
2376This function can block.
2377
2378=cut
2379
2380sub cache {
2381 my ($id, $src, $processversion, $process) = @_;
2382
2383 my $meta =
2384 join "\x00",
2385 $processversion,
2386 map {
2387 aio_stat $_
2388 and Carp::croak "$_: $!";
2389
2390 ($_, (stat _)[7,9])
2391 } @$src;
2392
2393 my $dbmeta = db_get cache => "$id/meta";
2394 if ($dbmeta ne $meta) {
2395 # changed, we may need to process
2396
2397 my @data;
2398 my $md5;
2399
2400 for (0 .. $#$src) {
2401 0 <= aio_load $src->[$_], $data[$_]
2402 or Carp::croak "$src->[$_]: $!";
1983 }, 2403 }
1984 ); 2404
2405 # if processing is expensive, check
2406 # checksum first
2407 if (1) {
2408 $md5 =
2409 join "\x00",
2410 $processversion,
2411 map {
2412 Coro::cede;
2413 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414 } 0.. $#$src;
2415
2416
2417 my $dbmd5 = db_get cache => "$id/md5";
2418 if ($dbmd5 eq $md5) {
2419 db_put cache => "$id/meta", $meta;
2420
2421 return db_get cache => "$id/data";
2422 }
2423 }
2424
2425 my $t1 = Time::HiRes::time;
2426 my $data = $process->(\@data);
2427 my $t2 = Time::HiRes::time;
2428
2429 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431 db_put cache => "$id/data", $data;
2432 db_put cache => "$id/md5" , $md5;
2433 db_put cache => "$id/meta", $meta;
2434
2435 return $data;
2436 }
2437
2438 db_get cache => "$id/data"
2439}
2440
2441=item fork_call { }, $args
2442
2443Executes the given code block with the given arguments in a seperate
2444process, returning the results. Everything must be serialisable with
2445Coro::Storable. May, of course, block. Note that the executed sub may
2446never block itself or use any form of Event handling.
2447
2448=cut
2449
2450sub fork_call(&@) {
2451 my ($cb, @args) = @_;
2452
2453# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454# or die "socketpair: $!";
2455 pipe my $fh1, my $fh2
2456 or die "pipe: $!";
2457
2458 if (my $pid = fork) {
2459 close $fh2;
2460
2461 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462 $res = Coro::Storable::thaw $res;
2463
2464 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466 die $$res unless "ARRAY" eq ref $res;
2467
2468 return wantarray ? @$res : $res->[-1];
2469 } else {
2470 reset_signals;
2471 local $SIG{__WARN__};
2472 local $SIG{__DIE__};
2473 eval {
2474 close $fh1;
2475
2476 my @res = eval { $cb->(@args) };
2477 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478 };
2479
2480 warn $@ if $@;
2481 _exit 0;
2482 }
1985} 2483}
1986 2484
1987############################################################################# 2485#############################################################################
1988# the server's main() 2486# the server's init and main functions
2487
2488sub load_facedata($) {
2489 my ($path) = @_;
2490
2491 warn "loading facedata from $path\n";
2492
2493 my $facedata;
2494 0 < aio_load $path, $facedata
2495 or die "$path: $!";
2496
2497 $facedata = Coro::Storable::thaw $facedata;
2498
2499 $facedata->{version} == 2
2500 or cf::cleanup "$path: version mismatch, cannot proceed.";
2501
2502 {
2503 my $faces = $facedata->{faceinfo};
2504
2505 while (my ($face, $info) = each %$faces) {
2506 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510 Coro::cede;
2511 }
2512
2513 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth};
2515 my $idx = cf::face::find $face
2516 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) {
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2519 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 }
2522 Coro::cede;
2523 }
2524 }
2525
2526 {
2527 my $anims = $facedata->{animinfo};
2528
2529 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede;
2532 }
2533
2534 cf::anim::invalidate_all; # d'oh
2535 }
2536
2537 1
2538}
2539
2540sub reload_regions {
2541 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n";
2543}
2544
2545sub reload_facedata {
2546 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n";
2548}
2549
2550sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n";
2553}
2554
2555sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n";
2558}
2559
2560sub reload_resources {
2561 warn "reloading resource files...\n";
2562
2563 reload_regions;
2564 reload_facedata;
2565 reload_archetypes;
2566 reload_treasures;
2567
2568 warn "finished reloading resource files\n";
2569}
2570
2571sub init {
2572 reload_resources;
2573}
1989 2574
1990sub cfg_load { 2575sub cfg_load {
1991 open my $fh, "<:utf8", cf::confdir . "/config" 2576 open my $fh, "<:utf8", "$CONFDIR/config"
1992 or return; 2577 or return;
1993 2578
1994 local $/; 2579 local $/;
1995 *CFG = YAML::Syck::Load <$fh>; 2580 *CFG = YAML::Syck::Load <$fh>;
1996 2581
1997 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2582 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1998 2583
2584 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2585 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2586
1999 if (exists $CFG{mlockall}) { 2587 if (exists $CFG{mlockall}) {
2000 eval { 2588 eval {
2001 $CFG{mlockall} ? &mlockall : &munlockall 2589 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2002 and die "WARNING: m(un)lockall failed: $!\n"; 2590 and die "WARNING: m(un)lockall failed: $!\n";
2003 }; 2591 };
2004 warn $@ if $@; 2592 warn $@ if $@;
2005 } 2593 }
2006} 2594}
2007 2595
2008sub main { 2596sub main {
2009 # we must not ever block the main coroutine 2597 # we must not ever block the main coroutine
2010 local $Coro::idle = sub { 2598 local $Coro::idle = sub {
2011 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2599 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2012 (Coro::unblock_sub { 2600 (async {
2013 Event::one_event; 2601 Event::one_event;
2014 })->(); 2602 })->prio (Coro::PRIO_MAX);
2015 }; 2603 };
2016 2604
2017 cfg_load; 2605 cfg_load;
2018 db_load; 2606 db_init;
2019 load_extensions; 2607 load_extensions;
2608
2609 $TICK_WATCHER->start;
2020 Event::loop; 2610 Event::loop;
2021} 2611}
2022 2612
2023############################################################################# 2613#############################################################################
2024# initialisation 2614# initialisation and cleanup
2025 2615
2616# install some emergency cleanup handlers
2617BEGIN {
2618 for my $signal (qw(INT HUP TERM)) {
2619 Event->signal (
2620 reentrant => 0,
2621 data => WF_AUTOCANCEL,
2622 signal => $signal,
2623 prio => 0,
2624 cb => sub {
2625 cf::cleanup "SIG$signal";
2626 },
2627 );
2628 }
2629}
2630
2631sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop;
2633
2634 warn "enter emergency perl save\n";
2635
2636 cf::sync_job {
2637 # use a peculiar iteration method to avoid tripping on perl
2638 # refcount bugs in for. also avoids problems with players
2639 # and maps saved/destroyed asynchronously.
2640 warn "begin emergency player save\n";
2641 for my $login (keys %cf::PLAYER) {
2642 my $pl = $cf::PLAYER{$login} or next;
2643 $pl->valid or next;
2644 $pl->save;
2645 }
2646 warn "end emergency player save\n";
2647
2648 warn "begin emergency map save\n";
2649 for my $path (keys %cf::MAP) {
2650 my $map = $cf::MAP{$path} or next;
2651 $map->valid or next;
2652 $map->save;
2653 }
2654 warn "end emergency map save\n";
2655
2656 warn "begin emergency database checkpoint\n";
2657 BDB::db_env_txn_checkpoint $DB_ENV;
2658 warn "end emergency database checkpoint\n";
2659 };
2660
2661 warn "leave emergency perl save\n";
2662}
2663
2664sub post_cleanup {
2665 my ($make_core) = @_;
2666
2667 warn Carp::longmess "post_cleanup backtrace"
2668 if $make_core;
2669}
2670
2026sub reload() { 2671sub do_reload_perl() {
2027 # can/must only be called in main 2672 # can/must only be called in main
2028 if ($Coro::current != $Coro::main) { 2673 if ($Coro::current != $Coro::main) {
2029 warn "can only reload from main coroutine\n"; 2674 warn "can only reload from main coroutine";
2030 return; 2675 return;
2031 } 2676 }
2032 2677
2033 warn "reloading..."; 2678 warn "reloading...";
2034 2679
2035 local $FREEZE = 1; 2680 warn "entering sync_job";
2681
2682 cf::sync_job {
2683 cf::write_runtime; # external watchdog should not bark
2036 cf::emergency_save; 2684 cf::emergency_save;
2685 cf::write_runtime; # external watchdog should not bark
2037 2686
2038 eval { 2687 warn "syncing database to disk";
2688 BDB::db_env_txn_checkpoint $DB_ENV;
2689
2039 # if anything goes wrong in here, we should simply crash as we already saved 2690 # if anything goes wrong in here, we should simply crash as we already saved
2040 2691
2041 # cancel all watchers 2692 warn "cancelling all WF_AUTOCANCEL watchers";
2042 for (Event::all_watchers) { 2693 for (Event::all_watchers) {
2043 $_->cancel if $_->data & WF_AUTOCANCEL; 2694 $_->cancel if $_->data & WF_AUTOCANCEL;
2044 } 2695 }
2045 2696
2697 warn "flushing outstanding aio requests";
2698 for (;;) {
2699 BDB::flush;
2700 IO::AIO::flush;
2701 Coro::cede;
2702 last unless IO::AIO::nreqs || BDB::nreqs;
2703 warn "iterate...";
2704 }
2705
2706 ++$RELOAD;
2707
2046 # cancel all extension coros 2708 warn "cancelling all extension coros";
2047 $_->cancel for values %EXT_CORO; 2709 $_->cancel for values %EXT_CORO;
2048 %EXT_CORO = (); 2710 %EXT_CORO = ();
2049 2711
2050 # unload all extensions 2712 warn "removing commands";
2051 for (@exts) { 2713 %COMMAND = ();
2714
2715 warn "removing ext commands";
2716 %EXTCMD = ();
2717
2718 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) {
2052 warn "unloading <$_>"; 2720 warn "... unloading $pkg";
2053 unload_extension $_; 2721
2722 if (my $cb = $pkg->can ("unload")) {
2723 eval {
2724 $cb->($pkg);
2725 1
2726 } or warn "$pkg unloaded, but with errors: $@";
2054 } 2727 }
2055 2728
2729 warn "... nuking $pkg";
2730 Symbol::delete_package $pkg;
2731 }
2732
2056 # unload all modules loaded from $LIBDIR 2733 warn "unloading all perl modules loaded from $LIBDIR";
2057 while (my ($k, $v) = each %INC) { 2734 while (my ($k, $v) = each %INC) {
2058 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2735 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2059 2736
2060 warn "removing <$k>"; 2737 warn "... unloading $k";
2061 delete $INC{$k}; 2738 delete $INC{$k};
2062 2739
2063 $k =~ s/\.pm$//; 2740 $k =~ s/\.pm$//;
2064 $k =~ s/\//::/g; 2741 $k =~ s/\//::/g;
2065 2742
2068 } 2745 }
2069 2746
2070 Symbol::delete_package $k; 2747 Symbol::delete_package $k;
2071 } 2748 }
2072 2749
2073 # sync database to disk
2074 cf::db_sync;
2075 IO::AIO::flush;
2076
2077 # get rid of safe::, as good as possible 2750 warn "getting rid of safe::, as good as possible";
2078 Symbol::delete_package "safe::$_" 2751 Symbol::delete_package "safe::$_"
2079 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2752 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2080 2753
2081 # remove register_script_function callbacks
2082 # TODO
2083
2084 # unload cf.pm "a bit" 2754 warn "unloading cf.pm \"a bit\"";
2085 delete $INC{"cf.pm"}; 2755 delete $INC{"cf.pm"};
2756 delete $INC{"cf/pod.pm"};
2086 2757
2087 # don't, removes xs symbols, too, 2758 # don't, removes xs symbols, too,
2088 # and global variables created in xs 2759 # and global variables created in xs
2089 #Symbol::delete_package __PACKAGE__; 2760 #Symbol::delete_package __PACKAGE__;
2090 2761
2091 # reload cf.pm 2762 warn "unload completed, starting to reload now";
2763
2092 warn "reloading cf.pm"; 2764 warn "reloading cf.pm";
2093 require cf; 2765 require cf;
2094 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2766 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2095 2767
2096 # load config and database again 2768 warn "loading config and database again";
2097 cf::cfg_load; 2769 cf::cfg_load;
2098 cf::db_load;
2099 2770
2100 # load extensions
2101 warn "load extensions"; 2771 warn "loading extensions";
2102 cf::load_extensions; 2772 cf::load_extensions;
2103 2773
2104 # reattach attachments to objects 2774 warn "reattaching attachments to objects/players";
2105 warn "reattach"; 2775 _global_reattach; # objects, sockets
2106 _global_reattach; 2776 warn "reattaching attachments to maps";
2107 }; 2777 reattach $_ for values %MAP;
2778 warn "reattaching attachments to players";
2779 reattach $_ for values %PLAYER;
2108 2780
2109 if ($@) { 2781 warn "leaving sync_job";
2782
2783 1
2784 } or do {
2110 warn $@; 2785 warn $@;
2111 warn "error while reloading, exiting."; 2786 warn "error while reloading, exiting.";
2112 exit 1; 2787 exit 1;
2113 } 2788 };
2114 2789
2115 warn "reloaded successfully"; 2790 warn "reloaded";
2116}; 2791};
2117 2792
2118############################################################################# 2793our $RELOAD_WATCHER; # used only during reload
2119 2794
2120unless ($LINK_MAP) { 2795sub reload_perl() {
2121 $LINK_MAP = cf::map::new; 2796 # doing reload synchronously and two reloads happen back-to-back,
2797 # coro crashes during coro_state_free->destroy here.
2122 2798
2123 $LINK_MAP->width (41); 2799 $RELOAD_WATCHER ||= Event->timer (
2124 $LINK_MAP->height (41); 2800 reentrant => 0,
2125 $LINK_MAP->alloc;
2126 $LINK_MAP->path ("{link}");
2127 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2128 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2129
2130 # dirty hack because... archetypes are not yet loaded
2131 Event->timer (
2132 after => 2, 2801 after => 0,
2802 data => WF_AUTOCANCEL,
2133 cb => sub { 2803 cb => sub {
2134 $_[0]->w->cancel; 2804 do_reload_perl;
2135 2805 undef $RELOAD_WATCHER;
2136 # provide some exits "home"
2137 my $exit = cf::object::new "exit";
2138
2139 $exit->slaying ($EMERGENCY_POSITION->[0]);
2140 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2141 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2142
2143 $LINK_MAP->insert ($exit->clone, 19, 19);
2144 $LINK_MAP->insert ($exit->clone, 19, 20);
2145 $LINK_MAP->insert ($exit->clone, 19, 21);
2146 $LINK_MAP->insert ($exit->clone, 20, 19);
2147 $LINK_MAP->insert ($exit->clone, 20, 21);
2148 $LINK_MAP->insert ($exit->clone, 21, 19);
2149 $LINK_MAP->insert ($exit->clone, 21, 20);
2150 $LINK_MAP->insert ($exit->clone, 21, 21);
2151
2152 $exit->destroy;
2153 }); 2806 },
2154 2807 );
2155 $LINK_MAP->{deny_save} = 1;
2156 $LINK_MAP->{deny_reset} = 1;
2157
2158 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2159} 2808}
2160
2161register "<global>", __PACKAGE__;
2162 2809
2163register_command "reload" => sub { 2810register_command "reload" => sub {
2164 my ($who, $arg) = @_; 2811 my ($who, $arg) = @_;
2165 2812
2166 if ($who->flag (FLAG_WIZ)) { 2813 if ($who->flag (FLAG_WIZ)) {
2167 $who->message ("start of reload.");
2168 reload;
2169 $who->message ("end of reload."); 2814 $who->message ("reloading server.");
2815 async { reload_perl };
2170 } 2816 }
2171}; 2817};
2172 2818
2173unshift @INC, $LIBDIR; 2819unshift @INC, $LIBDIR;
2174 2820
2821my $bug_warning = 0;
2822
2823our @WAIT_FOR_TICK;
2824our @WAIT_FOR_TICK_BEGIN;
2825
2826sub wait_for_tick {
2827 return unless $TICK_WATCHER->is_active;
2828 return if $Coro::current == $Coro::main;
2829
2830 my $signal = new Coro::Signal;
2831 push @WAIT_FOR_TICK, $signal;
2832 $signal->wait;
2833}
2834
2835sub wait_for_tick_begin {
2836 return unless $TICK_WATCHER->is_active;
2837 return if $Coro::current == $Coro::main;
2838
2839 my $signal = new Coro::Signal;
2840 push @WAIT_FOR_TICK_BEGIN, $signal;
2841 $signal->wait;
2842}
2843
2844 my $min = 1e6;#d#
2845 my $avg = 10;
2175$TICK_WATCHER = Event->timer ( 2846$TICK_WATCHER = Event->timer (
2176 reentrant => 0, 2847 reentrant => 0,
2848 parked => 1,
2177 prio => 0, 2849 prio => 0,
2178 at => $NEXT_TICK || $TICK, 2850 at => $NEXT_TICK || $TICK,
2179 data => WF_AUTOCANCEL, 2851 data => WF_AUTOCANCEL,
2180 cb => sub { 2852 cb => sub {
2181 unless ($FREEZE) { 2853 if ($Coro::current != $Coro::main) {
2854 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2855 unless ++$bug_warning > 10;
2856 return;
2857 }
2858
2859 $NOW = $tick_start = Event::time;
2860
2182 cf::server_tick; # one server iteration 2861 cf::server_tick; # one server iteration
2183 $RUNTIME += $TICK; 2862
2863 0 && sync_job {#d#
2864 for(1..10) {
2865 my $t = Event::time;
2866 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2867 or die;
2868
2869 $map->width (50);
2870 $map->height (50);
2871 $map->alloc;
2872 $map->_load_objects ("/tmp/x.map", 1);
2873 my $t = Event::time - $t;
2874
2875 #next unless $t < 0.0013;#d#
2876 if ($t < $min) {
2877 $min = $t;
2878 }
2879 $avg = $avg * 0.99 + $t * 0.01;
2880 }
2881 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2882 exit 0;
2883 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2184 } 2884 };
2185 2885
2886 $RUNTIME += $TICK;
2186 $NEXT_TICK += $TICK; 2887 $NEXT_TICK += $TICK;
2187 2888
2889 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2890 $NEXT_RUNTIME_WRITE = $NOW + 10;
2891 Coro::async_pool {
2892 write_runtime
2893 or warn "ERROR: unable to write runtime file: $!";
2894 };
2895 }
2896
2897# my $AFTER = Event::time;
2898# warn $AFTER - $NOW;#d#
2899
2900 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2901 $sig->send;
2902 }
2903 while (my $sig = shift @WAIT_FOR_TICK) {
2904 $sig->send;
2905 }
2906
2907 $NOW = Event::time;
2908
2188 # if we are delayed by four ticks or more, skip them all 2909 # if we are delayed by four ticks or more, skip them all
2189 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2910 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2190 2911
2191 $TICK_WATCHER->at ($NEXT_TICK); 2912 $TICK_WATCHER->at ($NEXT_TICK);
2192 $TICK_WATCHER->start; 2913 $TICK_WATCHER->start;
2914
2915 $LOAD = ($NOW - $tick_start) / $TICK;
2916 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2917
2918 _post_tick;
2919
2920
2193 }, 2921 },
2194); 2922);
2195 2923
2924{
2196IO::AIO::max_poll_time $TICK * 0.2; 2925 BDB::max_poll_time $TICK * 0.1;
2197 2926 $BDB_POLL_WATCHER = Event->io (
2198Event->io ( 2927 reentrant => 0,
2199 fd => IO::AIO::poll_fileno, 2928 fd => BDB::poll_fileno,
2200 poll => 'r', 2929 poll => 'r',
2201 prio => 5, 2930 prio => 0,
2202 data => WF_AUTOCANCEL,
2203 cb => \&IO::AIO::poll_cb,
2204);
2205
2206Event->timer (
2207 data => WF_AUTOCANCEL, 2931 data => WF_AUTOCANCEL,
2208 after => 0, 2932 cb => \&BDB::poll_cb,
2209 interval => 10, 2933 );
2210 cb => sub { 2934 BDB::min_parallel 8;
2211 (Coro::unblock_sub { 2935
2212 write_runtime 2936 BDB::set_sync_prepare {
2213 or warn "ERROR: unable to write runtime file: $!"; 2937 my $status;
2938 my $current = $Coro::current;
2939 (
2940 sub {
2941 $status = $!;
2942 $current->ready; undef $current;
2943 },
2944 sub {
2945 Coro::schedule while defined $current;
2946 $! = $status;
2947 },
2948 )
2949 };
2950
2951 unless ($DB_ENV) {
2952 $DB_ENV = BDB::db_env_create;
2953
2954 cf::sync_job {
2955 eval {
2956 BDB::db_env_open
2957 $DB_ENV,
2958 $BDBDIR,
2959 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2960 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2961 0666;
2962
2963 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2964
2965 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2966 $DB_ENV->set_lk_detect;
2967 };
2968
2969 cf::cleanup "db_env_open(db): $@" if $@;
2214 })->(); 2970 };
2215 }, 2971 }
2216); 2972}
2973
2974{
2975 IO::AIO::min_parallel 8;
2976
2977 undef $Coro::AIO::WATCHER;
2978 IO::AIO::max_poll_time $TICK * 0.1;
2979 $AIO_POLL_WATCHER = Event->io (
2980 reentrant => 0,
2981 data => WF_AUTOCANCEL,
2982 fd => IO::AIO::poll_fileno,
2983 poll => 'r',
2984 prio => 6,
2985 cb => \&IO::AIO::poll_cb,
2986 );
2987}
2988
2989my $_log_backtrace;
2990
2991sub _log_backtrace {
2992 my ($msg, @addr) = @_;
2993
2994 $msg =~ s/\n//;
2995
2996 # limit the # of concurrent backtraces
2997 if ($_log_backtrace < 2) {
2998 ++$_log_backtrace;
2999 async {
3000 my @bt = fork_call {
3001 @addr = map { sprintf "%x", $_ } @addr;
3002 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3003 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3004 or die "addr2line: $!";
3005
3006 my @funcs;
3007 my @res = <$fh>;
3008 chomp for @res;
3009 while (@res) {
3010 my ($func, $line) = splice @res, 0, 2, ();
3011 push @funcs, "[$func] $line";
3012 }
3013
3014 @funcs
3015 };
3016
3017 LOG llevInfo, "[ABT] $msg\n";
3018 LOG llevInfo, "[ABT] $_\n" for @bt;
3019 --$_log_backtrace;
3020 };
3021 } else {
3022 LOG llevInfo, "[ABT] $msg\n";
3023 LOG llevInfo, "[ABT] [suppressed]\n";
3024 }
3025}
3026
3027# load additional modules
3028use cf::pod;
2217 3029
2218END { cf::emergency_save } 3030END { cf::emergency_save }
2219 3031
22201 30321
2221 3033

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines