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.128 by root, Wed Jan 3 00:28:47 2007 UTC vs.
Revision 1.275 by root, Thu Jun 7 19:12:22 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines