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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines