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.133 by root, Thu Jan 4 16:19:32 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 $RANDOM_MAPS = cf::localdir . "/random"; 91
55our %EXT_CORO; 92# used to convert map paths into valid unix filenames by replacing / by ∕
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
56 98
57binmode STDOUT; 99binmode STDOUT;
58binmode STDERR; 100binmode STDERR;
59 101
60# read virtual server time, if available 102# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
63 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
65} 107}
66 108
67mkdir cf::localdir; 109mkdir $_
68mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 111
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION; 112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
76 115
77############################################################################# 116#############################################################################
78 117
79=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
80 119
87=item $cf::RUNTIME 126=item $cf::RUNTIME
88 127
89The 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
90every server tick. 129every server tick.
91 130
92=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
93 134
94The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 139
97=item $cf::NOW 140=item $cf::NOW
98 141
99The time of the last (current) server tick. 142The time of the last (current) server tick.
100 143
101=item $cf::TICK 144=item $cf::TICK
102 145
103The 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.
104 157
105=item %cf::CFG 158=item %cf::CFG
106 159
107Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
108from 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.
109 168
110=back 169=back
111 170
112=cut 171=cut
113 172
114BEGIN { 173BEGIN {
115 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 175 my $msg = join "", @_;
117 utf8::encode $msg;
118 176
119 $msg .= "\n" 177 $msg .= "\n"
120 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
121 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
122 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
123 }; 184 };
124} 185}
125 186
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 194
133# 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
134# within the Safe compartment. 196# within the Safe compartment.
135for my $pkg (qw( 197for my $pkg (qw(
136 cf::global cf::attachable 198 cf::global cf::attachable
145 207
146$Event::DIED = sub { 208$Event::DIED = sub {
147 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
148}; 210};
149 211
150my %ext_pkg;
151my @exts;
152my @hook;
153
154=head2 UTILITY FUNCTIONS 212=head2 UTILITY FUNCTIONS
155 213
156=over 4 214=over 4
157 215
158=cut 216=item dumpval $ref
159 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
160use JSON::Syck (); # TODO# replace by JSON::PC once working 239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
161 240
162=item $ref = cf::from_json $json 241=item $ref = cf::from_json $json
163 242
164Converts a JSON string into the corresponding perl data structure. 243Converts a JSON string into the corresponding perl data structure.
165 244
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 245=item $json = cf::to_json $ref
174 246
175Converts a perl data structure into its JSON representation. 247Converts a perl data structure into its JSON representation.
176 248
177=cut
178
179sub to_json($) {
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181 JSON::Syck::Dump $_[0]
182}
183
184=item my $guard = cf::guard { BLOCK }
185
186Run the given callback when the guard object gets destroyed (useful for
187coroutine cancellations).
188
189You can call C<< ->cancel >> on the guard object to stop the block from
190being executed.
191
192=cut
193
194sub guard(&) {
195 bless \(my $cb = $_[0]), cf::guard::;
196}
197
198sub cf::guard::cancel {
199 ${$_[0]} = sub { };
200}
201
202sub cf::guard::DESTROY {
203 ${$_[0]}->();
204}
205
206=item cf::lock_wait $string 249=item cf::lock_wait $string
207 250
208Wait until the given lock is available. See cf::lock_acquire. 251Wait until the given lock is available. See cf::lock_acquire.
209 252
210=item my $lock = cf::lock_acquire $string 253=item my $lock = cf::lock_acquire $string
211 254
212Wait 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
213a 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,
214for example when the coroutine gets canceled), the lock is automatically 257for example when the coroutine gets canceled), the lock is automatically
215returned. 258returned.
216 259
217Lock names should begin with a unique identifier (for example, cf::map::find 260Lock names should begin with a unique identifier (for example, cf::map::find
218uses map_find and cf::map::load 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.
219 266
220=cut 267=cut
221 268
222our %LOCK; 269our %LOCK;
223 270
237 # wait, to be sure we are not locked 284 # wait, to be sure we are not locked
238 lock_wait $key; 285 lock_wait $key;
239 286
240 $LOCK{$key} = []; 287 $LOCK{$key} = [];
241 288
242 cf::guard { 289 Coro::guard {
243 # wake up all waiters, to be on the safe side 290 # wake up all waiters, to be on the safe side
244 $_->ready for @{ delete $LOCK{$key} }; 291 $_->ready for @{ delete $LOCK{$key} };
245 } 292 }
246} 293}
247 294
248=item cf::async { BLOCK } 295sub lock_active($) {
249
250Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
251error instead of exiting the server in case of a problem.
252
253=cut
254
255sub async(&) {
256 my ($cb) = @_; 296 my ($key) = @_;
257 297
258 Coro::async { 298 ! ! $LOCK{$key}
259 eval { $cb->() };
260 warn $@ if $@;
261 }
262} 299}
263 300
264sub freeze_mainloop { 301sub freeze_mainloop {
265 return unless $TICK_WATCHER->is_active; 302 return unless $TICK_WATCHER->is_active;
266 303
267 my $guard = guard { $TICK_WATCHER->start }; 304 my $guard = Coro::guard {
305 $TICK_WATCHER->start;
306 };
268 $TICK_WATCHER->stop; 307 $TICK_WATCHER->stop;
269 $guard 308 $guard
270} 309}
310
311=item cf::async { BLOCK }
312
313Currently the same as Coro::async_pool, meaning you cannot use
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.
316
317=cut
318
319BEGIN { *async = \&Coro::async_pool }
271 320
272=item cf::sync_job { BLOCK } 321=item cf::sync_job { BLOCK }
273 322
274The design of crossfire+ requires that the main coro ($Coro::main) is 323The design of crossfire+ requires that the main coro ($Coro::main) is
275always able to handle events or runnable, as crossfire+ is only partly 324always able to handle events or runnable, as crossfire+ is only partly
284 333
285sub sync_job(&) { 334sub sync_job(&) {
286 my ($job) = @_; 335 my ($job) = @_;
287 336
288 if ($Coro::current == $Coro::main) { 337 if ($Coro::current == $Coro::main) {
338 my $time = Event::time;
339
289 # this is the main coro, too bad, we have to block 340 # this is the main coro, too bad, we have to block
290 # till the operation succeeds, freezing the server :/ 341 # till the operation succeeds, freezing the server :/
291 342
292 # TODO: use suspend/resume instead 343 # TODO: use suspend/resume instead
293 # (but this is cancel-safe) 344 # (but this is cancel-safe)
294 my $freeze_guard = freeze_mainloop; 345 my $freeze_guard = freeze_mainloop;
295 346
296 my $busy = 1; 347 my $busy = 1;
297 my @res; 348 my @res;
298 349
299 (Coro::async { 350 (async {
300 @res = eval { $job->() }; 351 @res = eval { $job->() };
301 warn $@ if $@; 352 warn $@ if $@;
302 undef $busy; 353 undef $busy;
303 })->prio (Coro::PRIO_MAX); 354 })->prio (Coro::PRIO_MAX);
304 355
305 while ($busy) { 356 while ($busy) {
306 Coro::cede_notself; 357 Coro::cede or Event::one_event;
307 Event::one_event unless Coro::nready;
308 } 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
309 366
310 wantarray ? @res : $res[0] 367 wantarray ? @res : $res[0]
311 } else { 368 } else {
312 # we are in another coroutine, how wonderful, everything just works 369 # we are in another coroutine, how wonderful, everything just works
313 370
314 $job->() 371 $job->()
315 } 372 }
316} 373}
317 374
318=item $coro = cf::coro { BLOCK } 375=item $coro = cf::async_ext { BLOCK }
319 376
320Creates and returns a new coro. This coro is automcatially being canceled 377Like async, but this coro is automatically being canceled when the
321when the extension calling this is being unloaded. 378extension calling this is being unloaded.
322 379
323=cut 380=cut
324 381
325sub coro(&) { 382sub async_ext(&) {
326 my $cb = shift; 383 my $cb = shift;
327 384
328 my $coro = &cf::async ($cb); 385 my $coro = &Coro::async ($cb);
329 386
330 $coro->on_destroy (sub { 387 $coro->on_destroy (sub {
331 delete $EXT_CORO{$coro+0}; 388 delete $EXT_CORO{$coro+0};
332 }); 389 });
333 $EXT_CORO{$coro+0} = $coro; 390 $EXT_CORO{$coro+0} = $coro;
334 391
335 $coro 392 $coro
336} 393}
337 394
338sub write_runtime { 395sub write_runtime {
339 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";
340 404
341 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
342 or return; 406 or return;
343 407
408 my $value = $cf::RUNTIME + 90 + 10;
344 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
345 (aio_write $fh, 0, (length $value), $value, 0) <= 0 412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
346 and return; 413 and return;
347 414
415 # always fsync - this file is important
348 aio_fsync $fh 416 aio_fsync $fh
349 and return; 417 and return;
350 418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
351 close $fh 422 close $fh
352 or return; 423 or return;
353 424
354 aio_rename "$runtime~", $runtime 425 aio_rename "$runtime~", $runtime
355 and return; 426 and return;
356 427
428 warn "runtime file written.\n";
429
357 1 430 1
358} 431}
359 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
360=back 444=back
361 445
362=cut 446=cut
363
364#############################################################################
365
366package cf::path;
367
368sub new {
369 my ($class, $path, $base) = @_;
370
371 $path = $path->as_string if ref $path;
372
373 my $self = bless { }, $class;
374
375 # {... are special paths that are not touched
376 # ?xxx/... are special absolute paths
377 # ?random/... random maps
378 # /! non-realised random map exit
379 # /... normal maps
380 # ~/... per-player maps without a specific player (DO NOT USE)
381 # ~user/... per-player map of a specific user
382
383 if ($path =~ /^{/) {
384 # fine as it is
385 } elsif ($path =~ s{^\?random/}{}) {
386 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
387 $self->{random} = cf::from_json $data;
388 } else {
389 if ($path =~ s{^~([^/]+)?}{}) {
390 $self->{user_rel} = 1;
391
392 if (defined $1) {
393 $self->{user} = $1;
394 } elsif ($base =~ m{^~([^/]+)/}) {
395 $self->{user} = $1;
396 } else {
397 warn "cannot resolve user-relative path without user <$path,$base>\n";
398 }
399 } elsif ($path =~ /^\//) {
400 # already absolute
401 } else {
402 $base =~ s{[^/]+/?$}{};
403 return $class->new ("$base/$path");
404 }
405
406 for ($path) {
407 redo if s{/\.?/}{/};
408 redo if s{/[^/]+/\.\./}{/};
409 }
410 }
411
412 $self->{path} = $path;
413
414 $self
415}
416
417# the name / primary key / in-game path
418sub as_string {
419 my ($self) = @_;
420
421 $self->{user_rel} ? "~$self->{user}$self->{path}"
422 : $self->{random} ? "?random/$self->{path}"
423 : $self->{path}
424}
425
426# the displayed name, this is a one way mapping
427sub visible_name {
428 my ($self) = @_;
429
430# if (my $rmp = $self->{random}) {
431# # todo: be more intelligent about this
432# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
433# } else {
434 $self->as_string
435# }
436}
437
438# escape the /'s in the path
439sub _escaped_path {
440 # ∕ is U+2215
441 (my $path = $_[0]{path}) =~ s/\//∕/g;
442 $path
443}
444
445# the original (read-only) location
446sub load_path {
447 my ($self) = @_;
448
449 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
450}
451
452# the temporary/swap location
453sub save_path {
454 my ($self) = @_;
455
456 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
457 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
458 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
459}
460
461# the unique path, might be eq to save_path
462sub uniq_path {
463 my ($self) = @_;
464
465 $self->{user_rel} || $self->{random}
466 ? undef
467 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
468}
469
470# return random map parameters, or undef
471sub random_map_params {
472 my ($self) = @_;
473
474 $self->{random}
475}
476
477# this is somewhat ugly, but style maps do need special treatment
478sub is_style_map {
479 $_[0]{path} =~ m{^/styles/}
480}
481
482package cf;
483 447
484############################################################################# 448#############################################################################
485 449
486=head2 ATTACHABLE OBJECTS 450=head2 ATTACHABLE OBJECTS
487 451
613our @CB_TYPE = (); # registry for type (cf-object class) based events 577our @CB_TYPE = (); # registry for type (cf-object class) based events
614our @CB_MAP = (); 578our @CB_MAP = ();
615 579
616my %attachment; 580my %attachment;
617 581
582sub cf::attachable::thawer_merge {
583 # simply override everything except _meta
584 local $_[0]{_meta};
585 %{$_[0]} = %{$_[1]};
586}
587
618sub _attach_cb($$$$) { 588sub _attach_cb($$$$) {
619 my ($registry, $event, $prio, $cb) = @_; 589 my ($registry, $event, $prio, $cb) = @_;
620 590
621 use sort 'stable'; 591 use sort 'stable';
622 592
656 $registry = $CB_TYPE[$object_type] ||= []; 626 $registry = $CB_TYPE[$object_type] ||= [];
657 627
658 } elsif ($type eq "subtype") { 628 } elsif ($type eq "subtype") {
659 defined $object_type or Carp::croak "subtype specified without type"; 629 defined $object_type or Carp::croak "subtype specified without type";
660 my $object_subtype = shift @arg; 630 my $object_subtype = shift @arg;
661 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 631 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
662 632
663 } elsif ($type eq "package") { 633 } elsif ($type eq "package") {
664 my $pkg = shift @arg; 634 my $pkg = shift @arg;
665 635
666 while (my ($name, $id) = each %cb_id) { 636 while (my ($name, $id) = each %cb_id) {
707 if (ref $_[0]) { 677 if (ref $_[0]) {
708 _object_attach @_; 678 _object_attach @_;
709 } else { 679 } else {
710 _attach shift->_attach_registry, @_; 680 _attach shift->_attach_registry, @_;
711 } 681 }
682 _recalc_want;
712}; 683};
713 684
714# all those should be optimised 685# all those should be optimised
715sub cf::attachable::detach { 686sub cf::attachable::detach {
716 my ($obj, $name) = @_; 687 my ($obj, $name) = @_;
719 delete $obj->{_attachment}{$name}; 690 delete $obj->{_attachment}{$name};
720 reattach ($obj); 691 reattach ($obj);
721 } else { 692 } else {
722 Carp::croak "cannot, currently, detach class attachments"; 693 Carp::croak "cannot, currently, detach class attachments";
723 } 694 }
695 _recalc_want;
724}; 696};
725 697
726sub cf::attachable::attached { 698sub cf::attachable::attached {
727 my ($obj, $name) = @_; 699 my ($obj, $name) = @_;
728 700
793# object support 765# object support
794 766
795sub reattach { 767sub reattach {
796 # basically do the same as instantiate, without calling instantiate 768 # basically do the same as instantiate, without calling instantiate
797 my ($obj) = @_; 769 my ($obj) = @_;
770
771 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
798 772
799 my $registry = $obj->registry; 773 my $registry = $obj->registry;
800 774
801 @$registry = (); 775 @$registry = ();
802 776
849 $filename, length $$rdata, scalar @$objs; 823 $filename, length $$rdata, scalar @$objs;
850 824
851 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
852 chmod SAVE_MODE, $fh; 826 chmod SAVE_MODE, $fh;
853 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 827 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
854 aio_fsync $fh; 828 aio_fsync $fh if $cf::USE_FSYNC;
855 close $fh; 829 close $fh;
856 830
857 if (@$objs) { 831 if (@$objs) {
858 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) {
859 chmod SAVE_MODE, $fh; 833 chmod SAVE_MODE, $fh;
860 my $data = Storable::nfreeze { version => 1, objs => $objs }; 834 my $data = Storable::nfreeze { version => 1, objs => $objs };
861 aio_write $fh, 0, (length $data), $data, 0; 835 aio_write $fh, 0, (length $data), $data, 0;
862 aio_fsync $fh; 836 aio_fsync $fh if $cf::USE_FSYNC;
863 close $fh; 837 close $fh;
864 aio_rename "$filename.pst~", "$filename.pst"; 838 aio_rename "$filename.pst~", "$filename.pst";
865 } 839 }
866 } else { 840 } else {
867 aio_unlink "$filename.pst"; 841 aio_unlink "$filename.pst";
899 or return; 873 or return;
900 $av = eval { (Storable::thaw $av)->{objs} }; 874 $av = eval { (Storable::thaw $av)->{objs} };
901 } 875 }
902 876
903 warn sprintf "loading %s (%d)\n", 877 warn sprintf "loading %s (%d)\n",
904 $filename, length $data, scalar @{$av || []};#d# 878 $filename, length $data, scalar @{$av || []};
905 return ($data, $av); 879 return ($data, $av);
906} 880}
907 881
908############################################################################# 882#############################################################################
909# command handling &c 883# command handling &c
934=cut 908=cut
935 909
936sub register_extcmd { 910sub register_extcmd {
937 my ($name, $cb) = @_; 911 my ($name, $cb) = @_;
938 912
939 my $caller = caller;
940 #warn "registering extcmd '$name' to '$caller'";
941
942 $EXTCMD{$name} = [$cb, $caller]; 913 $EXTCMD{$name} = $cb;
943} 914}
944 915
945cf::player->attach ( 916cf::player->attach (
946 on_command => sub { 917 on_command => sub {
947 my ($pl, $name, $params) = @_; 918 my ($pl, $name, $params) = @_;
960 931
961 my $msg = eval { from_json $buf }; 932 my $msg = eval { from_json $buf };
962 933
963 if (ref $msg) { 934 if (ref $msg) {
964 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 935 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
965 if (my %reply = $cb->[0]->($pl, $msg)) { 936 if (my %reply = $cb->($pl, $msg)) {
966 $pl->ext_reply ($msg->{msgid}, %reply); 937 $pl->ext_reply ($msg->{msgid}, %reply);
967 } 938 }
968 } 939 }
969 } else { 940 } else {
970 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
972 943
973 cf::override; 944 cf::override;
974 }, 945 },
975); 946);
976 947
977sub register {
978 my ($base, $pkg) = @_;
979
980 #TODO
981}
982
983sub 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($) {
984 my ($path) = @_; 1260 my ($path) = @_;
985 1261
986 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1262 my ($match, $specificity);
987 my $base = $1;
988 my $pkg = $1;
989 $pkg =~ s/[^[:word:]]/_/g;
990 $pkg = "ext::$pkg";
991 1263
992 warn "loading '$path' into '$pkg'\n"; 1264 for my $region (list) {
993 1265 if ($region->match && $path =~ $region->match) {
994 open my $fh, "<:utf8", $path 1266 ($match, $specificity) = ($region, $region->specificity)
995 or die "$path: $!"; 1267 if $region->specificity > $specificity;
996 1268 }
997 my $source =
998 "package $pkg; use strict; use utf8;\n"
999 . "#line 1 \"$path\"\n{\n"
1000 . (do { local $/; <$fh> })
1001 . "\n};\n1";
1002
1003 eval $source
1004 or die $@ ? "$path: $@\n"
1005 : "extension disabled.\n";
1006
1007 push @exts, $pkg;
1008 $ext_pkg{$base} = $pkg;
1009
1010# no strict 'refs';
1011# @{"$pkg\::ISA"} = ext::;
1012
1013 register $base, $pkg;
1014}
1015
1016sub unload_extension {
1017 my ($pkg) = @_;
1018
1019 warn "removing extension $pkg\n";
1020
1021 # remove hooks
1022 #TODO
1023# for my $idx (0 .. $#PLUGIN_EVENT) {
1024# delete $hook[$idx]{$pkg};
1025# } 1269 }
1026 1270
1027 # remove commands 1271 $match
1028 for my $name (keys %COMMAND) {
1029 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1030
1031 if (@cb) {
1032 $COMMAND{$name} = \@cb;
1033 } else {
1034 delete $COMMAND{$name};
1035 }
1036 }
1037
1038 # remove extcmds
1039 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1040 delete $EXTCMD{$name};
1041 }
1042
1043 if (my $cb = $pkg->can ("unload")) {
1044 eval {
1045 $cb->($pkg);
1046 1
1047 } or warn "$pkg unloaded, but with errors: $@";
1048 }
1049
1050 Symbol::delete_package $pkg;
1051}
1052
1053sub load_extensions {
1054 for my $ext (<$LIBDIR/*.ext>) {
1055 next unless -r $ext;
1056 eval {
1057 load_extension $ext;
1058 1
1059 } or warn "$ext not loaded: $@";
1060 }
1061}
1062
1063#############################################################################
1064# load/save/clean perl data associated with a map
1065
1066*cf::mapsupport::on_clean = sub {
1067 my ($map) = @_;
1068
1069 my $path = $map->tmpname;
1070 defined $path or return;
1071
1072 unlink "$path.pst";
1073};
1074
1075cf::map->attach (prio => -10000, package => cf::mapsupport::);
1076
1077#############################################################################
1078# load/save perl data associated with player->ob objects
1079
1080sub all_objects(@) {
1081 @_, map all_objects ($_->inv), @_
1082}
1083
1084# TODO: compatibility cruft, remove when no longer needed
1085cf::player->attach (
1086 on_load => sub {
1087 my ($pl, $path) = @_;
1088
1089 for my $o (all_objects $pl->ob) {
1090 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1091 $o->set_ob_key_value ("_perl_data");
1092
1093 %$o = %{ Storable::thaw pack "H*", $value };
1094 }
1095 }
1096 },
1097);
1098
1099#############################################################################
1100
1101=head2 CORE EXTENSIONS
1102
1103Functions and methods that extend core crossfire objects.
1104
1105=head3 cf::player
1106
1107=over 4
1108
1109=item cf::player::exists $login
1110
1111Returns true when the given account exists.
1112
1113=cut
1114
1115sub cf::player::exists($) {
1116 cf::player::find $_[0]
1117 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1118}
1119
1120=item $player->ext_reply ($msgid, $msgtype, %msg)
1121
1122Sends an ext reply to the player.
1123
1124=cut
1125
1126sub cf::player::ext_reply($$$%) {
1127 my ($self, $id, %msg) = @_;
1128
1129 $msg{msgid} = $id;
1130
1131 $self->send ("ext " . to_json \%msg);
1132} 1272}
1133 1273
1134=back 1274=back
1135
1136 1275
1137=head3 cf::map 1276=head3 cf::map
1138 1277
1139=over 4 1278=over 4
1140 1279
1143package cf::map; 1282package cf::map;
1144 1283
1145use Fcntl; 1284use Fcntl;
1146use Coro::AIO; 1285use Coro::AIO;
1147 1286
1287use overload
1288 '""' => \&as_string,
1289 fallback => 1;
1290
1148our $MAX_RESET = 3600; 1291our $MAX_RESET = 3600;
1149our $DEFAULT_RESET = 3000; 1292our $DEFAULT_RESET = 3000;
1150 1293
1151sub generate_random_map { 1294sub generate_random_map {
1152 my ($path, $rmp) = @_; 1295 my ($self, $rmp) = @_;
1153
1154 # mit "rum" bekleckern, nicht 1296 # mit "rum" bekleckern, nicht
1155 cf::map::_create_random_map 1297 $self->_create_random_map (
1156 $path,
1157 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1298 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1158 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1299 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1159 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1300 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1160 $rmp->{exit_on_final_map}, 1301 $rmp->{exit_on_final_map},
1161 $rmp->{xsize}, $rmp->{ysize}, 1302 $rmp->{xsize}, $rmp->{ysize},
1162 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1303 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1163 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1304 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1164 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1305 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1165 $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},
1166 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1307 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1167 (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"
1168} 1437}
1169 1438
1170# and all this just because we cannot iterate over 1439# and all this just because we cannot iterate over
1171# all maps in C++... 1440# all maps in C++...
1172sub change_all_map_light { 1441sub change_all_map_light {
1174 1443
1175 $_->change_map_light ($change) 1444 $_->change_map_light ($change)
1176 for grep $_->outdoor, values %cf::MAP; 1445 for grep $_->outdoor, values %cf::MAP;
1177} 1446}
1178 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
1179sub try_load_header($) { 1464sub load_header_from($) {
1180 my ($path) = @_; 1465 my ($self, $path) = @_;
1181 1466
1182 utf8::encode $path; 1467 utf8::encode $path;
1183 aio_open $path, O_RDONLY, 0 1468 #aio_open $path, O_RDONLY, 0
1469 # or return;
1470
1471 $self->_load_header ($path)
1184 or return; 1472 or return;
1185 1473
1186 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
1187 or return; 1517 or return;
1518 $self->prepare_orig;
1519 }
1188 1520
1189 $map->load_header ($path) 1521 $self->{deny_reset} = 1
1190 or return; 1522 if $self->no_reset;
1191 1523
1192 $map->{load_path} = $path; 1524 $self->default_region (cf::region::find_by_path $self->{path})
1525 unless $self->default_region;
1193 1526
1194 $map 1527 1
1195} 1528}
1196 1529
1197sub find; 1530sub find;
1198sub find { 1531sub find {
1199 my ($path, $origin) = @_; 1532 my ($path, $origin) = @_;
1200 1533
1201 #warn "find<$path,$origin>\n";#d#
1202
1203 $path = new cf::path $path, $origin && $origin->path; 1534 $path = normalise $path, $origin && $origin->path;
1204 my $key = $path->as_string;
1205 1535
1206 cf::lock_wait "map_find:$key"; 1536 cf::lock_wait "map_find:$path";
1207 1537
1208 $cf::MAP{$key} || do { 1538 $cf::MAP{$path} || do {
1209 my $guard = cf::lock_acquire "map_find:$key"; 1539 my $guard = cf::lock_acquire "map_find:$path";
1210 1540 my $map = new_from_path cf::map $path
1211 # do it the slow way
1212 my $map = try_load_header $path->save_path;
1213
1214 if ($map) {
1215 $map->last_access ((delete $map->{last_access})
1216 || $cf::RUNTIME); #d#
1217 # safety
1218 $map->{instantiate_time} = $cf::RUNTIME
1219 if $map->{instantiate_time} > $cf::RUNTIME;
1220 } else {
1221 if (my $rmp = $path->random_map_params) {
1222 $map = generate_random_map $key, $rmp;
1223 } else {
1224 $map = try_load_header $path->load_path;
1225 }
1226
1227 $map or return; 1541 or return;
1228 1542
1229 $map->{load_original} = 1;
1230 $map->{instantiate_time} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME);
1232 $map->instantiate;
1233
1234 # per-player maps become, after loading, normal maps
1235 $map->per_player (0) if $path->{user_rel};
1236 }
1237
1238 $map->path ($key);
1239 $map->{path} = $path;
1240 $map->{last_save} = $cf::RUNTIME; 1543 $map->{last_save} = $cf::RUNTIME;
1241 1544
1242 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;
1243 $map->reset; 1551 $map->reset;
1244 undef $guard; 1552 undef $guard;
1245 $map = find $path 1553 return find $path;
1246 or return;
1247 } 1554 }
1248 1555
1249 $cf::MAP{$key} = $map 1556 $cf::MAP{$path} = $map
1250 } 1557 }
1251} 1558}
1559
1560sub pre_load { }
1561sub post_load { }
1252 1562
1253sub load { 1563sub load {
1254 my ($self) = @_; 1564 my ($self) = @_;
1255 1565
1566 local $self->{deny_reset} = 1; # loading can take a long time
1567
1256 my $path = $self->{path}; 1568 my $path = $self->{path};
1569
1570 {
1257 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1571 my $guard = cf::lock_acquire "map_load:$path";
1258 1572
1259 return if $self->in_memory != cf::MAP_SWAPPED; 1573 return if $self->in_memory != cf::MAP_SWAPPED;
1260 1574
1261 $self->in_memory (cf::MAP_LOADING); 1575 $self->in_memory (cf::MAP_LOADING);
1262 1576
1263 $self->alloc; 1577 $self->alloc;
1578
1579 $self->pre_load;
1580 Coro::cede;
1581
1264 $self->load_objects ($self->{load_path}, 1) 1582 $self->_load_objects ($self->{load_path}, 1)
1265 or return; 1583 or return;
1266 1584
1267 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1585 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1268 if delete $self->{load_original}; 1586 if delete $self->{load_original};
1269 1587
1270 if (my $uniq = $path->uniq_path) { 1588 if (my $uniq = $self->uniq_path) {
1271 utf8::encode $uniq; 1589 utf8::encode $uniq;
1272 if (aio_open $uniq, O_RDONLY, 0) { 1590 if (aio_open $uniq, O_RDONLY, 0) {
1273 $self->clear_unique_items; 1591 $self->clear_unique_items;
1274 $self->load_objects ($uniq, 0); 1592 $self->_load_objects ($uniq, 0);
1275 } 1593 }
1276 } 1594 }
1277 1595
1596 Coro::cede;
1278 # now do the right thing for maps 1597 # now do the right thing for maps
1279 $self->link_multipart_objects; 1598 $self->link_multipart_objects;
1280
1281 if ($self->{path}->is_style_map) {
1282 $self->{deny_save} = 1;
1283 $self->{deny_reset} = 1;
1284 } else {
1285 $self->fix_auto_apply;
1286 $self->decay_objects;
1287 $self->update_buttons;
1288 $self->set_darkness_map;
1289 $self->difficulty ($self->estimate_difficulty) 1599 $self->difficulty ($self->estimate_difficulty)
1290 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;
1291 $self->activate; 1610 $self->activate;
1292 } 1611 }
1293 1612
1294 $self->in_memory (cf::MAP_IN_MEMORY); 1613 $self->in_memory (cf::MAP_IN_MEMORY);
1614 }
1615
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 }
1295} 1653}
1296 1654
1297sub find_sync { 1655sub find_sync {
1298 my ($path, $origin) = @_; 1656 my ($path, $origin) = @_;
1299 1657
1300 cf::sync_job { cf::map::find $path, $origin } 1658 cf::sync_job { find $path, $origin }
1301} 1659}
1302 1660
1303sub do_load_sync { 1661sub do_load_sync {
1304 my ($map) = @_; 1662 my ($map) = @_;
1305 1663
1306 cf::sync_job { $map->load }; 1664 cf::sync_job { $map->load };
1307} 1665}
1308 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;
1685 $map->load;
1686
1687 delete $MAP_PREFETCH{$path};
1688 }
1689 }
1690 undef $MAP_PREFETCHER;
1691 };
1692 $MAP_PREFETCHER->prio (6);
1693
1694 ()
1695}
1696
1309sub save { 1697sub save {
1310 my ($self) = @_; 1698 my ($self) = @_;
1311 1699
1700 my $lock = cf::lock_acquire "map_data:" . $self->path;
1701
1312 $self->{last_save} = $cf::RUNTIME; 1702 $self->{last_save} = $cf::RUNTIME;
1313 1703
1314 return unless $self->dirty; 1704 return unless $self->dirty;
1315 1705
1316 my $save = $self->{path}->save_path; utf8::encode $save; 1706 my $save = $self->save_path; utf8::encode $save;
1317 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1707 my $uniq = $self->uniq_path; utf8::encode $uniq;
1318 1708
1319 $self->{load_path} = $save; 1709 $self->{load_path} = $save;
1320 1710
1321 return if $self->{deny_save}; 1711 return if $self->{deny_save};
1322 1712
1323 local $self->{last_access} = $self->last_access;#d# 1713 local $self->{last_access} = $self->last_access;#d#
1324 1714
1715 cf::async {
1716 $_->contr->save for $self->players;
1717 };
1718
1325 if ($uniq) { 1719 if ($uniq) {
1326 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1720 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1327 $self->save_objects ($uniq, cf::IO_UNIQUES); 1721 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1328 } else { 1722 } else {
1329 $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);
1330 } 1724 }
1331} 1725}
1332 1726
1333sub swap_out { 1727sub swap_out {
1334 my ($self) = @_; 1728 my ($self) = @_;
1335 1729
1336 # save first because save cedes 1730 # save first because save cedes
1337 $self->save; 1731 $self->save;
1732
1733 my $lock = cf::lock_acquire "map_data:" . $self->path;
1338 1734
1339 return if $self->players; 1735 return if $self->players;
1340 return if $self->in_memory != cf::MAP_IN_MEMORY; 1736 return if $self->in_memory != cf::MAP_IN_MEMORY;
1341 return if $self->{deny_save}; 1737 return if $self->{deny_save};
1342 1738
1346 1742
1347sub reset_at { 1743sub reset_at {
1348 my ($self) = @_; 1744 my ($self) = @_;
1349 1745
1350 # TODO: safety, remove and allow resettable per-player maps 1746 # TODO: safety, remove and allow resettable per-player maps
1351 return 1e99 if $self->{path}{user_rel};
1352 return 1e99 if $self->{deny_reset}; 1747 return 1e99 if $self->{deny_reset};
1353 1748
1354 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1749 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1355 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;
1356 1751
1361 my ($self) = @_; 1756 my ($self) = @_;
1362 1757
1363 $self->reset_at <= $cf::RUNTIME 1758 $self->reset_at <= $cf::RUNTIME
1364} 1759}
1365 1760
1366sub unlink_save {
1367 my ($self) = @_;
1368
1369 utf8::encode (my $save = $self->{path}->save_path);
1370 aioreq_pri 3; IO::AIO::aio_unlink $save;
1371 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1372}
1373
1374sub rename {
1375 my ($self, $new_path) = @_;
1376
1377 $self->unlink_save;
1378
1379 delete $cf::MAP{$self->path};
1380 $self->{path} = new cf::path $new_path;
1381 $self->path ($self->{path}->as_string);
1382 $cf::MAP{$self->path} = $self;
1383
1384 $self->save;
1385}
1386
1387sub reset { 1761sub reset {
1388 my ($self) = @_; 1762 my ($self) = @_;
1389 1763
1764 my $lock = cf::lock_acquire "map_data:$self->{path}";
1765
1390 return if $self->players; 1766 return if $self->players;
1391 return if $self->{path}{user_rel};#d#
1392 1767
1393 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 }
1394 1779
1395 delete $cf::MAP{$self->path}; 1780 delete $cf::MAP{$self->path};
1781
1782 $self->clear;
1396 1783
1397 $_->clear_links_to ($self) for values %cf::MAP; 1784 $_->clear_links_to ($self) for values %cf::MAP;
1398 1785
1399 $self->unlink_save; 1786 $self->unlink_save;
1400 $self->destroy; 1787 $self->destroy;
1403my $nuke_counter = "aaaa"; 1790my $nuke_counter = "aaaa";
1404 1791
1405sub nuke { 1792sub nuke {
1406 my ($self) = @_; 1793 my ($self) = @_;
1407 1794
1795 delete $cf::MAP{$self->path};
1796
1797 $self->unlink_save;
1798
1799 bless $self, "cf::map";
1800 delete $self->{deny_reset};
1408 $self->{deny_save} = 1; 1801 $self->{deny_save} = 1;
1409 $self->reset_timeout (1); 1802 $self->reset_timeout (1);
1410 $self->rename ("{nuke}/" . ($nuke_counter++)); 1803 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1804
1805 $cf::MAP{$self->path} = $self;
1806
1411 $self->reset; # polite request, might not happen 1807 $self->reset; # polite request, might not happen
1412} 1808}
1413 1809
1414sub customise_for { 1810=item $maps = cf::map::tmp_maps
1415 my ($map, $ob) = @_;
1416 1811
1417 if ($map->per_player) { 1812Returns an arrayref with all map paths of currently instantiated and saved
1418 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 1813maps. May block.
1814
1815=cut
1816
1817sub tmp_maps() {
1419 } 1818 [
1420 1819 map {
1421 $map 1820 utf8::decode $_;
1821 /\.map$/
1822 ? normalise $_
1823 : ()
1824 } @{ aio_readdir $TMPDIR or [] }
1825 ]
1422} 1826}
1423 1827
1424sub emergency_save { 1828=item $maps = cf::map::random_maps
1425 my $freeze_guard = cf::freeze_mainloop;
1426 1829
1427 warn "enter emergency map save\n"; 1830Returns an arrayref with all map paths of currently instantiated and saved
1831random maps. May block.
1428 1832
1429 cf::sync_job { 1833=cut
1430 warn "begin emergency map save\n";
1431 $_->save for values %cf::MAP;
1432 };
1433 1834
1434 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 ]
1435} 1862}
1436 1863
1437package cf; 1864package cf;
1438 1865
1439=back 1866=back
1440 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
1441 1894
1442=head3 cf::object::player 1895=head3 cf::object::player
1443 1896
1444=over 4 1897=over 4
1445 1898
1485 1938
1486=item $player_object->enter_link 1939=item $player_object->enter_link
1487 1940
1488Freezes 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}>).
1489 1942
1490The 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
1491I<MUST> call C<leave_link> as soon as possible, though. 1944I<MUST> call C<leave_link> as soon as possible, though.
1492 1945
1946Will never block.
1947
1493=item $player_object->leave_link ($map, $x, $y) 1948=item $player_object->leave_link ($map, $x, $y)
1494 1949
1495Moves 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
1496map 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
1497location 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
1498to the emergency map position. 1953fails, to the emergency map position.
1499 1954
1500Might block. 1955Might block.
1501 1956
1502=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}
1503 1968
1504sub cf::object::player::enter_link { 1969sub cf::object::player::enter_link {
1505 my ($self) = @_; 1970 my ($self) = @_;
1506 1971
1507 $self->deactivate_recursive; 1972 $self->deactivate_recursive;
1508 1973
1509 return if $self->map == $LINK_MAP; 1974 return if UNIVERSAL::isa $self->map, "ext::map_link";
1510 1975
1511 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1976 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1512 if $self->map; 1977 if $self->map && $self->map->{path} ne "{link}";
1513 1978
1514 $self->enter_map ($LINK_MAP, 20, 20); 1979 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1515} 1980}
1516 1981
1517sub cf::object::player::leave_link { 1982sub cf::object::player::leave_link {
1518 my ($self, $map, $x, $y) = @_; 1983 my ($self, $map, $x, $y) = @_;
1984
1985 return unless $self->contr->active;
1519 1986
1520 my $link_pos = delete $self->{_link_pos}; 1987 my $link_pos = delete $self->{_link_pos};
1521 1988
1522 unless ($map) { 1989 unless ($map) {
1523 # restore original map position 1990 # restore original map position
1537 # use -1 or undef as default coordinates, not 0, 0 2004 # use -1 or undef as default coordinates, not 0, 0
1538 ($x, $y) = ($map->enter_x, $map->enter_y) 2005 ($x, $y) = ($map->enter_x, $map->enter_y)
1539 if $x <=0 && $y <= 0; 2006 if $x <=0 && $y <= 0;
1540 2007
1541 $map->load; 2008 $map->load;
2009 $map->load_diag;
1542 2010
2011 return unless $self->contr->active;
1543 $self->activate_recursive; 2012 $self->activate_recursive;
2013
2014 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1544 $self->enter_map ($map, $x, $y); 2015 $self->enter_map ($map, $x, $y);
1545} 2016}
1546 2017
1547cf::player->attach (
1548 on_logout => sub {
1549 my ($pl) = @_;
1550
1551 # abort map switching before logout
1552 if ($pl->ob->{_link_pos}) {
1553 cf::sync_job {
1554 $pl->ob->leave_link
1555 };
1556 }
1557 },
1558 on_login => sub {
1559 my ($pl) = @_;
1560
1561 # try to abort aborted map switching on player login :)
1562 # should happen only on crashes
1563 if ($pl->ob->{_link_pos}) {
1564 $pl->ob->enter_link;
1565 cf::async {
1566 # we need this sleep as the login has a concurrent enter_exit running
1567 # and this sleep increases chances of the player not ending up in scorn
1568 Coro::Timer::sleep 1;
1569 $pl->ob->leave_link;
1570 };
1571 }
1572 },
1573);
1574
1575=item $player_object->goto_map ($path, $x, $y) 2018=item $player_object->goto ($path, $x, $y[, $check->($map)])
1576 2019
1577=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.
1578 2024
2025=cut
2026
2027our $GOTOGEN;
2028
1579sub cf::object::player::goto_map { 2029sub cf::object::player::goto {
1580 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;
1581 2034
1582 $self->enter_link; 2035 $self->enter_link;
1583 2036
1584 (cf::async { 2037 (async {
1585 $path = new cf::path $path; 2038 my $map = eval {
1586
1587 my $map = cf::map::find $path->as_string; 2039 my $map = cf::map::find $path;
2040
2041 if ($map) {
1588 $map = $map->customise_for ($self) if $map; 2042 $map = $map->customise_for ($self);
1589 2043 $map = $check->($map) if $check && $map;
1590# warn "entering ", $map->path, " at ($x, $y)\n" 2044 } else {
1591# if $map;
1592
1593 $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 }
1594 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};
1595 $self->leave_link ($map, $x, $y); 2058 $self->leave_link ($map, $x, $y);
2059 }
1596 })->prio (1); 2060 })->prio (1);
1597} 2061}
1598 2062
1599=item $player_object->enter_exit ($exit_object) 2063=item $player_object->enter_exit ($exit_object)
1600 2064
1602 2066
1603sub parse_random_map_params { 2067sub parse_random_map_params {
1604 my ($spec) = @_; 2068 my ($spec) = @_;
1605 2069
1606 my $rmp = { # defaults 2070 my $rmp = { # defaults
1607 xsize => 10, 2071 xsize => (cf::rndm 15, 40),
1608 ysize => 10, 2072 ysize => (cf::rndm 15, 40),
2073 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2074 #layout => string,
1609 }; 2075 };
1610 2076
1611 for (split /\n/, $spec) { 2077 for (split /\n/, $spec) {
1612 my ($k, $v) = split /\s+/, $_, 2; 2078 my ($k, $v) = split /\s+/, $_, 2;
1613 2079
1617 $rmp 2083 $rmp
1618} 2084}
1619 2085
1620sub prepare_random_map { 2086sub prepare_random_map {
1621 my ($exit) = @_; 2087 my ($exit) = @_;
2088
2089 my $guard = cf::lock_acquire "exit_prepare:$exit";
1622 2090
1623 # all this does is basically replace the /! path by 2091 # all this does is basically replace the /! path by
1624 # a new random map path (?random/...) with a seed 2092 # a new random map path (?random/...) with a seed
1625 # that depends on the exit object 2093 # that depends on the exit object
1626 2094
1627 my $rmp = parse_random_map_params $exit->msg; 2095 my $rmp = parse_random_map_params $exit->msg;
1628 2096
1629 if ($exit->map) { 2097 if ($exit->map) {
1630 $rmp->{region} = $exit->map->region_name; 2098 $rmp->{region} = $exit->region->name;
1631 $rmp->{origin_map} = $exit->map->path; 2099 $rmp->{origin_map} = $exit->map->path;
1632 $rmp->{origin_x} = $exit->x; 2100 $rmp->{origin_x} = $exit->x;
1633 $rmp->{origin_y} = $exit->y; 2101 $rmp->{origin_y} = $exit->y;
1634 } 2102 }
1635 2103
1636 $rmp->{random_seed} ||= $exit->random_seed; 2104 $rmp->{random_seed} ||= $exit->random_seed;
1637 2105
1638 my $data = cf::to_json $rmp; 2106 my $data = cf::to_json $rmp;
1639 my $md5 = Digest::MD5::md5_hex $data; 2107 my $md5 = Digest::MD5::md5_hex $data;
2108 my $meta = "$RANDOMDIR/$md5.meta";
1640 2109
1641 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) {
1642 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;
1643 2114
1644 $exit->slaying ("?random/$md5"); 2115 $exit->slaying ("?random/$md5");
1645 $exit->msg (undef); 2116 $exit->msg (undef);
1646 } 2117 }
1647} 2118}
1649sub cf::object::player::enter_exit { 2120sub cf::object::player::enter_exit {
1650 my ($self, $exit) = @_; 2121 my ($self, $exit) = @_;
1651 2122
1652 return unless $self->type == cf::PLAYER; 2123 return unless $self->type == cf::PLAYER;
1653 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
1654 $self->enter_link; 2136 $self->enter_link;
1655 2137
1656 (cf::async { 2138 (async {
1657 $self->deactivate_recursive; # just to be sure 2139 $self->deactivate_recursive; # just to be sure
1658 unless (eval { 2140 unless (eval {
1659 prepare_random_map $exit 2141 $self->goto ($slaying, $hp, $sp);
1660 if $exit->slaying eq "/!";
1661
1662 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1663 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1664 2142
1665 1; 2143 1;
1666 }) { 2144 }) {
1667 $self->message ("Something went wrong deep within the crossfire server. " 2145 $self->message ("Something went wrong deep within the crossfire server. "
1668 . "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. "
1669 . "Please report this to the dungeon master", 2147 . "Please report this to the dungeon master!",
1670 cf::NDI_UNIQUE | cf::NDI_RED); 2148 cf::NDI_UNIQUE | cf::NDI_RED);
1671 2149
1672 warn "ERROR in enter_exit: $@"; 2150 warn "ERROR in enter_exit: $@";
1673 $self->leave_link; 2151 $self->leave_link;
1674 } 2152 }
1675 })->prio (1); 2153 })->prio (1);
1688 2166
1689sub cf::client::send_drawinfo { 2167sub cf::client::send_drawinfo {
1690 my ($self, $text, $flags) = @_; 2168 my ($self, $text, $flags) = @_;
1691 2169
1692 utf8::encode $text; 2170 utf8::encode $text;
1693 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2171 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1694} 2172}
1695 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}
1696 2186
1697=item $success = $client->query ($flags, "text", \&cb) 2187=item $success = $client->query ($flags, "text", \&cb)
1698 2188
1699Queues a query to the client, calling the given callback with 2189Queues a query to the client, calling the given callback with
1700the 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>,
1729 # get handled first 2219 # get handled first
1730 my $queue = delete $ns->{query_queue} 2220 my $queue = delete $ns->{query_queue}
1731 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
1732 2222
1733 (shift @$queue)->[1]->($msg); 2223 (shift @$queue)->[1]->($msg);
2224 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1734 2225
1735 push @{ $ns->{query_queue} }, @$queue; 2226 push @{ $ns->{query_queue} }, @$queue;
1736 2227
1737 if (@{ $ns->{query_queue} } == @$queue) { 2228 if (@{ $ns->{query_queue} } == @$queue) {
1738 if (@$queue) { 2229 if (@$queue) {
1742 } 2233 }
1743 } 2234 }
1744 }, 2235 },
1745); 2236);
1746 2237
1747=item $client->coro (\&cb) 2238=item $client->async (\&cb)
1748 2239
1749Create a new coroutine, running the specified callback. The coroutine will 2240Create a new coroutine, running the specified callback. The coroutine will
1750be automatically cancelled when the client gets destroyed (e.g. on logout, 2241be automatically cancelled when the client gets destroyed (e.g. on logout,
1751or loss of connection). 2242or loss of connection).
1752 2243
1753=cut 2244=cut
1754 2245
1755sub cf::client::coro { 2246sub cf::client::async {
1756 my ($self, $cb) = @_; 2247 my ($self, $cb) = @_;
1757 2248
1758 my $coro = &cf::async ($cb); 2249 my $coro = &Coro::async ($cb);
1759 2250
1760 $coro->on_destroy (sub { 2251 $coro->on_destroy (sub {
1761 delete $self->{_coro}{$coro+0}; 2252 delete $self->{_coro}{$coro+0};
1762 }); 2253 });
1763 2254
1796 2287
1797# here we export the classes and methods available to script code 2288# here we export the classes and methods available to script code
1798 2289
1799=pod 2290=pod
1800 2291
1801The following fucntions and emthods are available within a safe environment: 2292The following functions and methods are available within a safe environment:
1802 2293
1803 cf::object contr pay_amount pay_player map 2294 cf::object contr pay_amount pay_player map
1804 cf::object::player player 2295 cf::object::player player
1805 cf::player peaceful 2296 cf::player peaceful
1806 cf::map trigger 2297 cf::map trigger
1891############################################################################# 2382#############################################################################
1892 2383
1893=head2 EXTENSION DATABASE SUPPORT 2384=head2 EXTENSION DATABASE SUPPORT
1894 2385
1895Crossfire maintains a very simple database for extension use. It can 2386Crossfire maintains a very simple database for extension use. It can
1896currently store anything that can be serialised using Storable, which 2387currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1897excludes objects. 2388convert to/from binary).
1898 2389
1899The 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
1900using it, it should be unique. 2391using it, it should be unique.
1901 2392
1902=over 4 2393=over 4
1903 2394
1904=item $hashref = cf::db_get $family
1905
1906Return a hashref for use by the extension C<$family>, which can be
1907modified. After modifications, you have to call C<cf::db_dirty> or
1908C<cf::db_sync>.
1909
1910=item $value = cf::db_get $family => $key 2395=item $value = cf::db_get $family => $key
1911 2396
1912Returns a single value from the database 2397Returns a single value from the database.
1913
1914=item cf::db_put $family => $hashref
1915
1916Stores the given family hashref into the database. Updates are delayed, if
1917you want the data to be synced to disk immediately, use C<cf::db_sync>.
1918 2398
1919=item cf::db_put $family => $key => $value 2399=item cf::db_put $family => $key => $value
1920 2400
1921Stores the given C<$value> in the family hash. Updates are delayed, if you 2401Stores the given C<$value> in the family.
1922want the data to be synced to disk immediately, use C<cf::db_sync>.
1923
1924=item cf::db_dirty
1925
1926Marks the database as dirty, to be updated at a later time.
1927
1928=item cf::db_sync
1929
1930Immediately write the database to disk I<if it is dirty>.
1931 2402
1932=cut 2403=cut
1933 2404
1934our $DB; 2405our $DB;
1935 2406
1936{ 2407sub db_init {
1937 my $path = cf::localdir . "/database.pst"; 2408 unless ($DB) {
2409 $DB = BDB::db_create $DB_ENV;
1938 2410
1939 sub db_load() { 2411 cf::sync_job {
1940 $DB = stat $path ? Storable::retrieve $path : { }; 2412 eval {
1941 } 2413 $DB->set_flags (BDB::CHKSUM);
1942 2414
1943 my $pid; 2415 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1944 2416 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1945 sub db_save() { 2417 cf::cleanup "db_open(db): $!" if $!;
1946 waitpid $pid, 0 if $pid; 2418 };
1947 if (0 == ($pid = fork)) { 2419 cf::cleanup "db_open(db): $@" if $@;
1948 $DB->{_meta}{version} = 1;
1949 Storable::nstore $DB, "$path~";
1950 rename "$path~", $path;
1951 cf::_exit 0 if defined $pid;
1952 } 2420 };
1953 }
1954
1955 my $dirty;
1956
1957 sub db_sync() {
1958 db_save if $dirty;
1959 undef $dirty;
1960 }
1961
1962 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1963 db_sync;
1964 }); 2421 }
2422}
1965 2423
1966 sub db_dirty() {
1967 $dirty = 1;
1968 $idle->start;
1969 }
1970
1971 sub db_get($;$) { 2424sub db_get($$) {
1972 @_ >= 2 2425 my $key = "$_[0]/$_[1]";
1973 ? $DB->{$_[0]}{$_[1]}
1974 : ($DB->{$_[0]} ||= { })
1975 }
1976 2426
2427 cf::sync_job {
2428 BDB::db_get $DB, undef, $key, my $data;
2429
2430 $! ? ()
2431 : $data
2432 }
2433}
2434
1977 sub db_put($$;$) { 2435sub db_put($$$) {
1978 if (@_ >= 3) { 2436 BDB::dbreq_pri 4;
1979 $DB->{$_[0]}{$_[1]} = $_[2]; 2437 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1980 } else { 2438}
1981 $DB->{$_[0]} = $_[1];
1982 }
1983 db_dirty;
1984 }
1985 2439
1986 cf::global->attach ( 2440=item cf::cache $id => [$paths...], $processversion => $process
1987 prio => 10000, 2441
1988 on_cleanup => sub { 2442Generic caching function that returns the value of the resource $id,
1989 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->[$_]: $!";
1990 }, 2472 }
1991 ); 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 }
1992} 2552}
1993 2553
1994############################################################################# 2554#############################################################################
1995# 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}
1996 2644
1997sub cfg_load { 2645sub cfg_load {
1998 open my $fh, "<:utf8", cf::confdir . "/config" 2646 open my $fh, "<:utf8", "$CONFDIR/config"
1999 or return; 2647 or return;
2000 2648
2001 local $/; 2649 local $/;
2002 *CFG = YAML::Syck::Load <$fh>; 2650 *CFG = YAML::Syck::Load <$fh>;
2003 2651
2004 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 2652 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2005 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
2006 if (exists $CFG{mlockall}) { 2657 if (exists $CFG{mlockall}) {
2007 eval { 2658 eval {
2008 $CFG{mlockall} ? &mlockall : &munlockall 2659 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2009 and die "WARNING: m(un)lockall failed: $!\n"; 2660 and die "WARNING: m(un)lockall failed: $!\n";
2010 }; 2661 };
2011 warn $@ if $@; 2662 warn $@ if $@;
2012 } 2663 }
2013} 2664}
2014 2665
2015sub main { 2666sub main {
2016 # we must not ever block the main coroutine 2667 # we must not ever block the main coroutine
2017 local $Coro::idle = sub { 2668 local $Coro::idle = sub {
2018 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#
2019 (Coro::unblock_sub { 2670 (async {
2020 Event::one_event; 2671 Event::one_event;
2021 })->(); 2672 })->prio (Coro::PRIO_MAX);
2022 }; 2673 };
2023 2674
2024 cfg_load; 2675 cfg_load;
2025 db_load; 2676 db_init;
2026 load_extensions; 2677 load_extensions;
2678
2679 $TICK_WATCHER->start;
2027 Event::loop; 2680 Event::loop;
2028} 2681}
2029 2682
2030############################################################################# 2683#############################################################################
2031# initialisation 2684# initialisation and cleanup
2032 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
2033sub reload() { 2741sub do_reload_perl() {
2034 # can/must only be called in main 2742 # can/must only be called in main
2035 if ($Coro::current != $Coro::main) { 2743 if ($Coro::current != $Coro::main) {
2036 warn "can only reload from main coroutine\n"; 2744 warn "can only reload from main coroutine";
2037 return; 2745 return;
2038 } 2746 }
2039 2747
2040 warn "reloading..."; 2748 warn "reloading...";
2041 2749
2042 my $guard = freeze_mainloop; 2750 warn "entering sync_job";
2751
2752 cf::sync_job {
2753 cf::write_runtime; # external watchdog should not bark
2043 cf::emergency_save; 2754 cf::emergency_save;
2755 cf::write_runtime; # external watchdog should not bark
2044 2756
2045 eval { 2757 warn "syncing database to disk";
2758 BDB::db_env_txn_checkpoint $DB_ENV;
2759
2046 # 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
2047 2761
2048 # cancel all watchers 2762 warn "cancelling all WF_AUTOCANCEL watchers";
2049 for (Event::all_watchers) { 2763 for (Event::all_watchers) {
2050 $_->cancel if $_->data & WF_AUTOCANCEL; 2764 $_->cancel if $_->data & WF_AUTOCANCEL;
2051 } 2765 }
2052 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
2053 # cancel all extension coros 2778 warn "cancelling all extension coros";
2054 $_->cancel for values %EXT_CORO; 2779 $_->cancel for values %EXT_CORO;
2055 %EXT_CORO = (); 2780 %EXT_CORO = ();
2056 2781
2057 # unload all extensions 2782 warn "removing commands";
2058 for (@exts) { 2783 %COMMAND = ();
2784
2785 warn "removing ext commands";
2786 %EXTCMD = ();
2787
2788 warn "unloading/nuking all extensions";
2789 for my $pkg (@EXTS) {
2059 warn "unloading <$_>"; 2790 warn "... unloading $pkg";
2060 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: $@";
2061 } 2797 }
2062 2798
2799 warn "... nuking $pkg";
2800 Symbol::delete_package $pkg;
2801 }
2802
2063 # unload all modules loaded from $LIBDIR 2803 warn "unloading all perl modules loaded from $LIBDIR";
2064 while (my ($k, $v) = each %INC) { 2804 while (my ($k, $v) = each %INC) {
2065 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2805 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2066 2806
2067 warn "removing <$k>"; 2807 warn "... unloading $k";
2068 delete $INC{$k}; 2808 delete $INC{$k};
2069 2809
2070 $k =~ s/\.pm$//; 2810 $k =~ s/\.pm$//;
2071 $k =~ s/\//::/g; 2811 $k =~ s/\//::/g;
2072 2812
2075 } 2815 }
2076 2816
2077 Symbol::delete_package $k; 2817 Symbol::delete_package $k;
2078 } 2818 }
2079 2819
2080 # sync database to disk
2081 cf::db_sync;
2082 IO::AIO::flush;
2083
2084 # get rid of safe::, as good as possible 2820 warn "getting rid of safe::, as good as possible";
2085 Symbol::delete_package "safe::$_" 2821 Symbol::delete_package "safe::$_"
2086 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);
2087 2823
2088 # remove register_script_function callbacks
2089 # TODO
2090
2091 # unload cf.pm "a bit" 2824 warn "unloading cf.pm \"a bit\"";
2092 delete $INC{"cf.pm"}; 2825 delete $INC{"cf.pm"};
2826 delete $INC{"cf/pod.pm"};
2093 2827
2094 # don't, removes xs symbols, too, 2828 # don't, removes xs symbols, too,
2095 # and global variables created in xs 2829 # and global variables created in xs
2096 #Symbol::delete_package __PACKAGE__; 2830 #Symbol::delete_package __PACKAGE__;
2097 2831
2098 # reload cf.pm 2832 warn "unload completed, starting to reload now";
2833
2099 warn "reloading cf.pm"; 2834 warn "reloading cf.pm";
2100 require cf; 2835 require cf;
2101 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2836 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2102 2837
2103 # load config and database again 2838 warn "loading config and database again";
2104 cf::cfg_load; 2839 cf::cfg_load;
2105 cf::db_load;
2106 2840
2107 # load extensions
2108 warn "load extensions"; 2841 warn "loading extensions";
2109 cf::load_extensions; 2842 cf::load_extensions;
2110 2843
2111 # reattach attachments to objects 2844 warn "reattaching attachments to objects/players";
2112 warn "reattach"; 2845 _global_reattach; # objects, sockets
2113 _global_reattach; 2846 warn "reattaching attachments to maps";
2114 }; 2847 reattach $_ for values %MAP;
2848 warn "reattaching attachments to players";
2849 reattach $_ for values %PLAYER;
2115 2850
2116 if ($@) { 2851 warn "leaving sync_job";
2852
2853 1
2854 } or do {
2117 warn $@; 2855 warn $@;
2118 warn "error while reloading, exiting."; 2856 warn "error while reloading, exiting.";
2119 exit 1; 2857 exit 1;
2120 } 2858 };
2121 2859
2122 warn "reloaded successfully"; 2860 warn "reloaded";
2123}; 2861};
2124 2862
2125############################################################################# 2863our $RELOAD_WATCHER; # used only during reload
2126 2864
2127unless ($LINK_MAP) { 2865sub reload_perl() {
2128 $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.
2129 2868
2130 $LINK_MAP->width (41); 2869 $RELOAD_WATCHER ||= Event->timer (
2131 $LINK_MAP->height (41); 2870 reentrant => 0,
2132 $LINK_MAP->alloc;
2133 $LINK_MAP->path ("{link}");
2134 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2135 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2136
2137 # dirty hack because... archetypes are not yet loaded
2138 Event->timer (
2139 after => 2, 2871 after => 0,
2872 data => WF_AUTOCANCEL,
2140 cb => sub { 2873 cb => sub {
2141 $_[0]->w->cancel; 2874 do_reload_perl;
2142 2875 undef $RELOAD_WATCHER;
2143 # provide some exits "home"
2144 my $exit = cf::object::new "exit";
2145
2146 $exit->slaying ($EMERGENCY_POSITION->[0]);
2147 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2148 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2149
2150 $LINK_MAP->insert ($exit->clone, 19, 19);
2151 $LINK_MAP->insert ($exit->clone, 19, 20);
2152 $LINK_MAP->insert ($exit->clone, 19, 21);
2153 $LINK_MAP->insert ($exit->clone, 20, 19);
2154 $LINK_MAP->insert ($exit->clone, 20, 21);
2155 $LINK_MAP->insert ($exit->clone, 21, 19);
2156 $LINK_MAP->insert ($exit->clone, 21, 20);
2157 $LINK_MAP->insert ($exit->clone, 21, 21);
2158
2159 $exit->destroy;
2160 }); 2876 },
2161 2877 );
2162 $LINK_MAP->{deny_save} = 1;
2163 $LINK_MAP->{deny_reset} = 1;
2164
2165 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2166} 2878}
2167
2168register "<global>", __PACKAGE__;
2169 2879
2170register_command "reload" => sub { 2880register_command "reload" => sub {
2171 my ($who, $arg) = @_; 2881 my ($who, $arg) = @_;
2172 2882
2173 if ($who->flag (FLAG_WIZ)) { 2883 if ($who->flag (FLAG_WIZ)) {
2174 $who->message ("start of reload.");
2175 reload;
2176 $who->message ("end of reload."); 2884 $who->message ("reloading server.");
2885 async { reload_perl };
2177 } 2886 }
2178}; 2887};
2179 2888
2180unshift @INC, $LIBDIR; 2889unshift @INC, $LIBDIR;
2181 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;
2182$TICK_WATCHER = Event->timer ( 2916$TICK_WATCHER = Event->timer (
2183 reentrant => 0, 2917 reentrant => 0,
2918 parked => 1,
2184 prio => 0, 2919 prio => 0,
2185 at => $NEXT_TICK || $TICK, 2920 at => $NEXT_TICK || $TICK,
2186 data => WF_AUTOCANCEL, 2921 data => WF_AUTOCANCEL,
2187 cb => sub { 2922 cb => sub {
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
2188 cf::server_tick; # one server iteration 2931 cf::server_tick; # one server iteration
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
2954 };
2955
2189 $RUNTIME += $TICK; 2956 $RUNTIME += $TICK;
2190 $NEXT_TICK += $TICK; 2957 $NEXT_TICK += $TICK;
2191 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
2192 # 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
2193 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2980 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2194 2981
2195 $TICK_WATCHER->at ($NEXT_TICK); 2982 $TICK_WATCHER->at ($NEXT_TICK);
2196 $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
2197 }, 2991 },
2198); 2992);
2199 2993
2994{
2200IO::AIO::max_poll_time $TICK * 0.2; 2995 BDB::max_poll_time $TICK * 0.1;
2201 2996 $BDB_POLL_WATCHER = Event->io (
2202Event->io ( 2997 reentrant => 0,
2203 fd => IO::AIO::poll_fileno, 2998 fd => BDB::poll_fileno,
2204 poll => 'r', 2999 poll => 'r',
2205 prio => 5, 3000 prio => 0,
2206 data => WF_AUTOCANCEL,
2207 cb => \&IO::AIO::poll_cb,
2208);
2209
2210Event->timer (
2211 data => WF_AUTOCANCEL, 3001 data => WF_AUTOCANCEL,
2212 after => 0, 3002 cb => \&BDB::poll_cb,
2213 interval => 10, 3003 );
2214 cb => sub { 3004 BDB::min_parallel 8;
2215 (Coro::unblock_sub { 3005
2216 write_runtime 3006 BDB::set_sync_prepare {
2217 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 $@;
2218 })->(); 3040 };
2219 }, 3041 }
2220); 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;
2221 3099
2222END { cf::emergency_save } 3100END { cf::emergency_save }
2223 3101
22241 31021
2225 3103

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines