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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.279 by root, Mon Jun 11 22:16:53 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";
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";
892 or return; 873 or return;
893 $av = eval { (Storable::thaw $av)->{objs} }; 874 $av = eval { (Storable::thaw $av)->{objs} };
894 } 875 }
895 876
896 warn sprintf "loading %s (%d)\n", 877 warn sprintf "loading %s (%d)\n",
897 $filename, length $data, scalar @{$av || []};#d# 878 $filename, length $data, scalar @{$av || []};
898 return ($data, $av); 879 return ($data, $av);
899} 880}
900 881
901############################################################################# 882#############################################################################
902# command handling &c 883# command handling &c
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_extensions {
949 cf::sync_job {
950 my %todo;
951
952 for my $path (<$LIBDIR/*.ext>) {
953 next unless -r $path;
954
955 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
956 my $base = $1;
957 my $pkg = $1;
958 $pkg =~ s/[^[:word:]]/_/g;
959 $pkg = "ext::$pkg";
960
961 open my $fh, "<:utf8", $path
962 or die "$path: $!";
963
964 my $source = do { local $/; <$fh> };
965
966 my %ext = (
967 path => $path,
968 base => $base,
969 pkg => $pkg,
970 );
971
972 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
973 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
974
975 $ext{source} =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . $source
979 . "\n};\n1";
980
981 $todo{$base} = \%ext;
982 }
983
984 my %done;
985 while (%todo) {
986 my $progress;
987
988 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $v->{meta}{depends}) {
990 goto skip
991 unless exists $done{$_};
992 }
993
994 warn "... loading '$k' into '$v->{pkg}'\n";
995
996 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n"
998 : "$v->{base}: extension inactive.\n";
999
1000 if (exists $v->{meta}{mandatory}) {
1001 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1;
1004 }
1005
1006 warn $msg;
1007 }
1008
1009 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg};
1011 $progress = 1;
1012 }
1013
1014 skip:
1015 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1016 unless $progress;
1017 }
1018 };
1019}
1020
1021#############################################################################
1022
1023=head2 CORE EXTENSIONS
1024
1025Functions and methods that extend core crossfire objects.
1026
1027=cut
1028
1029package cf::player;
1030
1031use Coro::AIO;
1032
1033=head3 cf::player
1034
1035=over 4
1036
1037=item cf::player::find $login
1038
1039Returns the given player object, loading it if necessary (might block).
1040
1041=cut
1042
1043sub playerdir($) {
1044 "$PLAYERDIR/"
1045 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1046}
1047
1048sub path($) {
1049 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1050
1051 (playerdir $login) . "/playerdata"
1052}
1053
1054sub find_active($) {
1055 $cf::PLAYER{$_[0]}
1056 and $cf::PLAYER{$_[0]}->active
1057 and $cf::PLAYER{$_[0]}
1058}
1059
1060sub exists($) {
1061 my ($login) = @_;
1062
1063 $cf::PLAYER{$login}
1064 or cf::sync_job { !aio_stat path $login }
1065}
1066
1067sub find($) {
1068 return $cf::PLAYER{$_[0]} || do {
1069 my $login = $_[0];
1070
1071 my $guard = cf::lock_acquire "user_find:$login";
1072
1073 $cf::PLAYER{$_[0]} || do {
1074 # rename old playerfiles to new ones
1075 #TODO: remove when no longer required
1076 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1077 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1078 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1079 aio_unlink +(playerdir $login) . "/$login.pl";
1080
1081 my $pl = load_pl path $login
1082 or return;
1083 $cf::PLAYER{$login} = $pl
1084 }
1085 }
1086}
1087
1088sub save($) {
1089 my ($pl) = @_;
1090
1091 return if $pl->{deny_save};
1092
1093 my $path = path $pl;
1094 my $guard = cf::lock_acquire "user_save:$path";
1095
1096 return if $pl->{deny_save};
1097
1098 aio_mkdir playerdir $pl, 0770;
1099 $pl->{last_save} = $cf::RUNTIME;
1100
1101 $pl->save_pl ($path);
1102 Coro::cede;
1103}
1104
1105sub new($) {
1106 my ($login) = @_;
1107
1108 my $self = create;
1109
1110 $self->ob->name ($login);
1111 $self->{deny_save} = 1;
1112
1113 $cf::PLAYER{$login} = $self;
1114
1115 $self
1116}
1117
1118=item $pl->quit_character
1119
1120Nukes the player without looking back. If logged in, the connection will
1121be destroyed. May block for a long time.
1122
1123=cut
1124
1125sub quit_character {
1126 my ($pl) = @_;
1127
1128 my $name = $pl->ob->name;
1129
1130 $pl->{deny_save} = 1;
1131 $pl->password ("*"); # this should lock out the player until we nuked the dir
1132
1133 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1134 $pl->deactivate;
1135 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1136 $pl->ns->destroy if $pl->ns;
1137
1138 my $path = playerdir $pl;
1139 my $temp = "$path~$cf::RUNTIME~deleting~";
1140 aio_rename $path, $temp;
1141 delete $cf::PLAYER{$pl->ob->name};
1142 $pl->destroy;
1143
1144 my $prefix = qr<^~\Q$name\E/>;
1145
1146 # nuke player maps
1147 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1148
1149 IO::AIO::aio_rmtree $temp;
1150}
1151
1152=item $pl->kick
1153
1154Kicks a player out of the game. This destroys the connection.
1155
1156=cut
1157
1158sub kick {
1159 my ($pl, $kicker) = @_;
1160
1161 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1162 $pl->killer ("kicked");
1163 $pl->ns->destroy;
1164}
1165
1166=item cf::player::list_logins
1167
1168Returns am arrayref of all valid playernames in the system, can take a
1169while and may block, so not sync_job-capable, ever.
1170
1171=cut
1172
1173sub list_logins {
1174 my $dirs = aio_readdir $PLAYERDIR
1175 or return [];
1176
1177 my @logins;
1178
1179 for my $login (@$dirs) {
1180 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1181 aio_read $fh, 0, 512, my $buf, 0 or next;
1182 $buf !~ /^password -------------$/m or next; # official not-valid tag
1183
1184 utf8::decode $login;
1185 push @logins, $login;
1186 }
1187
1188 \@logins
1189}
1190
1191=item $player->maps
1192
1193Returns an arrayref of map paths that are private for this
1194player. May block.
1195
1196=cut
1197
1198sub maps($) {
1199 my ($pl) = @_;
1200
1201 $pl = ref $pl ? $pl->ob->name : $pl;
1202
1203 my $files = aio_readdir playerdir $pl
1204 or return;
1205
1206 my @paths;
1207
1208 for (@$files) {
1209 utf8::decode $_;
1210 next if /\.(?:pl|pst)$/;
1211 next unless /^$PATH_SEP/o;
1212
1213 push @paths, cf::map::normalise "~$pl/$_";
1214 }
1215
1216 \@paths
1217}
1218
1219=item $player->ext_reply ($msgid, %msg)
1220
1221Sends an ext reply to the player.
1222
1223=cut
1224
1225sub ext_reply($$%) {
1226 my ($self, $id, %msg) = @_;
1227
1228 $msg{msgid} = $id;
1229
1230 $self->send ("ext " . cf::to_json \%msg);
1231}
1232
1233=item $player->ext_event ($type, %msg)
1234
1235Sends an ext event to the client.
1236
1237=cut
1238
1239sub ext_event($$%) {
1240 my ($self, $type, %msg) = @_;
1241
1242 $self->ns->ext_event ($type, %msg);
1243}
1244
1245=head3 cf::region
1246
1247=over 4
1248
1249=cut
1250
1251package cf::region;
1252
1253=item cf::region::find_by_path $path
1254
1255Tries to decuce the probable region for a map knowing only its path.
1256
1257=cut
1258
1259sub find_by_path($) {
977 my ($path) = @_; 1260 my ($path) = @_;
978 1261
979 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1262 my ($match, $specificity);
980 my $base = $1;
981 my $pkg = $1;
982 $pkg =~ s/[^[:word:]]/_/g;
983 $pkg = "ext::$pkg";
984 1263
985 warn "loading '$path' into '$pkg'\n"; 1264 for my $region (list) {
986 1265 if ($region->match && $path =~ $region->match) {
987 open my $fh, "<:utf8", $path 1266 ($match, $specificity) = ($region, $region->specificity)
988 or die "$path: $!"; 1267 if $region->specificity > $specificity;
989 1268 }
990 my $source =
991 "package $pkg; use strict; use utf8;\n"
992 . "#line 1 \"$path\"\n{\n"
993 . (do { local $/; <$fh> })
994 . "\n};\n1";
995
996 eval $source
997 or die $@ ? "$path: $@\n"
998 : "extension disabled.\n";
999
1000 push @exts, $pkg;
1001 $ext_pkg{$base} = $pkg;
1002
1003# no strict 'refs';
1004# @{"$pkg\::ISA"} = ext::;
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# } 1269 }
1019 1270
1020 # remove commands 1271 $match
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}
1045
1046sub load_extensions {
1047 for my $ext (<$LIBDIR/*.ext>) {
1048 next unless -r $ext;
1049 eval {
1050 load_extension $ext;
1051 1
1052 } or warn "$ext not loaded: $@";
1053 }
1054}
1055
1056#############################################################################
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
1094=head2 CORE EXTENSIONS
1095
1096Functions and methods that extend core crossfire objects.
1097
1098=head3 cf::player
1099
1100=over 4
1101
1102=item cf::player::exists $login
1103
1104Returns true when the given account exists.
1105
1106=cut
1107
1108sub cf::player::exists($) {
1109 cf::player::find $_[0]
1110 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1111}
1112
1113=item $player->ext_reply ($msgid, $msgtype, %msg)
1114
1115Sends an ext reply to the player.
1116
1117=cut
1118
1119sub cf::player::ext_reply($$$%) {
1120 my ($self, $id, %msg) = @_;
1121
1122 $msg{msgid} = $id;
1123
1124 $self->send ("ext " . to_json \%msg);
1125} 1272}
1126 1273
1127=back 1274=back
1128
1129 1275
1130=head3 cf::map 1276=head3 cf::map
1131 1277
1132=over 4 1278=over 4
1133 1279
1136package cf::map; 1282package cf::map;
1137 1283
1138use Fcntl; 1284use Fcntl;
1139use Coro::AIO; 1285use Coro::AIO;
1140 1286
1287use overload
1288 '""' => \&as_string,
1289 fallback => 1;
1290
1141our $MAX_RESET = 7200; 1291our $MAX_RESET = 3600;
1142our $DEFAULT_RESET = 3600; 1292our $DEFAULT_RESET = 3000;
1143 1293
1144sub generate_random_map { 1294sub generate_random_map {
1145 my ($path, $rmp) = @_; 1295 my ($self, $rmp) = @_;
1146
1147 # mit "rum" bekleckern, nicht 1296 # mit "rum" bekleckern, nicht
1148 cf::map::_create_random_map 1297 $self->_create_random_map (
1149 $path,
1150 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1298 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1151 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1299 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1152 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1300 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1153 $rmp->{exit_on_final_map}, 1301 $rmp->{exit_on_final_map},
1154 $rmp->{xsize}, $rmp->{ysize}, 1302 $rmp->{xsize}, $rmp->{ysize},
1155 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1303 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1156 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1304 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1157 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1305 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1158 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1306 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1159 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1307 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1160 (cf::region::find $rmp->{region}) 1308 (cf::region::find $rmp->{region}), $rmp->{custom}
1309 )
1310}
1311
1312=item cf::map->register ($regex, $prio)
1313
1314Register a handler for the map path matching the given regex at the
1315givne priority (higher is better, built-in handlers have priority 0, the
1316default).
1317
1318=cut
1319
1320sub register {
1321 my (undef, $regex, $prio) = @_;
1322 my $pkg = caller;
1323
1324 no strict;
1325 push @{"$pkg\::ISA"}, __PACKAGE__;
1326
1327 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1328}
1329
1330# also paths starting with '/'
1331$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1332
1333sub thawer_merge {
1334 my ($self, $merge) = @_;
1335
1336 # we have to keep some variables in memory intact
1337 local $self->{path};
1338 local $self->{load_path};
1339
1340 $self->SUPER::thawer_merge ($merge);
1341}
1342
1343sub normalise {
1344 my ($path, $base) = @_;
1345
1346 $path = "$path"; # make sure its a string
1347
1348 $path =~ s/\.map$//;
1349
1350 # map plan:
1351 #
1352 # /! non-realised random map exit (special hack!)
1353 # {... are special paths that are not being touched
1354 # ?xxx/... are special absolute paths
1355 # ?random/... random maps
1356 # /... normal maps
1357 # ~user/... per-player map of a specific user
1358
1359 $path =~ s/$PATH_SEP/\//go;
1360
1361 # treat it as relative path if it starts with
1362 # something that looks reasonable
1363 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1364 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1365
1366 $base =~ s{[^/]+/?$}{};
1367 $path = "$base/$path";
1368 }
1369
1370 for ($path) {
1371 redo if s{//}{/};
1372 redo if s{/\.?/}{/};
1373 redo if s{/[^/]+/\.\./}{/};
1374 }
1375
1376 $path
1377}
1378
1379sub new_from_path {
1380 my (undef, $path, $base) = @_;
1381
1382 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1383
1384 $path = normalise $path, $base;
1385
1386 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1387 if ($path =~ $EXT_MAP{$pkg}[1]) {
1388 my $self = bless cf::map::new, $pkg;
1389 $self->{path} = $path; $self->path ($path);
1390 $self->init; # pass $1 etc.
1391 return $self;
1392 }
1393 }
1394
1395 Carp::carp "unable to resolve path '$path' (base '$base').";
1396 ()
1397}
1398
1399sub init {
1400 my ($self) = @_;
1401
1402 $self
1403}
1404
1405sub as_string {
1406 my ($self) = @_;
1407
1408 "$self->{path}"
1409}
1410
1411# the displayed name, this is a one way mapping
1412sub visible_name {
1413 &as_string
1414}
1415
1416# the original (read-only) location
1417sub load_path {
1418 my ($self) = @_;
1419
1420 "$MAPDIR/$self->{path}.map"
1421}
1422
1423# the temporary/swap location
1424sub save_path {
1425 my ($self) = @_;
1426
1427 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1428 "$TMPDIR/$path.map"
1429}
1430
1431# the unique path, undef == no special unique path
1432sub uniq_path {
1433 my ($self) = @_;
1434
1435 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1436 "$UNIQUEDIR/$path"
1161} 1437}
1162 1438
1163# and all this just because we cannot iterate over 1439# and all this just because we cannot iterate over
1164# all maps in C++... 1440# all maps in C++...
1165sub change_all_map_light { 1441sub change_all_map_light {
1167 1443
1168 $_->change_map_light ($change) 1444 $_->change_map_light ($change)
1169 for grep $_->outdoor, values %cf::MAP; 1445 for grep $_->outdoor, values %cf::MAP;
1170} 1446}
1171 1447
1448sub decay_objects {
1449 my ($self) = @_;
1450
1451 return if $self->{deny_reset};
1452
1453 $self->do_decay_objects;
1454}
1455
1456sub unlink_save {
1457 my ($self) = @_;
1458
1459 utf8::encode (my $save = $self->save_path);
1460 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1461 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1462}
1463
1172sub try_load_header($) { 1464sub load_header_from($) {
1173 my ($path) = @_; 1465 my ($self, $path) = @_;
1174 1466
1175 utf8::encode $path; 1467 utf8::encode $path;
1176 aio_open $path, O_RDONLY, 0 1468 #aio_open $path, O_RDONLY, 0
1469 # or return;
1470
1471 $self->_load_header ($path)
1177 or return; 1472 or return;
1178 1473
1179 my $map = cf::map::new 1474 $self->{load_path} = $path;
1475
1476 1
1477}
1478
1479sub load_header_orig {
1480 my ($self) = @_;
1481
1482 $self->load_header_from ($self->load_path)
1483}
1484
1485sub load_header_temp {
1486 my ($self) = @_;
1487
1488 $self->load_header_from ($self->save_path)
1489}
1490
1491sub prepare_temp {
1492 my ($self) = @_;
1493
1494 $self->last_access ((delete $self->{last_access})
1495 || $cf::RUNTIME); #d#
1496 # safety
1497 $self->{instantiate_time} = $cf::RUNTIME
1498 if $self->{instantiate_time} > $cf::RUNTIME;
1499}
1500
1501sub prepare_orig {
1502 my ($self) = @_;
1503
1504 $self->{load_original} = 1;
1505 $self->{instantiate_time} = $cf::RUNTIME;
1506 $self->last_access ($cf::RUNTIME);
1507 $self->instantiate;
1508}
1509
1510sub load_header {
1511 my ($self) = @_;
1512
1513 if ($self->load_header_temp) {
1514 $self->prepare_temp;
1515 } else {
1516 $self->load_header_orig
1180 or return; 1517 or return;
1518 $self->prepare_orig;
1519 }
1181 1520
1182 $map->load_header ($path) 1521 $self->{deny_reset} = 1
1183 or return; 1522 if $self->no_reset;
1184 1523
1185 $map->{load_path} = $path; 1524 $self->default_region (cf::region::find_by_path $self->{path})
1525 unless $self->default_region;
1186 1526
1187 $map 1527 1
1188} 1528}
1189 1529
1190sub find_map; 1530sub find;
1191sub find_map { 1531sub find {
1192 my ($path, $origin) = @_; 1532 my ($path, $origin) = @_;
1193 1533
1194 #warn "find_map<$path,$origin>\n";#d#
1195
1196 $path = new cf::path $path, $origin && $origin->path; 1534 $path = normalise $path, $origin && $origin->path;
1197 my $key = $path->as_string;
1198 1535
1199 cf::lock_wait "map_find:$key"; 1536 cf::lock_wait "map_find:$path";
1200 1537
1201 $cf::MAP{$key} || do { 1538 $cf::MAP{$path} || do {
1202 my $guard = cf::lock_acquire "map_find:$key"; 1539 my $guard = cf::lock_acquire "map_find:$path";
1203 1540 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 # safety
1209 $map->{instantiate_time} = $cf::RUNTIME
1210 if $map->{instantiate_time} > $cf::RUNTIME;
1211 } else {
1212 if (my $rmp = $path->random_map_params) {
1213 $map = generate_random_map $key, $rmp;
1214 } else {
1215 $map = try_load_header $path->load_path;
1216 }
1217
1218 $map or return; 1541 or return;
1219 1542
1220 $map->{load_original} = 1;
1221 $map->{instantiate_time} = $cf::RUNTIME;
1222 $map->instantiate;
1223
1224 # per-player maps become, after loading, normal maps
1225 $map->per_player (0) if $path->{user_rel};
1226 }
1227
1228 $map->path ($key);
1229 $map->{path} = $path;
1230 $map->{last_save} = $cf::RUNTIME; 1543 $map->{last_save} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME);
1232 1544
1233 if ($map->should_reset) { 1545 $map->load_header
1546 or return;
1547
1548 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1549 # doing this can freeze the server in a sync job, obviously
1550 #$cf::WAIT_FOR_TICK->wait;
1234 $map->reset; 1551 $map->reset;
1235 undef $guard; 1552 undef $guard;
1236 $map = find_map $path 1553 return find $path;
1237 or return;
1238 } 1554 }
1239 1555
1240 $cf::MAP{$key} = $map 1556 $cf::MAP{$path} = $map
1241 } 1557 }
1242} 1558}
1559
1560sub pre_load { }
1561sub post_load { }
1243 1562
1244sub load { 1563sub load {
1245 my ($self) = @_; 1564 my ($self) = @_;
1246 1565
1566 local $self->{deny_reset} = 1; # loading can take a long time
1567
1247 my $path = $self->{path}; 1568 my $path = $self->{path};
1569
1570 {
1248 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1571 my $guard = cf::lock_acquire "map_load:$path";
1249 1572
1250 return if $self->in_memory != cf::MAP_SWAPPED; 1573 return if $self->in_memory != cf::MAP_SWAPPED;
1251 1574
1252 $self->in_memory (cf::MAP_LOADING); 1575 $self->in_memory (cf::MAP_LOADING);
1253 1576
1254 $self->alloc; 1577 $self->alloc;
1578
1579 $self->pre_load;
1580 Coro::cede;
1581
1255 $self->load_objects ($self->{load_path}, 1) 1582 $self->_load_objects ($self->{load_path}, 1)
1256 or return; 1583 or return;
1257 1584
1258 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1585 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1259 if delete $self->{load_original}; 1586 if delete $self->{load_original};
1260 1587
1261 if (my $uniq = $path->uniq_path) { 1588 if (my $uniq = $self->uniq_path) {
1262 utf8::encode $uniq; 1589 utf8::encode $uniq;
1263 if (aio_open $uniq, O_RDONLY, 0) { 1590 if (aio_open $uniq, O_RDONLY, 0) {
1264 $self->clear_unique_items; 1591 $self->clear_unique_items;
1265 $self->load_objects ($uniq, 0); 1592 $self->_load_objects ($uniq, 0);
1266 } 1593 }
1267 } 1594 }
1268 1595
1596 Coro::cede;
1269 # now do the right thing for maps 1597 # now do the right thing for maps
1270 $self->link_multipart_objects; 1598 $self->link_multipart_objects;
1271
1272 if ($self->{path}->is_style_map) {
1273 $self->{deny_save} = 1;
1274 $self->{deny_reset} = 1;
1275 } else {
1276 $self->fix_auto_apply;
1277 $self->decay_objects;
1278 $self->update_buttons;
1279 $self->set_darkness_map;
1280 $self->difficulty ($self->estimate_difficulty) 1599 $self->difficulty ($self->estimate_difficulty)
1281 unless $self->difficulty; 1600 unless $self->difficulty;
1601 Coro::cede;
1602
1603 unless ($self->{deny_activate}) {
1604 $self->decay_objects;
1605 $self->fix_auto_apply;
1606 $self->update_buttons;
1607 Coro::cede;
1608 $self->set_darkness_map;
1609 Coro::cede;
1282 $self->activate; 1610 $self->activate;
1283 } 1611 }
1284 1612
1285 $self->in_memory (cf::MAP_IN_MEMORY); 1613 $self->in_memory (cf::MAP_IN_MEMORY);
1286} 1614 }
1287 1615
1288sub load_map_sync { 1616 $self->post_load;
1617}
1618
1619sub customise_for {
1620 my ($self, $ob) = @_;
1621
1622 return find "~" . $ob->name . "/" . $self->{path}
1623 if $self->per_player;
1624
1625# return find "?party/" . $ob->name . "/" . $self->{path}
1626# if $self->per_party;
1627
1628 $self
1629}
1630
1631# find and load all maps in the 3x3 area around a map
1632sub load_diag {
1633 my ($map) = @_;
1634
1635 my @diag; # diagonal neighbours
1636
1637 for (0 .. 3) {
1638 my $neigh = $map->tile_path ($_)
1639 or next;
1640 $neigh = find $neigh, $map
1641 or next;
1642 $neigh->load;
1643
1644 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1645 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1646 }
1647
1648 for (@diag) {
1649 my $neigh = find @$_
1650 or next;
1651 $neigh->load;
1652 }
1653}
1654
1655sub find_sync {
1289 my ($path, $origin) = @_; 1656 my ($path, $origin) = @_;
1290 1657
1291 #warn "load_map_sync<$path, $origin>\n";#d# 1658 cf::sync_job { find $path, $origin }
1659}
1292 1660
1293 cf::sync_job { 1661sub do_load_sync {
1294 my $map = cf::map::find_map $path, $origin 1662 my ($map) = @_;
1295 or return; 1663
1664 cf::sync_job { $map->load };
1665}
1666
1667our %MAP_PREFETCH;
1668our $MAP_PREFETCHER = undef;
1669
1670sub find_async {
1671 my ($path, $origin) = @_;
1672
1673 $path = normalise $path, $origin && $origin->{path};
1674
1675 if (my $map = $cf::MAP{$path}) {
1676 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1677 }
1678
1679 undef $MAP_PREFETCH{$path};
1680 $MAP_PREFETCHER ||= cf::async {
1681 while (%MAP_PREFETCH) {
1682 for my $path (keys %MAP_PREFETCH) {
1683 my $map = find $path
1684 or next;
1296 $map->load; 1685 $map->load;
1297 $map 1686
1687 delete $MAP_PREFETCH{$path};
1688 }
1689 }
1690 undef $MAP_PREFETCHER;
1298 } 1691 };
1692 $MAP_PREFETCHER->prio (6);
1693
1694 ()
1299} 1695}
1300 1696
1301sub save { 1697sub save {
1302 my ($self) = @_; 1698 my ($self) = @_;
1303 1699
1700 my $lock = cf::lock_acquire "map_data:" . $self->path;
1701
1304 $self->{last_save} = $cf::RUNTIME; 1702 $self->{last_save} = $cf::RUNTIME;
1305 1703
1306 return unless $self->dirty; 1704 return unless $self->dirty;
1307 1705
1308 my $save = $self->{path}->save_path; utf8::encode $save; 1706 my $save = $self->save_path; utf8::encode $save;
1309 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1707 my $uniq = $self->uniq_path; utf8::encode $uniq;
1310 1708
1311 $self->{load_path} = $save; 1709 $self->{load_path} = $save;
1312 1710
1313 return if $self->{deny_save}; 1711 return if $self->{deny_save};
1314 1712
1713 local $self->{last_access} = $self->last_access;#d#
1714
1715 cf::async {
1716 $_->contr->save for $self->players;
1717 };
1718
1315 if ($uniq) { 1719 if ($uniq) {
1316 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1720 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1317 $self->save_objects ($uniq, cf::IO_UNIQUES); 1721 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1318 } else { 1722 } else {
1319 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1723 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1320 } 1724 }
1321} 1725}
1322 1726
1323sub swap_out { 1727sub swap_out {
1324 my ($self) = @_; 1728 my ($self) = @_;
1325 1729
1326 # save first because save cedes 1730 # save first because save cedes
1327 $self->save; 1731 $self->save;
1732
1733 my $lock = cf::lock_acquire "map_data:" . $self->path;
1328 1734
1329 return if $self->players; 1735 return if $self->players;
1330 return if $self->in_memory != cf::MAP_IN_MEMORY; 1736 return if $self->in_memory != cf::MAP_IN_MEMORY;
1331 return if $self->{deny_save}; 1737 return if $self->{deny_save};
1332 1738
1336 1742
1337sub reset_at { 1743sub reset_at {
1338 my ($self) = @_; 1744 my ($self) = @_;
1339 1745
1340 # TODO: safety, remove and allow resettable per-player maps 1746 # TODO: safety, remove and allow resettable per-player maps
1341 return 1e99 if $self->{path}{user_rel};
1342 return 1e99 if $self->{deny_reset}; 1747 return 1e99 if $self->{deny_reset};
1343 1748
1344 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1749 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1345 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1750 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1346 1751
1351 my ($self) = @_; 1756 my ($self) = @_;
1352 1757
1353 $self->reset_at <= $cf::RUNTIME 1758 $self->reset_at <= $cf::RUNTIME
1354} 1759}
1355 1760
1356sub unlink_save {
1357 my ($self) = @_;
1358
1359 utf8::encode (my $save = $self->{path}->save_path);
1360 aioreq_pri 3; IO::AIO::aio_unlink $save;
1361 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1362}
1363
1364sub rename {
1365 my ($self, $new_path) = @_;
1366
1367 $self->unlink_save;
1368
1369 delete $cf::MAP{$self->path};
1370 $self->{path} = new cf::path $new_path;
1371 $self->path ($self->{path}->as_string);
1372 $cf::MAP{$self->path} = $self;
1373
1374 $self->save;
1375}
1376
1377sub reset { 1761sub reset {
1378 my ($self) = @_; 1762 my ($self) = @_;
1379 1763
1764 my $lock = cf::lock_acquire "map_data:$self->{path}";
1765
1380 return if $self->players; 1766 return if $self->players;
1381 return if $self->{path}{user_rel};#d#
1382 1767
1383 warn "resetting map ", $self->path;#d# 1768 warn "resetting map ", $self->path;
1769
1770 $self->in_memory (cf::MAP_SWAPPED);
1771
1772 # need to save uniques path
1773 unless ($self->{deny_save}) {
1774 my $uniq = $self->uniq_path; utf8::encode $uniq;
1775
1776 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1777 if $uniq;
1778 }
1384 1779
1385 delete $cf::MAP{$self->path}; 1780 delete $cf::MAP{$self->path};
1781
1782 $self->clear;
1386 1783
1387 $_->clear_links_to ($self) for values %cf::MAP; 1784 $_->clear_links_to ($self) for values %cf::MAP;
1388 1785
1389 $self->unlink_save; 1786 $self->unlink_save;
1390 $self->destroy; 1787 $self->destroy;
1393my $nuke_counter = "aaaa"; 1790my $nuke_counter = "aaaa";
1394 1791
1395sub nuke { 1792sub nuke {
1396 my ($self) = @_; 1793 my ($self) = @_;
1397 1794
1795 delete $cf::MAP{$self->path};
1796
1797 $self->unlink_save;
1798
1799 bless $self, "cf::map";
1800 delete $self->{deny_reset};
1398 $self->{deny_save} = 1; 1801 $self->{deny_save} = 1;
1399 $self->reset_timeout (1); 1802 $self->reset_timeout (1);
1400 $self->rename ("{nuke}/" . ($nuke_counter++)); 1803 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1804
1805 $cf::MAP{$self->path} = $self;
1806
1401 $self->reset; # polite request, might not happen 1807 $self->reset; # polite request, might not happen
1402} 1808}
1403 1809
1404sub customise_for { 1810=item $maps = cf::map::tmp_maps
1405 my ($map, $ob) = @_;
1406 1811
1407 if ($map->per_player) { 1812Returns an arrayref with all map paths of currently instantiated and saved
1408 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1813maps. May block.
1814
1815=cut
1816
1817sub tmp_maps() {
1409 } 1818 [
1410 1819 map {
1411 $map 1820 utf8::decode $_;
1821 /\.map$/
1822 ? normalise $_
1823 : ()
1824 } @{ aio_readdir $TMPDIR or [] }
1825 ]
1412} 1826}
1413 1827
1414sub emergency_save { 1828=item $maps = cf::map::random_maps
1415 local $cf::FREEZE = 1;
1416 1829
1417 warn "enter emergency map save\n"; 1830Returns an arrayref with all map paths of currently instantiated and saved
1831random maps. May block.
1418 1832
1419 cf::sync_job { 1833=cut
1420 warn "begin emergency map save\n";
1421 $_->save for values %cf::MAP;
1422 };
1423 1834
1424 warn "end emergency map save\n"; 1835sub random_maps() {
1836 [
1837 map {
1838 utf8::decode $_;
1839 /\.map$/
1840 ? normalise "?random/$_"
1841 : ()
1842 } @{ aio_readdir $RANDOMDIR or [] }
1843 ]
1844}
1845
1846=item cf::map::unique_maps
1847
1848Returns an arrayref of paths of all shared maps that have
1849instantiated unique items. May block.
1850
1851=cut
1852
1853sub unique_maps() {
1854 [
1855 map {
1856 utf8::decode $_;
1857 /\.map$/
1858 ? normalise $_
1859 : ()
1860 } @{ aio_readdir $UNIQUEDIR or [] }
1861 ]
1425} 1862}
1426 1863
1427package cf; 1864package cf;
1428 1865
1429=back 1866=back
1430 1867
1868=head3 cf::object
1869
1870=cut
1871
1872package cf::object;
1873
1874=over 4
1875
1876=item $ob->inv_recursive
1877
1878Returns the inventory of the object _and_ their inventories, recursively.
1879
1880=cut
1881
1882sub inv_recursive_;
1883sub inv_recursive_ {
1884 map { $_, inv_recursive_ $_->inv } @_
1885}
1886
1887sub inv_recursive {
1888 inv_recursive_ inv $_[0]
1889}
1890
1891package cf;
1892
1893=back
1431 1894
1432=head3 cf::object::player 1895=head3 cf::object::player
1433 1896
1434=over 4 1897=over 4
1435 1898
1475 1938
1476=item $player_object->enter_link 1939=item $player_object->enter_link
1477 1940
1478Freezes the player and moves him/her to a special map (C<{link}>). 1941Freezes the player and moves him/her to a special map (C<{link}>).
1479 1942
1480The player should be reaosnably safe there for short amounts of time. You 1943The player should be reasonably safe there for short amounts of time. You
1481I<MUST> call C<leave_link> as soon as possible, though. 1944I<MUST> call C<leave_link> as soon as possible, though.
1482 1945
1946Will never block.
1947
1483=item $player_object->leave_link ($map, $x, $y) 1948=item $player_object->leave_link ($map, $x, $y)
1484 1949
1485Moves the player out of the specila link map onto the given map. If the 1950Moves the player out of the special C<{link}> map onto the specified
1486map is not valid (or omitted), the player will be moved back to the 1951map. If the map is not valid (or omitted), the player will be moved back
1487location he/she was before the call to C<enter_link>, or, if that fails, 1952to the location he/she was before the call to C<enter_link>, or, if that
1488to the emergency map position. 1953fails, to the emergency map position.
1489 1954
1490Might block. 1955Might block.
1491 1956
1492=cut 1957=cut
1958
1959sub link_map {
1960 unless ($LINK_MAP) {
1961 $LINK_MAP = cf::map::find "{link}"
1962 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1963 $LINK_MAP->load;
1964 }
1965
1966 $LINK_MAP
1967}
1493 1968
1494sub cf::object::player::enter_link { 1969sub cf::object::player::enter_link {
1495 my ($self) = @_; 1970 my ($self) = @_;
1496 1971
1497 $self->deactivate_recursive; 1972 $self->deactivate_recursive;
1498 1973
1499 return if $self->map == $LINK_MAP; 1974 return if UNIVERSAL::isa $self->map, "ext::map_link";
1500 1975
1501 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1976 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1502 if $self->map; 1977 if $self->map && $self->map->{path} ne "{link}";
1503 1978
1504 $self->enter_map ($LINK_MAP, 20, 20); 1979 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1505} 1980}
1506 1981
1507sub cf::object::player::leave_link { 1982sub cf::object::player::leave_link {
1508 my ($self, $map, $x, $y) = @_; 1983 my ($self, $map, $x, $y) = @_;
1984
1985 return unless $self->contr->active;
1509 1986
1510 my $link_pos = delete $self->{_link_pos}; 1987 my $link_pos = delete $self->{_link_pos};
1511 1988
1512 unless ($map) { 1989 unless ($map) {
1513 # restore original map position 1990 # restore original map position
1514 ($map, $x, $y) = @{ $link_pos || [] }; 1991 ($map, $x, $y) = @{ $link_pos || [] };
1515 $map = cf::map::find_map $map; 1992 $map = cf::map::find $map;
1516 1993
1517 unless ($map) { 1994 unless ($map) {
1518 ($map, $x, $y) = @$EMERGENCY_POSITION; 1995 ($map, $x, $y) = @$EMERGENCY_POSITION;
1519 $map = cf::map::find_map $map 1996 $map = cf::map::find $map
1520 or die "FATAL: cannot load emergency map\n"; 1997 or die "FATAL: cannot load emergency map\n";
1521 } 1998 }
1522 } 1999 }
1523 2000
1524 ($x, $y) = (-1, -1) 2001 ($x, $y) = (-1, -1)
1527 # use -1 or undef as default coordinates, not 0, 0 2004 # use -1 or undef as default coordinates, not 0, 0
1528 ($x, $y) = ($map->enter_x, $map->enter_y) 2005 ($x, $y) = ($map->enter_x, $map->enter_y)
1529 if $x <=0 && $y <= 0; 2006 if $x <=0 && $y <= 0;
1530 2007
1531 $map->load; 2008 $map->load;
2009 $map->load_diag;
1532 2010
2011 return unless $self->contr->active;
1533 $self->activate_recursive; 2012 $self->activate_recursive;
2013
2014 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1534 $self->enter_map ($map, $x, $y); 2015 $self->enter_map ($map, $x, $y);
1535} 2016}
1536 2017
1537cf::player->attach (
1538 on_logout => sub {
1539 my ($pl) = @_;
1540
1541 # abort map switching before logout
1542 if ($pl->ob->{_link_pos}) {
1543 cf::sync_job {
1544 $pl->ob->leave_link
1545 };
1546 }
1547 },
1548 on_login => sub {
1549 my ($pl) = @_;
1550
1551 # try to abort aborted map switching on player login :)
1552 # should happen only on crashes
1553 if ($pl->ob->{_link_pos}) {
1554 $pl->ob->enter_link;
1555 cf::async {
1556 # we need this sleep as the login has a concurrent enter_exit running
1557 # and this sleep increases chances of the player not ending up in scorn
1558 Coro::Timer::sleep 1;
1559 $pl->ob->leave_link;
1560 };
1561 }
1562 },
1563);
1564
1565=item $player_object->goto_map ($path, $x, $y) 2018=item $player_object->goto ($path, $x, $y[, $check->($map)])
1566 2019
1567=cut 2020Moves the player to the given map-path and coordinates by first freezing
2021her, loading and preparing them map, calling the provided $check callback
2022that has to return the map if sucecssful, and then unfreezes the player on
2023the new (success) or old (failed) map position.
1568 2024
2025=cut
2026
2027our $GOTOGEN;
2028
1569sub cf::object::player::goto_map { 2029sub cf::object::player::goto {
1570 my ($self, $path, $x, $y) = @_; 2030 my ($self, $path, $x, $y, $check) = @_;
2031
2032 # do generation counting so two concurrent goto's will be executed in-order
2033 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1571 2034
1572 $self->enter_link; 2035 $self->enter_link;
1573 2036
1574 (cf::async { 2037 (async {
1575 $path = new cf::path $path; 2038 my $map = eval {
1576
1577 my $map = cf::map::find_map $path->as_string; 2039 my $map = cf::map::find $path;
2040
2041 if ($map) {
1578 $map = $map->customise_for ($self) if $map; 2042 $map = $map->customise_for ($self);
1579 2043 $map = $check->($map) if $check && $map;
1580# warn "entering ", $map->path, " at ($x, $y)\n" 2044 } else {
1581# if $map;
1582
1583 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2045 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2046 }
1584 2047
2048 $map
2049 };
2050
2051 if ($@) {
2052 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2053 LOG llevError | logBacktrace, Carp::longmess $@;
2054 }
2055
2056 if ($gen == $self->{_goto_generation}) {
2057 delete $self->{_goto_generation};
1585 $self->leave_link ($map, $x, $y); 2058 $self->leave_link ($map, $x, $y);
2059 }
1586 })->prio (1); 2060 })->prio (1);
1587} 2061}
1588 2062
1589=item $player_object->enter_exit ($exit_object) 2063=item $player_object->enter_exit ($exit_object)
1590 2064
1592 2066
1593sub parse_random_map_params { 2067sub parse_random_map_params {
1594 my ($spec) = @_; 2068 my ($spec) = @_;
1595 2069
1596 my $rmp = { # defaults 2070 my $rmp = { # defaults
1597 xsize => 10, 2071 xsize => (cf::rndm 15, 40),
1598 ysize => 10, 2072 ysize => (cf::rndm 15, 40),
2073 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2074 #layout => string,
1599 }; 2075 };
1600 2076
1601 for (split /\n/, $spec) { 2077 for (split /\n/, $spec) {
1602 my ($k, $v) = split /\s+/, $_, 2; 2078 my ($k, $v) = split /\s+/, $_, 2;
1603 2079
1607 $rmp 2083 $rmp
1608} 2084}
1609 2085
1610sub prepare_random_map { 2086sub prepare_random_map {
1611 my ($exit) = @_; 2087 my ($exit) = @_;
2088
2089 my $guard = cf::lock_acquire "exit_prepare:$exit";
1612 2090
1613 # all this does is basically replace the /! path by 2091 # all this does is basically replace the /! path by
1614 # a new random map path (?random/...) with a seed 2092 # a new random map path (?random/...) with a seed
1615 # that depends on the exit object 2093 # that depends on the exit object
1616 2094
1617 my $rmp = parse_random_map_params $exit->msg; 2095 my $rmp = parse_random_map_params $exit->msg;
1618 2096
1619 if ($exit->map) { 2097 if ($exit->map) {
1620 $rmp->{region} = $exit->map->region_name; 2098 $rmp->{region} = $exit->region->name;
1621 $rmp->{origin_map} = $exit->map->path; 2099 $rmp->{origin_map} = $exit->map->path;
1622 $rmp->{origin_x} = $exit->x; 2100 $rmp->{origin_x} = $exit->x;
1623 $rmp->{origin_y} = $exit->y; 2101 $rmp->{origin_y} = $exit->y;
1624 } 2102 }
1625 2103
1626 $rmp->{random_seed} ||= $exit->random_seed; 2104 $rmp->{random_seed} ||= $exit->random_seed;
1627 2105
1628 my $data = cf::to_json $rmp; 2106 my $data = cf::to_json $rmp;
1629 my $md5 = Digest::MD5::md5_hex $data; 2107 my $md5 = Digest::MD5::md5_hex $data;
2108 my $meta = "$RANDOMDIR/$md5.meta";
1630 2109
1631 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2110 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1632 aio_write $fh, 0, (length $data), $data, 0; 2111 aio_write $fh, 0, (length $data), $data, 0;
2112 undef $fh;
2113 aio_rename "$meta~", $meta;
1633 2114
1634 $exit->slaying ("?random/$md5"); 2115 $exit->slaying ("?random/$md5");
1635 $exit->msg (undef); 2116 $exit->msg (undef);
1636 } 2117 }
1637} 2118}
1639sub cf::object::player::enter_exit { 2120sub cf::object::player::enter_exit {
1640 my ($self, $exit) = @_; 2121 my ($self, $exit) = @_;
1641 2122
1642 return unless $self->type == cf::PLAYER; 2123 return unless $self->type == cf::PLAYER;
1643 2124
2125 if ($exit->slaying eq "/!") {
2126 #TODO: this should de-fi-ni-te-ly not be a sync-job
2127 # the problem is that $exit might not survive long enough
2128 # so it needs to be done right now, right here
2129 cf::sync_job { prepare_random_map $exit };
2130 }
2131
2132 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2133 my $hp = $exit->stats->hp;
2134 my $sp = $exit->stats->sp;
2135
1644 $self->enter_link; 2136 $self->enter_link;
1645 2137
1646 (cf::async { 2138 (async {
2139 $self->deactivate_recursive; # just to be sure
1647 unless (eval { 2140 unless (eval {
1648 prepare_random_map $exit 2141 $self->goto ($slaying, $hp, $sp);
1649 if $exit->slaying eq "/!";
1650
1651 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653 2142
1654 1; 2143 1;
1655 }) { 2144 }) {
1656 $self->message ("Something went wrong deep within the crossfire server. " 2145 $self->message ("Something went wrong deep within the crossfire server. "
1657 . "I'll try to bring you back to the map you were before. " 2146 . "I'll try to bring you back to the map you were before. "
1658 . "Please report this to the dungeon master", 2147 . "Please report this to the dungeon master!",
1659 cf::NDI_UNIQUE | cf::NDI_RED); 2148 cf::NDI_UNIQUE | cf::NDI_RED);
1660 2149
1661 warn "ERROR in enter_exit: $@"; 2150 warn "ERROR in enter_exit: $@";
1662 $self->leave_link; 2151 $self->leave_link;
1663 } 2152 }
1664 })->prio (1); 2153 })->prio (1);
1677 2166
1678sub cf::client::send_drawinfo { 2167sub cf::client::send_drawinfo {
1679 my ($self, $text, $flags) = @_; 2168 my ($self, $text, $flags) = @_;
1680 2169
1681 utf8::encode $text; 2170 utf8::encode $text;
1682 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2171 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1683} 2172}
1684 2173
2174=item $client->ext_event ($type, %msg)
2175
2176Sends an exti event to the client.
2177
2178=cut
2179
2180sub cf::client::ext_event($$%) {
2181 my ($self, $type, %msg) = @_;
2182
2183 $msg{msgtype} = "event_$type";
2184 $self->send_packet ("ext " . cf::to_json \%msg);
2185}
1685 2186
1686=item $success = $client->query ($flags, "text", \&cb) 2187=item $success = $client->query ($flags, "text", \&cb)
1687 2188
1688Queues a query to the client, calling the given callback with 2189Queues a query to the client, calling the given callback with
1689the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2190the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1718 # get handled first 2219 # get handled first
1719 my $queue = delete $ns->{query_queue} 2220 my $queue = delete $ns->{query_queue}
1720 or return; # be conservative, not sure how that can happen, but we saw a crash here 2221 or return; # be conservative, not sure how that can happen, but we saw a crash here
1721 2222
1722 (shift @$queue)->[1]->($msg); 2223 (shift @$queue)->[1]->($msg);
2224 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1723 2225
1724 push @{ $ns->{query_queue} }, @$queue; 2226 push @{ $ns->{query_queue} }, @$queue;
1725 2227
1726 if (@{ $ns->{query_queue} } == @$queue) { 2228 if (@{ $ns->{query_queue} } == @$queue) {
1727 if (@$queue) { 2229 if (@$queue) {
1731 } 2233 }
1732 } 2234 }
1733 }, 2235 },
1734); 2236);
1735 2237
1736=item $client->coro (\&cb) 2238=item $client->async (\&cb)
1737 2239
1738Create a new coroutine, running the specified callback. The coroutine will 2240Create a new coroutine, running the specified callback. The coroutine will
1739be automatically cancelled when the client gets destroyed (e.g. on logout, 2241be automatically cancelled when the client gets destroyed (e.g. on logout,
1740or loss of connection). 2242or loss of connection).
1741 2243
1742=cut 2244=cut
1743 2245
1744sub cf::client::coro { 2246sub cf::client::async {
1745 my ($self, $cb) = @_; 2247 my ($self, $cb) = @_;
1746 2248
1747 my $coro = &cf::async ($cb); 2249 my $coro = &Coro::async ($cb);
1748 2250
1749 $coro->on_destroy (sub { 2251 $coro->on_destroy (sub {
1750 delete $self->{_coro}{$coro+0}; 2252 delete $self->{_coro}{$coro+0};
1751 }); 2253 });
1752 2254
1785 2287
1786# here we export the classes and methods available to script code 2288# here we export the classes and methods available to script code
1787 2289
1788=pod 2290=pod
1789 2291
1790The following fucntions and emthods are available within a safe environment: 2292The following functions and methods are available within a safe environment:
1791 2293
1792 cf::object contr pay_amount pay_player map 2294 cf::object contr pay_amount pay_player map
1793 cf::object::player player 2295 cf::object::player player
1794 cf::player peaceful 2296 cf::player peaceful
1795 cf::map trigger 2297 cf::map trigger
1880############################################################################# 2382#############################################################################
1881 2383
1882=head2 EXTENSION DATABASE SUPPORT 2384=head2 EXTENSION DATABASE SUPPORT
1883 2385
1884Crossfire maintains a very simple database for extension use. It can 2386Crossfire maintains a very simple database for extension use. It can
1885currently store anything that can be serialised using Storable, which 2387currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1886excludes objects. 2388convert to/from binary).
1887 2389
1888The parameter C<$family> should best start with the name of the extension 2390The parameter C<$family> should best start with the name of the extension
1889using it, it should be unique. 2391using it, it should be unique.
1890 2392
1891=over 4 2393=over 4
1892 2394
1893=item $hashref = cf::db_get $family
1894
1895Return a hashref for use by the extension C<$family>, which can be
1896modified. After modifications, you have to call C<cf::db_dirty> or
1897C<cf::db_sync>.
1898
1899=item $value = cf::db_get $family => $key 2395=item $value = cf::db_get $family => $key
1900 2396
1901Returns a single value from the database 2397Returns a single value from the database.
1902
1903=item cf::db_put $family => $hashref
1904
1905Stores the given family hashref into the database. Updates are delayed, if
1906you want the data to be synced to disk immediately, use C<cf::db_sync>.
1907 2398
1908=item cf::db_put $family => $key => $value 2399=item cf::db_put $family => $key => $value
1909 2400
1910Stores the given C<$value> in the family hash. Updates are delayed, if you 2401Stores the given C<$value> in the family.
1911want the data to be synced to disk immediately, use C<cf::db_sync>.
1912
1913=item cf::db_dirty
1914
1915Marks the database as dirty, to be updated at a later time.
1916
1917=item cf::db_sync
1918
1919Immediately write the database to disk I<if it is dirty>.
1920 2402
1921=cut 2403=cut
1922 2404
1923our $DB; 2405our $DB;
1924 2406
1925{ 2407sub db_init {
1926 my $path = cf::localdir . "/database.pst"; 2408 unless ($DB) {
2409 $DB = BDB::db_create $DB_ENV;
1927 2410
1928 sub db_load() { 2411 cf::sync_job {
1929 $DB = stat $path ? Storable::retrieve $path : { }; 2412 eval {
1930 } 2413 $DB->set_flags (BDB::CHKSUM);
1931 2414
1932 my $pid; 2415 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1933 2416 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1934 sub db_save() { 2417 cf::cleanup "db_open(db): $!" if $!;
1935 waitpid $pid, 0 if $pid; 2418 };
1936 if (0 == ($pid = fork)) { 2419 cf::cleanup "db_open(db): $@" if $@;
1937 $DB->{_meta}{version} = 1;
1938 Storable::nstore $DB, "$path~";
1939 rename "$path~", $path;
1940 cf::_exit 0 if defined $pid;
1941 } 2420 };
1942 }
1943
1944 my $dirty;
1945
1946 sub db_sync() {
1947 db_save if $dirty;
1948 undef $dirty;
1949 }
1950
1951 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1952 db_sync;
1953 }); 2421 }
2422}
1954 2423
1955 sub db_dirty() {
1956 $dirty = 1;
1957 $idle->start;
1958 }
1959
1960 sub db_get($;$) { 2424sub db_get($$) {
1961 @_ >= 2 2425 my $key = "$_[0]/$_[1]";
1962 ? $DB->{$_[0]}{$_[1]}
1963 : ($DB->{$_[0]} ||= { })
1964 }
1965 2426
2427 cf::sync_job {
2428 BDB::db_get $DB, undef, $key, my $data;
2429
2430 $! ? ()
2431 : $data
2432 }
2433}
2434
1966 sub db_put($$;$) { 2435sub db_put($$$) {
1967 if (@_ >= 3) { 2436 BDB::dbreq_pri 4;
1968 $DB->{$_[0]}{$_[1]} = $_[2]; 2437 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1969 } else { 2438}
1970 $DB->{$_[0]} = $_[1];
1971 }
1972 db_dirty;
1973 }
1974 2439
1975 cf::global->attach ( 2440=item cf::cache $id => [$paths...], $processversion => $process
1976 prio => 10000, 2441
1977 on_cleanup => sub { 2442Generic caching function that returns the value of the resource $id,
1978 db_sync; 2443caching and regenerating as required.
2444
2445This function can block.
2446
2447=cut
2448
2449sub cache {
2450 my ($id, $src, $processversion, $process) = @_;
2451
2452 my $meta =
2453 join "\x00",
2454 $processversion,
2455 map {
2456 aio_stat $_
2457 and Carp::croak "$_: $!";
2458
2459 ($_, (stat _)[7,9])
2460 } @$src;
2461
2462 my $dbmeta = db_get cache => "$id/meta";
2463 if ($dbmeta ne $meta) {
2464 # changed, we may need to process
2465
2466 my @data;
2467 my $md5;
2468
2469 for (0 .. $#$src) {
2470 0 <= aio_load $src->[$_], $data[$_]
2471 or Carp::croak "$src->[$_]: $!";
1979 }, 2472 }
1980 ); 2473
2474 # if processing is expensive, check
2475 # checksum first
2476 if (1) {
2477 $md5 =
2478 join "\x00",
2479 $processversion,
2480 map {
2481 Coro::cede;
2482 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2483 } 0.. $#$src;
2484
2485
2486 my $dbmd5 = db_get cache => "$id/md5";
2487 if ($dbmd5 eq $md5) {
2488 db_put cache => "$id/meta", $meta;
2489
2490 return db_get cache => "$id/data";
2491 }
2492 }
2493
2494 my $t1 = Time::HiRes::time;
2495 my $data = $process->(\@data);
2496 my $t2 = Time::HiRes::time;
2497
2498 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2499
2500 db_put cache => "$id/data", $data;
2501 db_put cache => "$id/md5" , $md5;
2502 db_put cache => "$id/meta", $meta;
2503
2504 return $data;
2505 }
2506
2507 db_get cache => "$id/data"
2508}
2509
2510=item fork_call { }, $args
2511
2512Executes the given code block with the given arguments in a seperate
2513process, returning the results. Everything must be serialisable with
2514Coro::Storable. May, of course, block. Note that the executed sub may
2515never block itself or use any form of Event handling.
2516
2517=cut
2518
2519sub fork_call(&@) {
2520 my ($cb, @args) = @_;
2521
2522# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2523# or die "socketpair: $!";
2524 pipe my $fh1, my $fh2
2525 or die "pipe: $!";
2526
2527 if (my $pid = fork) {
2528 close $fh2;
2529
2530 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2531 $res = Coro::Storable::thaw $res;
2532
2533 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2534
2535 die $$res unless "ARRAY" eq ref $res;
2536
2537 return wantarray ? @$res : $res->[-1];
2538 } else {
2539 reset_signals;
2540 local $SIG{__WARN__};
2541 local $SIG{__DIE__};
2542 eval {
2543 close $fh1;
2544
2545 my @res = eval { $cb->(@args) };
2546 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2547 };
2548
2549 warn $@ if $@;
2550 _exit 0;
2551 }
1981} 2552}
1982 2553
1983############################################################################# 2554#############################################################################
1984# the server's main() 2555# the server's init and main functions
2556
2557sub load_facedata($) {
2558 my ($path) = @_;
2559
2560 warn "loading facedata from $path\n";
2561
2562 my $facedata;
2563 0 < aio_load $path, $facedata
2564 or die "$path: $!";
2565
2566 $facedata = Coro::Storable::thaw $facedata;
2567
2568 $facedata->{version} == 2
2569 or cf::cleanup "$path: version mismatch, cannot proceed.";
2570
2571 {
2572 my $faces = $facedata->{faceinfo};
2573
2574 while (my ($face, $info) = each %$faces) {
2575 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2576 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2577 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2578 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2579 Coro::cede;
2580 }
2581
2582 while (my ($face, $info) = each %$faces) {
2583 next unless $info->{smooth};
2584 my $idx = cf::face::find $face
2585 or next;
2586 if (my $smooth = cf::face::find $info->{smooth}) {
2587 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2588 } else {
2589 warn "smooth face '$info->{smooth}' not found for face '$face'";
2590 }
2591 Coro::cede;
2592 }
2593 }
2594
2595 {
2596 my $anims = $facedata->{animinfo};
2597
2598 while (my ($anim, $info) = each %$anims) {
2599 cf::anim::set $anim, $info->{frames}, $info->{facings};
2600 Coro::cede;
2601 }
2602
2603 cf::anim::invalidate_all; # d'oh
2604 }
2605
2606 1
2607}
2608
2609sub reload_regions {
2610 load_resource_file "$MAPDIR/regions"
2611 or die "unable to load regions file\n";
2612}
2613
2614sub reload_facedata {
2615 load_facedata "$DATADIR/facedata"
2616 or die "unable to load facedata\n";
2617}
2618
2619sub reload_archetypes {
2620 load_resource_file "$DATADIR/archetypes"
2621 or die "unable to load archetypes\n";
2622}
2623
2624sub reload_treasures {
2625 load_resource_file "$DATADIR/treasures"
2626 or die "unable to load treasurelists\n";
2627}
2628
2629sub reload_resources {
2630 warn "reloading resource files...\n";
2631
2632 reload_regions;
2633 reload_facedata;
2634 #reload_archetypes;#d#
2635 reload_archetypes;
2636 reload_treasures;
2637
2638 warn "finished reloading resource files\n";
2639}
2640
2641sub init {
2642 reload_resources;
2643}
1985 2644
1986sub cfg_load { 2645sub cfg_load {
1987 open my $fh, "<:utf8", cf::confdir . "/config" 2646 open my $fh, "<:utf8", "$CONFDIR/config"
1988 or return; 2647 or return;
1989 2648
1990 local $/; 2649 local $/;
1991 *CFG = YAML::Syck::Load <$fh>; 2650 *CFG = YAML::Syck::Load <$fh>;
1992 2651
1993 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2652 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994 2653
2654 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2655 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2656
1995 if (exists $CFG{mlockall}) { 2657 if (exists $CFG{mlockall}) {
1996 eval { 2658 eval {
1997 $CFG{mlockall} ? &mlockall : &munlockall 2659 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998 and die "WARNING: m(un)lockall failed: $!\n"; 2660 and die "WARNING: m(un)lockall failed: $!\n";
1999 }; 2661 };
2000 warn $@ if $@; 2662 warn $@ if $@;
2001 } 2663 }
2002} 2664}
2003 2665
2004sub main { 2666sub main {
2005 # we must not ever block the main coroutine 2667 # we must not ever block the main coroutine
2006 local $Coro::idle = sub { 2668 local $Coro::idle = sub {
2007 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2669 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008 (Coro::unblock_sub { 2670 (async {
2009 Event::one_event; 2671 Event::one_event;
2010 })->(); 2672 })->prio (Coro::PRIO_MAX);
2011 }; 2673 };
2012 2674
2013 cfg_load; 2675 cfg_load;
2014 db_load; 2676 db_init;
2015 load_extensions; 2677 load_extensions;
2678
2679 $TICK_WATCHER->start;
2016 Event::loop; 2680 Event::loop;
2017} 2681}
2018 2682
2019############################################################################# 2683#############################################################################
2020# initialisation 2684# initialisation and cleanup
2021 2685
2686# install some emergency cleanup handlers
2687BEGIN {
2688 for my $signal (qw(INT HUP TERM)) {
2689 Event->signal (
2690 reentrant => 0,
2691 data => WF_AUTOCANCEL,
2692 signal => $signal,
2693 prio => 0,
2694 cb => sub {
2695 cf::cleanup "SIG$signal";
2696 },
2697 );
2698 }
2699}
2700
2701sub emergency_save() {
2702 my $freeze_guard = cf::freeze_mainloop;
2703
2704 warn "enter emergency perl save\n";
2705
2706 cf::sync_job {
2707 # use a peculiar iteration method to avoid tripping on perl
2708 # refcount bugs in for. also avoids problems with players
2709 # and maps saved/destroyed asynchronously.
2710 warn "begin emergency player save\n";
2711 for my $login (keys %cf::PLAYER) {
2712 my $pl = $cf::PLAYER{$login} or next;
2713 $pl->valid or next;
2714 $pl->save;
2715 }
2716 warn "end emergency player save\n";
2717
2718 warn "begin emergency map save\n";
2719 for my $path (keys %cf::MAP) {
2720 my $map = $cf::MAP{$path} or next;
2721 $map->valid or next;
2722 $map->save;
2723 }
2724 warn "end emergency map save\n";
2725
2726 warn "begin emergency database checkpoint\n";
2727 BDB::db_env_txn_checkpoint $DB_ENV;
2728 warn "end emergency database checkpoint\n";
2729 };
2730
2731 warn "leave emergency perl save\n";
2732}
2733
2734sub post_cleanup {
2735 my ($make_core) = @_;
2736
2737 warn Carp::longmess "post_cleanup backtrace"
2738 if $make_core;
2739}
2740
2022sub reload() { 2741sub do_reload_perl() {
2023 # can/must only be called in main 2742 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) { 2743 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n"; 2744 warn "can only reload from main coroutine";
2026 return; 2745 return;
2027 } 2746 }
2028 2747
2029 warn "reloading..."; 2748 warn "reloading...";
2030 2749
2031 local $FREEZE = 1; 2750 warn "entering sync_job";
2751
2752 cf::sync_job {
2753 cf::write_runtime; # external watchdog should not bark
2032 cf::emergency_save; 2754 cf::emergency_save;
2755 cf::write_runtime; # external watchdog should not bark
2033 2756
2034 eval { 2757 warn "syncing database to disk";
2758 BDB::db_env_txn_checkpoint $DB_ENV;
2759
2035 # if anything goes wrong in here, we should simply crash as we already saved 2760 # if anything goes wrong in here, we should simply crash as we already saved
2036 2761
2037 # cancel all watchers 2762 warn "cancelling all WF_AUTOCANCEL watchers";
2038 for (Event::all_watchers) { 2763 for (Event::all_watchers) {
2039 $_->cancel if $_->data & WF_AUTOCANCEL; 2764 $_->cancel if $_->data & WF_AUTOCANCEL;
2040 } 2765 }
2041 2766
2767 warn "flushing outstanding aio requests";
2768 for (;;) {
2769 BDB::flush;
2770 IO::AIO::flush;
2771 Coro::cede;
2772 last unless IO::AIO::nreqs || BDB::nreqs;
2773 warn "iterate...";
2774 }
2775
2776 ++$RELOAD;
2777
2042 # cancel all extension coros 2778 warn "cancelling all extension coros";
2043 $_->cancel for values %EXT_CORO; 2779 $_->cancel for values %EXT_CORO;
2044 %EXT_CORO = (); 2780 %EXT_CORO = ();
2045 2781
2046 # unload all extensions 2782 warn "removing commands";
2047 for (@exts) { 2783 %COMMAND = ();
2784
2785 warn "removing ext commands";
2786 %EXTCMD = ();
2787
2788 warn "unloading/nuking all extensions";
2789 for my $pkg (@EXTS) {
2048 warn "unloading <$_>"; 2790 warn "... unloading $pkg";
2049 unload_extension $_; 2791
2792 if (my $cb = $pkg->can ("unload")) {
2793 eval {
2794 $cb->($pkg);
2795 1
2796 } or warn "$pkg unloaded, but with errors: $@";
2050 } 2797 }
2051 2798
2799 warn "... nuking $pkg";
2800 Symbol::delete_package $pkg;
2801 }
2802
2052 # unload all modules loaded from $LIBDIR 2803 warn "unloading all perl modules loaded from $LIBDIR";
2053 while (my ($k, $v) = each %INC) { 2804 while (my ($k, $v) = each %INC) {
2054 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2805 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055 2806
2056 warn "removing <$k>"; 2807 warn "... unloading $k";
2057 delete $INC{$k}; 2808 delete $INC{$k};
2058 2809
2059 $k =~ s/\.pm$//; 2810 $k =~ s/\.pm$//;
2060 $k =~ s/\//::/g; 2811 $k =~ s/\//::/g;
2061 2812
2064 } 2815 }
2065 2816
2066 Symbol::delete_package $k; 2817 Symbol::delete_package $k;
2067 } 2818 }
2068 2819
2069 # sync database to disk
2070 cf::db_sync;
2071 IO::AIO::flush;
2072
2073 # get rid of safe::, as good as possible 2820 warn "getting rid of safe::, as good as possible";
2074 Symbol::delete_package "safe::$_" 2821 Symbol::delete_package "safe::$_"
2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2822 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076 2823
2077 # remove register_script_function callbacks
2078 # TODO
2079
2080 # unload cf.pm "a bit" 2824 warn "unloading cf.pm \"a bit\"";
2081 delete $INC{"cf.pm"}; 2825 delete $INC{"cf.pm"};
2826 delete $INC{"cf/pod.pm"};
2082 2827
2083 # don't, removes xs symbols, too, 2828 # don't, removes xs symbols, too,
2084 # and global variables created in xs 2829 # and global variables created in xs
2085 #Symbol::delete_package __PACKAGE__; 2830 #Symbol::delete_package __PACKAGE__;
2086 2831
2087 # reload cf.pm 2832 warn "unload completed, starting to reload now";
2833
2088 warn "reloading cf.pm"; 2834 warn "reloading cf.pm";
2089 require cf; 2835 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2836 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091 2837
2092 # load config and database again 2838 warn "loading config and database again";
2093 cf::cfg_load; 2839 cf::cfg_load;
2094 cf::db_load;
2095 2840
2096 # load extensions
2097 warn "load extensions"; 2841 warn "loading extensions";
2098 cf::load_extensions; 2842 cf::load_extensions;
2099 2843
2100 # reattach attachments to objects 2844 warn "reattaching attachments to objects/players";
2101 warn "reattach"; 2845 _global_reattach; # objects, sockets
2102 _global_reattach; 2846 warn "reattaching attachments to maps";
2103 }; 2847 reattach $_ for values %MAP;
2848 warn "reattaching attachments to players";
2849 reattach $_ for values %PLAYER;
2104 2850
2105 if ($@) { 2851 warn "leaving sync_job";
2852
2853 1
2854 } or do {
2106 warn $@; 2855 warn $@;
2107 warn "error while reloading, exiting."; 2856 warn "error while reloading, exiting.";
2108 exit 1; 2857 exit 1;
2109 } 2858 };
2110 2859
2111 warn "reloaded successfully"; 2860 warn "reloaded";
2112}; 2861};
2113 2862
2114############################################################################# 2863our $RELOAD_WATCHER; # used only during reload
2115 2864
2116unless ($LINK_MAP) { 2865sub reload_perl() {
2117 $LINK_MAP = cf::map::new; 2866 # doing reload synchronously and two reloads happen back-to-back,
2867 # coro crashes during coro_state_free->destroy here.
2118 2868
2119 $LINK_MAP->width (41); 2869 $RELOAD_WATCHER ||= Event->timer (
2120 $LINK_MAP->height (41); 2870 reentrant => 0,
2121 $LINK_MAP->alloc;
2122 $LINK_MAP->path ("{link}");
2123 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126 # dirty hack because... archetypes are not yet loaded
2127 Event->timer (
2128 after => 2, 2871 after => 0,
2872 data => WF_AUTOCANCEL,
2129 cb => sub { 2873 cb => sub {
2130 $_[0]->w->cancel; 2874 do_reload_perl;
2131 2875 undef $RELOAD_WATCHER;
2132 # provide some exits "home"
2133 my $exit = cf::object::new "exit";
2134
2135 $exit->slaying ($EMERGENCY_POSITION->[0]);
2136 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139 $LINK_MAP->insert ($exit->clone, 19, 19);
2140 $LINK_MAP->insert ($exit->clone, 19, 20);
2141 $LINK_MAP->insert ($exit->clone, 19, 21);
2142 $LINK_MAP->insert ($exit->clone, 20, 19);
2143 $LINK_MAP->insert ($exit->clone, 20, 21);
2144 $LINK_MAP->insert ($exit->clone, 21, 19);
2145 $LINK_MAP->insert ($exit->clone, 21, 20);
2146 $LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148 $exit->destroy;
2149 }); 2876 },
2150 2877 );
2151 $LINK_MAP->{deny_save} = 1;
2152 $LINK_MAP->{deny_reset} = 1;
2153
2154 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155} 2878}
2156
2157register "<global>", __PACKAGE__;
2158 2879
2159register_command "reload" => sub { 2880register_command "reload" => sub {
2160 my ($who, $arg) = @_; 2881 my ($who, $arg) = @_;
2161 2882
2162 if ($who->flag (FLAG_WIZ)) { 2883 if ($who->flag (FLAG_WIZ)) {
2163 $who->message ("start of reload.");
2164 reload;
2165 $who->message ("end of reload."); 2884 $who->message ("reloading server.");
2885 async { reload_perl };
2166 } 2886 }
2167}; 2887};
2168 2888
2169unshift @INC, $LIBDIR; 2889unshift @INC, $LIBDIR;
2170 2890
2891my $bug_warning = 0;
2892
2893our @WAIT_FOR_TICK;
2894our @WAIT_FOR_TICK_BEGIN;
2895
2896sub wait_for_tick {
2897 return unless $TICK_WATCHER->is_active;
2898 return if $Coro::current == $Coro::main;
2899
2900 my $signal = new Coro::Signal;
2901 push @WAIT_FOR_TICK, $signal;
2902 $signal->wait;
2903}
2904
2905sub wait_for_tick_begin {
2906 return unless $TICK_WATCHER->is_active;
2907 return if $Coro::current == $Coro::main;
2908
2909 my $signal = new Coro::Signal;
2910 push @WAIT_FOR_TICK_BEGIN, $signal;
2911 $signal->wait;
2912}
2913
2914 my $min = 1e6;#d#
2915 my $avg = 10;
2171$TICK_WATCHER = Event->timer ( 2916$TICK_WATCHER = Event->timer (
2172 reentrant => 0, 2917 reentrant => 0,
2918 parked => 1,
2173 prio => 0, 2919 prio => 0,
2174 at => $NEXT_TICK || $TICK, 2920 at => $NEXT_TICK || $TICK,
2175 data => WF_AUTOCANCEL, 2921 data => WF_AUTOCANCEL,
2176 cb => sub { 2922 cb => sub {
2177 unless ($FREEZE) { 2923 if ($Coro::current != $Coro::main) {
2924 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2925 unless ++$bug_warning > 10;
2926 return;
2927 }
2928
2929 $NOW = $tick_start = Event::time;
2930
2178 cf::server_tick; # one server iteration 2931 cf::server_tick; # one server iteration
2179 $RUNTIME += $TICK; 2932
2933 0 && sync_job {#d#
2934 for(1..10) {
2935 my $t = Event::time;
2936 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2937 or die;
2938
2939 $map->width (50);
2940 $map->height (50);
2941 $map->alloc;
2942 $map->_load_objects ("/tmp/x.map", 1);
2943 my $t = Event::time - $t;
2944
2945 #next unless $t < 0.0013;#d#
2946 if ($t < $min) {
2947 $min = $t;
2948 }
2949 $avg = $avg * 0.99 + $t * 0.01;
2950 }
2951 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2952 exit 0;
2953 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2180 } 2954 };
2181 2955
2956 $RUNTIME += $TICK;
2182 $NEXT_TICK += $TICK; 2957 $NEXT_TICK += $TICK;
2183 2958
2959 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2960 $NEXT_RUNTIME_WRITE = $NOW + 10;
2961 Coro::async_pool {
2962 write_runtime
2963 or warn "ERROR: unable to write runtime file: $!";
2964 };
2965 }
2966
2967# my $AFTER = Event::time;
2968# warn $AFTER - $NOW;#d#
2969
2970 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2971 $sig->send;
2972 }
2973 while (my $sig = shift @WAIT_FOR_TICK) {
2974 $sig->send;
2975 }
2976
2977 $NOW = Event::time;
2978
2184 # if we are delayed by four ticks or more, skip them all 2979 # if we are delayed by four ticks or more, skip them all
2185 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2980 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2186 2981
2187 $TICK_WATCHER->at ($NEXT_TICK); 2982 $TICK_WATCHER->at ($NEXT_TICK);
2188 $TICK_WATCHER->start; 2983 $TICK_WATCHER->start;
2984
2985 $LOAD = ($NOW - $tick_start) / $TICK;
2986 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2987
2988 _post_tick;
2989
2990
2189 }, 2991 },
2190); 2992);
2191 2993
2994{
2192IO::AIO::max_poll_time $TICK * 0.2; 2995 BDB::max_poll_time $TICK * 0.1;
2193 2996 $BDB_POLL_WATCHER = Event->io (
2194Event->io ( 2997 reentrant => 0,
2195 fd => IO::AIO::poll_fileno, 2998 fd => BDB::poll_fileno,
2196 poll => 'r', 2999 poll => 'r',
2197 prio => 5, 3000 prio => 0,
2198 data => WF_AUTOCANCEL,
2199 cb => \&IO::AIO::poll_cb,
2200);
2201
2202Event->timer (
2203 data => WF_AUTOCANCEL, 3001 data => WF_AUTOCANCEL,
2204 after => 0, 3002 cb => \&BDB::poll_cb,
2205 interval => 10, 3003 );
2206 cb => sub { 3004 BDB::min_parallel 8;
2207 (Coro::unblock_sub { 3005
2208 write_runtime 3006 BDB::set_sync_prepare {
2209 or warn "ERROR: unable to write runtime file: $!"; 3007 my $status;
3008 my $current = $Coro::current;
3009 (
3010 sub {
3011 $status = $!;
3012 $current->ready; undef $current;
3013 },
3014 sub {
3015 Coro::schedule while defined $current;
3016 $! = $status;
3017 },
3018 )
3019 };
3020
3021 unless ($DB_ENV) {
3022 $DB_ENV = BDB::db_env_create;
3023
3024 cf::sync_job {
3025 eval {
3026 BDB::db_env_open
3027 $DB_ENV,
3028 $BDBDIR,
3029 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3030 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3031 0666;
3032
3033 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3034
3035 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3036 $DB_ENV->set_lk_detect;
3037 };
3038
3039 cf::cleanup "db_env_open(db): $@" if $@;
2210 })->(); 3040 };
2211 }, 3041 }
2212); 3042}
3043
3044{
3045 IO::AIO::min_parallel 8;
3046
3047 undef $Coro::AIO::WATCHER;
3048 IO::AIO::max_poll_time $TICK * 0.1;
3049 $AIO_POLL_WATCHER = Event->io (
3050 reentrant => 0,
3051 data => WF_AUTOCANCEL,
3052 fd => IO::AIO::poll_fileno,
3053 poll => 'r',
3054 prio => 6,
3055 cb => \&IO::AIO::poll_cb,
3056 );
3057}
3058
3059my $_log_backtrace;
3060
3061sub _log_backtrace {
3062 my ($msg, @addr) = @_;
3063
3064 $msg =~ s/\n//;
3065
3066 # limit the # of concurrent backtraces
3067 if ($_log_backtrace < 2) {
3068 ++$_log_backtrace;
3069 async {
3070 my @bt = fork_call {
3071 @addr = map { sprintf "%x", $_ } @addr;
3072 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3073 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3074 or die "addr2line: $!";
3075
3076 my @funcs;
3077 my @res = <$fh>;
3078 chomp for @res;
3079 while (@res) {
3080 my ($func, $line) = splice @res, 0, 2, ();
3081 push @funcs, "[$func] $line";
3082 }
3083
3084 @funcs
3085 };
3086
3087 LOG llevInfo, "[ABT] $msg\n";
3088 LOG llevInfo, "[ABT] $_\n" for @bt;
3089 --$_log_backtrace;
3090 };
3091 } else {
3092 LOG llevInfo, "[ABT] $msg\n";
3093 LOG llevInfo, "[ABT] [suppressed]\n";
3094 }
3095}
3096
3097# load additional modules
3098use cf::pod;
2213 3099
2214END { cf::emergency_save } 3100END { cf::emergency_save }
2215 3101
22161 31021
2217 3103

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines