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.95 by root, Fri Dec 22 02:04:20 2006 UTC vs.
Revision 1.406 by root, Mon Dec 17 08:27:44 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Socket;
9use EV 1.86;
6use Opcode; 10use Opcode;
7use Safe; 11use Safe;
8use Safe::Hole; 12use Safe::Hole;
13use Storable ();
9 14
10use IO::AIO (); 15use Coro 4.32 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::EV;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::BDB;
24use Coro::Storable;
25use Coro::Util ();
26
27use JSON::XS 2.01 ();
28use BDB ();
29use Data::Dumper;
30use Digest::MD5;
31use Fcntl;
11use YAML::Syck (); 32use YAML::Syck ();
33use IO::AIO 2.51 ();
12use Time::HiRes; 34use Time::HiRes;
13use Event; 35use Compress::LZF;
14$Event::Eval = 1; # no idea why this is required, but it is 36use Digest::MD5 ();
37
38# configure various modules to our taste
39#
40$Storable::canonical = 1; # reduce rsync transfers
41Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
42Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
15 43
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
18 46
19use strict; 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20 48
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 50
23our %COMMAND = (); 51our %COMMAND = ();
24our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
53
54our @EXTS = (); # list of extension package names
25our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
57our %EXT_CORO = (); # coroutines bound to extensions
58our %EXT_MAP = (); # pluggable maps
26 59
27_init_vars; 60our $RELOAD; # number of reloads so far
28
29our @EVENT; 61our @EVENT;
30our $LIBDIR = datadir . "/ext";
31 62
32our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74our %RESOURCE;
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
33our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34our $NEXT_TICK; 80our $NEXT_TICK;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $BDB_DEADLOCK_WATCHER;
85our $BDB_CHECKPOINT_WATCHER;
86our $BDB_TRICKLE_WATCHER;
87our $DB_ENV;
35 88
36our %CFG; 89our %CFG;
37 90
38our $UPTIME; $UPTIME ||= time; 91our $UPTIME; $UPTIME ||= time;
92our $RUNTIME;
93our $NOW;
94
95our (%PLAYER, %PLAYER_LOADING); # all users
96our (%MAP, %MAP_LOADING ); # all maps
97our $LINK_MAP; # the special {link} map, which is always available
98
99# used to convert map paths into valid unix filenames by replacing / by ∕
100our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
101
102our $LOAD; # a number between 0 (idle) and 1 (too many objects)
103our $LOADAVG; # same thing, but with alpha-smoothing
104our $tick_start; # for load detecting purposes
105
106binmode STDOUT;
107binmode STDERR;
108
109# read virtual server time, if available
110unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
111 open my $fh, "<", "$LOCALDIR/runtime"
112 or die "unable to read runtime file: $!";
113 $RUNTIME = <$fh> + 0.;
114}
115
116mkdir $_
117 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
118
119our $EMERGENCY_POSITION;
120
121sub cf::map::normalise;
39 122
40############################################################################# 123#############################################################################
41 124
42=head2 GLOBAL VARIABLES 125=head2 GLOBAL VARIABLES
43 126
… …
45 128
46=item $cf::UPTIME 129=item $cf::UPTIME
47 130
48The timestamp of the server start (so not actually an uptime). 131The timestamp of the server start (so not actually an uptime).
49 132
50=item $cf::LIBDIR 133=item $cf::RUNTIME
51 134
52The perl library directory, where extensions and cf-specific modules can 135The time this server has run, starts at 0 and is increased by $cf::TICK on
53be found. It will be added to C<@INC> automatically. 136every server tick.
137
138=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
139$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
140$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
141
142Various directories - "/etc", read-only install directory, perl-library
143directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
144unique-items directory, player file directory, random maps directory and
145database environment.
146
147=item $cf::NOW
148
149The time of the last (current) server tick.
54 150
55=item $cf::TICK 151=item $cf::TICK
56 152
57The interval between server ticks, in seconds. 153The interval between server ticks, in seconds.
58 154
155=item $cf::LOADAVG
156
157The current CPU load on the server (alpha-smoothed), as a value between 0
158(none) and 1 (overloaded), indicating how much time is spent on processing
159objects per tick. Healthy values are < 0.5.
160
161=item $cf::LOAD
162
163The raw value load value from the last tick.
164
59=item %cf::CFG 165=item %cf::CFG
60 166
61Configuration for the server, loaded from C</etc/crossfire/config>, or 167Configuration for the server, loaded from C</etc/deliantra-server/config>, or
62from wherever your confdir points to. 168from wherever your confdir points to.
169
170=item cf::wait_for_tick, cf::wait_for_tick_begin
171
172These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
173returns directly I<after> the tick processing (and consequently, can only wake one process
174per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
175
176=item @cf::INVOKE_RESULTS
177
178This array contains the results of the last C<invoke ()> call. When
179C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
180that call.
63 181
64=back 182=back
65 183
66=cut 184=cut
67 185
68BEGIN { 186BEGIN {
69 *CORE::GLOBAL::warn = sub { 187 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 188 my $msg = join "", @_;
189
71 $msg .= "\n" 190 $msg .= "\n"
72 unless $msg =~ /\n$/; 191 unless $msg =~ /\n$/;
73 192
74 print STDERR "cfperl: $msg"; 193 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
194
75 LOG llevError, "cfperl: $msg"; 195 LOG llevError, $msg;
76 }; 196 };
77} 197}
78 198
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 199@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 200@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
81@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 201@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
82@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 202@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
83@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 203@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
204@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 205@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
85 206
86# we bless all objects into (empty) derived classes to force a method lookup 207# we bless all objects into (empty) derived classes to force a method lookup
87# within the Safe compartment. 208# within the Safe compartment.
88for my $pkg (qw( 209for my $pkg (qw(
89 cf::global 210 cf::global cf::attachable
90 cf::object cf::object::player 211 cf::object cf::object::player
91 cf::client cf::player 212 cf::client cf::player
92 cf::arch cf::living 213 cf::arch cf::living
93 cf::map cf::party cf::region 214 cf::map cf::party cf::region
94)) { 215)) {
95 no strict 'refs'; 216 no strict 'refs';
96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 217 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
97} 218}
98 219
99$Event::DIED = sub { 220$EV::DIED = sub {
100 warn "error in event callback: @_"; 221 warn "error in event callback: @_";
101}; 222};
102 223
103my %ext_pkg; 224#############################################################################
104my @exts;
105my @hook;
106 225
107=head2 UTILITY FUNCTIONS 226=head2 UTILITY FUNCTIONS
108 227
109=over 4 228=over 4
110 229
111=cut 230=item dumpval $ref
112 231
113use JSON::Syck (); # TODO# replace by JSON::PC once working 232=cut
114 233
234sub dumpval {
235 eval {
236 local $SIG{__DIE__};
237 my $d;
238 if (1) {
239 $d = new Data::Dumper([$_[0]], ["*var"]);
240 $d->Terse(1);
241 $d->Indent(2);
242 $d->Quotekeys(0);
243 $d->Useqq(1);
244 #$d->Bless(...);
245 $d->Seen($_[1]) if @_ > 1;
246 $d = $d->Dump();
247 }
248 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
249 $d
250 } || "[unable to dump $_[0]: '$@']";
251}
252
115=item $ref = cf::from_json $json 253=item $ref = cf::decode_json $json
116 254
117Converts a JSON string into the corresponding perl data structure. 255Converts a JSON string into the corresponding perl data structure.
118 256
119=cut
120
121sub from_json($) {
122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123 JSON::Syck::Load $_[0]
124}
125
126=item $json = cf::to_json $ref 257=item $json = cf::encode_json $ref
127 258
128Converts a perl data structure into its JSON representation. 259Converts a perl data structure into its JSON representation.
129 260
130=cut 261=cut
131 262
132sub to_json($) { 263our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 264
134 JSON::Syck::Dump $_[0] 265sub encode_json($) { $json_coder->encode ($_[0]) }
266sub decode_json($) { $json_coder->decode ($_[0]) }
267
268=item cf::lock_wait $string
269
270Wait until the given lock is available. See cf::lock_acquire.
271
272=item my $lock = cf::lock_acquire $string
273
274Wait until the given lock is available and then acquires it and returns
275a Coro::guard object. If the guard object gets destroyed (goes out of scope,
276for example when the coroutine gets canceled), the lock is automatically
277returned.
278
279Locks are *not* recursive, locking from the same coro twice results in a
280deadlocked coro.
281
282Lock names should begin with a unique identifier (for example, cf::map::find
283uses map_find and cf::map::load uses map_load).
284
285=item $locked = cf::lock_active $string
286
287Return true if the lock is currently active, i.e. somebody has locked it.
288
289=cut
290
291our %LOCK;
292our %LOCKER;#d#
293
294sub lock_wait($) {
295 my ($key) = @_;
296
297 if ($LOCKER{$key} == $Coro::current) {#d#
298 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
299 return;#d#
300 }#d#
301
302 # wait for lock, if any
303 while ($LOCK{$key}) {
304 push @{ $LOCK{$key} }, $Coro::current;
305 Coro::schedule;
306 }
307}
308
309sub lock_acquire($) {
310 my ($key) = @_;
311
312 # wait, to be sure we are not locked
313 lock_wait $key;
314
315 $LOCK{$key} = [];
316 $LOCKER{$key} = $Coro::current;#d#
317
318 Coro::guard {
319 delete $LOCKER{$key};#d#
320 # wake up all waiters, to be on the safe side
321 $_->ready for @{ delete $LOCK{$key} };
322 }
323}
324
325sub lock_active($) {
326 my ($key) = @_;
327
328 ! ! $LOCK{$key}
329}
330
331sub freeze_mainloop {
332 return unless $TICK_WATCHER->is_active;
333
334 my $guard = Coro::guard {
335 $TICK_WATCHER->start;
336 };
337 $TICK_WATCHER->stop;
338 $guard
339}
340
341=item cf::periodic $interval, $cb
342
343Like EV::periodic, but randomly selects a starting point so that the actions
344get spread over timer.
345
346=cut
347
348sub periodic($$) {
349 my ($interval, $cb) = @_;
350
351 my $start = rand List::Util::min 180, $interval;
352
353 EV::periodic $start, $interval, 0, $cb
354}
355
356=item cf::get_slot $time[, $priority[, $name]]
357
358Allocate $time seconds of blocking CPU time at priority C<$priority>:
359This call blocks and returns only when you have at least C<$time> seconds
360of cpu time till the next tick. The slot is only valid till the next cede.
361
362The optional C<$name> can be used to identify the job to run. It might be
363used for statistical purposes and should identify the same time-class.
364
365Useful for short background jobs.
366
367=cut
368
369our @SLOT_QUEUE;
370our $SLOT_QUEUE;
371
372$SLOT_QUEUE->cancel if $SLOT_QUEUE;
373$SLOT_QUEUE = Coro::async {
374 $Coro::current->desc ("timeslot manager");
375
376 my $signal = new Coro::Signal;
377
378 while () {
379 next_job:
380 my $avail = cf::till_tick;
381 if ($avail > 0.01) {
382 for (0 .. $#SLOT_QUEUE) {
383 if ($SLOT_QUEUE[$_][0] < $avail) {
384 my $job = splice @SLOT_QUEUE, $_, 1, ();
385 $job->[2]->send;
386 Coro::cede;
387 goto next_job;
388 }
389 }
390 }
391
392 if (@SLOT_QUEUE) {
393 # we do not use wait_for_tick() as it returns immediately when tick is inactive
394 push @cf::WAIT_FOR_TICK, $signal;
395 $signal->wait;
396 } else {
397 Coro::schedule;
398 }
399 }
400};
401
402sub get_slot($;$$) {
403 my ($time, $pri, $name) = @_;
404
405 $time = $TICK * .6 if $time > $TICK * .6;
406 my $sig = new Coro::Signal;
407
408 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
409 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
410 $SLOT_QUEUE->ready;
411 $sig->wait;
412}
413
414=item cf::async { BLOCK }
415
416Currently the same as Coro::async_pool, meaning you cannot use
417C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
418thing you are allowed to do is call C<prio> on it.
419
420=cut
421
422BEGIN { *async = \&Coro::async_pool }
423
424=item cf::sync_job { BLOCK }
425
426The design of Deliantra requires that the main coroutine ($Coro::main)
427is always able to handle events or runnable, as Deliantra is only
428partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
429acceptable.
430
431If it must be done, put the blocking parts into C<sync_job>. This will run
432the given BLOCK in another coroutine while waiting for the result. The
433server will be frozen during this time, so the block should either finish
434fast or be very important.
435
436=cut
437
438sub sync_job(&) {
439 my ($job) = @_;
440
441 if ($Coro::current == $Coro::main) {
442 my $time = EV::time;
443
444 # this is the main coro, too bad, we have to block
445 # till the operation succeeds, freezing the server :/
446
447 LOG llevError, Carp::longmess "sync job";#d#
448
449 # TODO: use suspend/resume instead
450 # (but this is cancel-safe)
451 my $freeze_guard = freeze_mainloop;
452
453 my $busy = 1;
454 my @res;
455
456 (async {
457 $Coro::current->desc ("sync job coro");
458 @res = eval { $job->() };
459 warn $@ if $@;
460 undef $busy;
461 })->prio (Coro::PRIO_MAX);
462
463 while ($busy) {
464 if (Coro::nready) {
465 Coro::cede_notself;
466 } else {
467 EV::loop EV::LOOP_ONESHOT;
468 }
469 }
470
471 $time = EV::time - $time;
472
473 LOG llevError | logBacktrace, Carp::longmess "long sync job"
474 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
475
476 $tick_start += $time; # do not account sync jobs to server load
477
478 wantarray ? @res : $res[0]
479 } else {
480 # we are in another coroutine, how wonderful, everything just works
481
482 $job->()
483 }
484}
485
486=item $coro = cf::async_ext { BLOCK }
487
488Like async, but this coro is automatically being canceled when the
489extension calling this is being unloaded.
490
491=cut
492
493sub async_ext(&) {
494 my $cb = shift;
495
496 my $coro = &Coro::async ($cb);
497
498 $coro->on_destroy (sub {
499 delete $EXT_CORO{$coro+0};
500 });
501 $EXT_CORO{$coro+0} = $coro;
502
503 $coro
504}
505
506=item fork_call { }, $args
507
508Executes the given code block with the given arguments in a seperate
509process, returning the results. Everything must be serialisable with
510Coro::Storable. May, of course, block. Note that the executed sub may
511never block itself or use any form of event handling.
512
513=cut
514
515sub fork_call(&@) {
516 my ($cb, @args) = @_;
517
518 # we seemingly have to make a local copy of the whole thing,
519 # otherwise perl prematurely frees the stuff :/
520 # TODO: investigate and fix (likely this will be rather laborious)
521
522 my @res = Coro::Util::fork_eval {
523 reset_signals;
524 &$cb
525 }, @args;
526
527 wantarray ? @res : $res[-1]
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=item $db = cf::db_table "name"
540
541Create and/or open a new database table. The string must not be "db" and must be unique
542within each server.
543
544=cut
545
546sub db_table($) {
547 my ($name) = @_;
548 my $db = BDB::db_create $DB_ENV;
549
550 eval {
551 $db->set_flags (BDB::CHKSUM);
552
553 utf8::encode $name;
554 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
555 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
556 cf::cleanup "db_open(db): $!" if $!;
557 };
558 cf::cleanup "db_open(db): $@" if $@;
559
560 $db
561}
562
563our $DB;
564
565sub db_init {
566 cf::sync_job {
567 $DB ||= db_table "db";
568 };
569}
570
571sub db_get($$) {
572 my $key = "$_[0]/$_[1]";
573
574 cf::sync_job {
575 BDB::db_get $DB, undef, $key, my $data;
576
577 $! ? ()
578 : $data
579 }
580}
581
582sub db_put($$$) {
583 BDB::dbreq_pri 4;
584 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
585}
586
587=item cf::cache $id => [$paths...], $processversion => $process
588
589Generic caching function that returns the value of the resource $id,
590caching and regenerating as required.
591
592This function can block.
593
594=cut
595
596sub cache {
597 my ($id, $src, $processversion, $process) = @_;
598
599 my $meta =
600 join "\x00",
601 $processversion,
602 map {
603 aio_stat $_
604 and Carp::croak "$_: $!";
605
606 ($_, (stat _)[7,9])
607 } @$src;
608
609 my $dbmeta = db_get cache => "$id/meta";
610 if ($dbmeta ne $meta) {
611 # changed, we may need to process
612
613 my @data;
614 my $md5;
615
616 for (0 .. $#$src) {
617 0 <= aio_load $src->[$_], $data[$_]
618 or Carp::croak "$src->[$_]: $!";
619 }
620
621 # if processing is expensive, check
622 # checksum first
623 if (1) {
624 $md5 =
625 join "\x00",
626 $processversion,
627 map {
628 cf::cede_to_tick;
629 ($src->[$_], Digest::MD5::md5_hex $data[$_])
630 } 0.. $#$src;
631
632
633 my $dbmd5 = db_get cache => "$id/md5";
634 if ($dbmd5 eq $md5) {
635 db_put cache => "$id/meta", $meta;
636
637 return db_get cache => "$id/data";
638 }
639 }
640
641 my $t1 = Time::HiRes::time;
642 my $data = $process->(\@data);
643 my $t2 = Time::HiRes::time;
644
645 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
646
647 db_put cache => "$id/data", $data;
648 db_put cache => "$id/md5" , $md5;
649 db_put cache => "$id/meta", $meta;
650
651 return $data;
652 }
653
654 db_get cache => "$id/data"
655}
656
657=item cf::datalog type => key => value, ...
658
659Log a datalog packet of the given type with the given key-value pairs.
660
661=cut
662
663sub datalog($@) {
664 my ($type, %kv) = @_;
665 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
135} 666}
136 667
137=back 668=back
138 669
139=cut 670=cut
… …
146attach callbacks/event handlers (a collection of which is called an "attachment") 677attach callbacks/event handlers (a collection of which is called an "attachment")
147to it. All such attachable objects support the following methods. 678to it. All such attachable objects support the following methods.
148 679
149In the following description, CLASS can be any of C<global>, C<object> 680In the following description, CLASS can be any of C<global>, C<object>
150C<player>, C<client> or C<map> (i.e. the attachable objects in 681C<player>, C<client> or C<map> (i.e. the attachable objects in
151crossfire+). 682Deliantra).
152 683
153=over 4 684=over 4
154 685
155=item $attachable->attach ($attachment, key => $value...) 686=item $attachable->attach ($attachment, key => $value...)
156 687
… …
249 my ($self, $victim) = @_; 780 my ($self, $victim) = @_;
250 ... 781 ...
251 } 782 }
252 } 783 }
253 784
785=item $attachable->valid
786
787Just because you have a perl object does not mean that the corresponding
788C-level object still exists. If you try to access an object that has no
789valid C counterpart anymore you get an exception at runtime. This method
790can be used to test for existence of the C object part without causing an
791exception.
792
254=cut 793=cut
255 794
256# the following variables are defined in .xs and must not be re-created 795# the following variables are defined in .xs and must not be re-created
257our @CB_GLOBAL = (); # registry for all global events 796our @CB_GLOBAL = (); # registry for all global events
797our @CB_ATTACHABLE = (); # registry for all attachables
258our @CB_OBJECT = (); # all objects (should not be used except in emergency) 798our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259our @CB_PLAYER = (); 799our @CB_PLAYER = ();
260our @CB_CLIENT = (); 800our @CB_CLIENT = ();
261our @CB_TYPE = (); # registry for type (cf-object class) based events 801our @CB_TYPE = (); # registry for type (cf-object class) based events
262our @CB_MAP = (); 802our @CB_MAP = ();
263 803
264my %attachment; 804my %attachment;
805
806sub cf::attachable::thawer_merge {
807 # simply override everything except _meta
808 local $_[0]{_meta};
809 %{$_[0]} = %{$_[1]};
810}
265 811
266sub _attach_cb($$$$) { 812sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_; 813 my ($registry, $event, $prio, $cb) = @_;
268 814
269 use sort 'stable'; 815 use sort 'stable';
… …
272 818
273 @{$registry->[$event]} = sort 819 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] } 820 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb; 821 @{$registry->[$event] || []}, $cb;
276} 822}
823
824# hack
825my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277 826
278# attach handles attaching event callbacks 827# attach handles attaching event callbacks
279# the only thing the caller has to do is pass the correct 828# the only thing the caller has to do is pass the correct
280# registry (== where the callback attaches to). 829# registry (== where the callback attaches to).
281sub _attach { 830sub _attach {
… …
283 832
284 my $object_type; 833 my $object_type;
285 my $prio = 0; 834 my $prio = 0;
286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 835 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287 836
837 #TODO: get rid of this hack
838 if ($attachable_klass{$klass}) {
839 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
840 }
841
288 while (@arg) { 842 while (@arg) {
289 my $type = shift @arg; 843 my $type = shift @arg;
290 844
291 if ($type eq "prio") { 845 if ($type eq "prio") {
292 $prio = shift @arg; 846 $prio = shift @arg;
… …
296 $registry = $CB_TYPE[$object_type] ||= []; 850 $registry = $CB_TYPE[$object_type] ||= [];
297 851
298 } elsif ($type eq "subtype") { 852 } elsif ($type eq "subtype") {
299 defined $object_type or Carp::croak "subtype specified without type"; 853 defined $object_type or Carp::croak "subtype specified without type";
300 my $object_subtype = shift @arg; 854 my $object_subtype = shift @arg;
301 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 855 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
302 856
303 } elsif ($type eq "package") { 857 } elsif ($type eq "package") {
304 my $pkg = shift @arg; 858 my $pkg = shift @arg;
305 859
306 while (my ($name, $id) = each %cb_id) { 860 while (my ($name, $id) = each %cb_id) {
… …
335 _attach $registry, $klass, @attach; 889 _attach $registry, $klass, @attach;
336 } 890 }
337 891
338 $obj->{$name} = \%arg; 892 $obj->{$name} = \%arg;
339 } else { 893 } else {
340 warn "object uses attachment '$name' that is not available, postponing.\n"; 894 warn "object uses attachment '$name' which is not available, postponing.\n";
341 } 895 }
342 896
343 $obj->{_attachment}{$name} = undef; 897 $obj->{_attachment}{$name} = undef;
344} 898}
345 899
… …
347 if (ref $_[0]) { 901 if (ref $_[0]) {
348 _object_attach @_; 902 _object_attach @_;
349 } else { 903 } else {
350 _attach shift->_attach_registry, @_; 904 _attach shift->_attach_registry, @_;
351 } 905 }
906 _recalc_want;
352}; 907};
353 908
354# all those should be optimised 909# all those should be optimised
355sub cf::attachable::detach { 910sub cf::attachable::detach {
356 my ($obj, $name) = @_; 911 my ($obj, $name) = @_;
… …
359 delete $obj->{_attachment}{$name}; 914 delete $obj->{_attachment}{$name};
360 reattach ($obj); 915 reattach ($obj);
361 } else { 916 } else {
362 Carp::croak "cannot, currently, detach class attachments"; 917 Carp::croak "cannot, currently, detach class attachments";
363 } 918 }
919 _recalc_want;
364}; 920};
365 921
366sub cf::attachable::attached { 922sub cf::attachable::attached {
367 my ($obj, $name) = @_; 923 my ($obj, $name) = @_;
368 924
369 exists $obj->{_attachment}{$name} 925 exists $obj->{_attachment}{$name}
370} 926}
371 927
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 928for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm' 929 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry { 930 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass) 931 (\\\@CB_$klass, KLASS_$klass)
376 } 932 }
377 933
… …
383 "; 939 ";
384 die if $@; 940 die if $@;
385} 941}
386 942
387our $override; 943our $override;
388our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 944our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
389 945
390sub override { 946sub override {
391 $override = 1; 947 $override = 1;
392 @invoke_results = (); 948 @INVOKE_RESULTS = (@_);
393} 949}
394 950
395sub do_invoke { 951sub do_invoke {
396 my $event = shift; 952 my $event = shift;
397 my $callbacks = shift; 953 my $callbacks = shift;
398 954
399 @invoke_results = (); 955 @INVOKE_RESULTS = ();
400 956
401 local $override; 957 local $override;
402 958
403 for (@$callbacks) { 959 for (@$callbacks) {
404 eval { &{$_->[1]} }; 960 eval { &{$_->[1]} };
… …
413 } 969 }
414 970
415 0 971 0
416} 972}
417 973
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 974=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
419 975
420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) 976=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425 977
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments. 978Generate an object-specific event with the given arguments.
429 979
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 980This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
431removed in future versions), and there is no public API to access override 981removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly). 982results (if you must, access C<@cf::INVOKE_RESULTS> directly).
433
434=back
435
436=cut
437
438#############################################################################
439
440=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
443
444=over 4
445
446=item $object->valid
447
448Just because you have a perl object does not mean that the corresponding
449C-level object still exists. If you try to access an object that has no
450valid C counterpart anymore you get an exception at runtime. This method
451can be used to test for existence of the C object part without causing an
452exception.
453 983
454=back 984=back
455 985
456=cut 986=cut
457 987
458############################################################################# 988#############################################################################
459# object support 989# object support
460 990
461sub instantiate { 991sub _object_equal($$);
992sub _object_equal($$) {
993 my ($a, $b) = @_;
994
995 return 0 unless (ref $a) eq (ref $b);
996
997 if ("HASH" eq ref $a) {
998 my @ka = keys %$a;
999 my @kb = keys %$b;
1000
1001 return 0 if @ka != @kb;
1002
1003 for (0 .. $#ka) {
1004 return 0 unless $ka[$_] eq $kb[$_];
1005 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1006 }
1007
1008 } elsif ("ARRAY" eq ref $a) {
1009
1010 return 0 if @$a != @$b;
1011
1012 for (0 .. $#$a) {
1013 return 0 unless _object_equal $a->[$_], $b->[$_];
1014 }
1015
1016 } elsif ($a ne $b) {
1017 return 0;
1018 }
1019
1020 1
1021}
1022
1023our $SLOW_MERGES;#d#
1024sub _can_merge {
462 my ($obj, $data) = @_; 1025 my ($ob1, $ob2) = @_;
463 1026
464 $data = from_json $data; 1027 ++$SLOW_MERGES;#d#
465 1028
466 for (@$data) { 1029 # we do the slow way here
467 my ($name, $args) = @$_; 1030 return _object_equal $ob1, $ob2
468
469 $obj->attach ($name, %{$args || {} });
470 }
471} 1031}
472 1032
473# basically do the same as instantiate, without calling instantiate
474sub reattach { 1033sub reattach {
1034 # basically do the same as instantiate, without calling instantiate
475 my ($obj) = @_; 1035 my ($obj) = @_;
1036
1037 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
1038
476 my $registry = $obj->registry; 1039 my $registry = $obj->registry;
477 1040
478 @$registry = (); 1041 @$registry = ();
479 1042
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 1043 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
… …
489 warn "object uses attachment '$name' that is not available, postponing.\n"; 1052 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 1053 }
491 } 1054 }
492} 1055}
493 1056
494sub object_freezer_save { 1057cf::attachable->attach (
495 my ($filename, $rdata, $objs) = @_;
496
497 if (length $$rdata) {
498 warn sprintf "saving %s (%d,%d)\n",
499 $filename, length $$rdata, scalar @$objs;
500
501 if (open my $fh, ">:raw", "$filename~") {
502 chmod SAVE_MODE, $fh;
503 syswrite $fh, $$rdata;
504 close $fh;
505
506 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507 chmod SAVE_MODE, $fh;
508 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509 close $fh;
510 rename "$filename.pst~", "$filename.pst";
511 } else {
512 unlink "$filename.pst";
513 }
514
515 rename "$filename~", $filename;
516 } else {
517 warn "FATAL: $filename~: $!\n";
518 }
519 } else {
520 unlink $filename;
521 unlink "$filename.pst";
522 }
523}
524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
533sub object_thawer_load {
534 my ($filename) = @_;
535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
548
549 ()
550}
551
552cf::object->attach (
553 prio => -1000000, 1058 prio => -1000000,
1059 on_instantiate => sub {
1060 my ($obj, $data) = @_;
1061
1062 $data = decode_json $data;
1063
1064 for (@$data) {
1065 my ($name, $args) = @$_;
1066
1067 $obj->attach ($name, %{$args || {} });
1068 }
1069 },
1070 on_reattach => \&reattach,
554 on_clone => sub { 1071 on_clone => sub {
555 my ($src, $dst) = @_; 1072 my ($src, $dst) = @_;
556 1073
557 @{$dst->registry} = @{$src->registry}; 1074 @{$dst->registry} = @{$src->registry};
558 1075
… …
561 %{$dst->{_attachment}} = %{$src->{_attachment}} 1078 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment}; 1079 if exists $src->{_attachment};
563 }, 1080 },
564); 1081);
565 1082
1083sub object_freezer_save {
1084 my ($filename, $rdata, $objs) = @_;
1085
1086 sync_job {
1087 if (length $$rdata) {
1088 utf8::decode (my $decname = $filename);
1089 warn sprintf "saving %s (%d,%d)\n",
1090 $decname, length $$rdata, scalar @$objs;
1091
1092 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
1093 chmod SAVE_MODE, $fh;
1094 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1095 aio_fsync $fh if $cf::USE_FSYNC;
1096 close $fh;
1097
1098 if (@$objs) {
1099 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
1100 chmod SAVE_MODE, $fh;
1101 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
1102 aio_write $fh, 0, (length $data), $data, 0;
1103 aio_fsync $fh if $cf::USE_FSYNC;
1104 close $fh;
1105 aio_rename "$filename.pst~", "$filename.pst";
1106 }
1107 } else {
1108 aio_unlink "$filename.pst";
1109 }
1110
1111 aio_rename "$filename~", $filename;
1112 } else {
1113 warn "FATAL: $filename~: $!\n";
1114 }
1115 } else {
1116 aio_unlink $filename;
1117 aio_unlink "$filename.pst";
1118 }
1119 };
1120}
1121
1122sub object_freezer_as_string {
1123 my ($rdata, $objs) = @_;
1124
1125 use Data::Dumper;
1126
1127 $$rdata . Dumper $objs
1128}
1129
1130sub object_thawer_load {
1131 my ($filename) = @_;
1132
1133 my ($data, $av);
1134
1135 (aio_load $filename, $data) >= 0
1136 or return;
1137
1138 unless (aio_stat "$filename.pst") {
1139 (aio_load "$filename.pst", $av) >= 0
1140 or return;
1141
1142 my $st = eval { Coro::Storable::thaw $av };
1143 $av = $st->{objs};
1144 }
1145
1146 utf8::decode (my $decname = $filename);
1147 warn sprintf "loading %s (%d,%d)\n",
1148 $decname, length $data, scalar @{$av || []};
1149
1150 ($data, $av)
1151}
1152
1153=head2 COMMAND CALLBACKS
1154
1155=over 4
1156
1157=cut
1158
566############################################################################# 1159#############################################################################
567# command handling &c 1160# command handling &c
568 1161
569=item cf::register_command $name => \&callback($ob,$args); 1162=item cf::register_command $name => \&callback($ob,$args);
570 1163
… …
582 push @{ $COMMAND{$name} }, [$caller, $cb]; 1175 push @{ $COMMAND{$name} }, [$caller, $cb];
583} 1176}
584 1177
585=item cf::register_extcmd $name => \&callback($pl,$packet); 1178=item cf::register_extcmd $name => \&callback($pl,$packet);
586 1179
587Register a callbackf ro execution when the client sends an extcmd packet. 1180Register a callback for execution when the client sends an (synchronous)
1181extcmd packet. Ext commands will be processed in the order they are
1182received by the server, like other user commands. The first argument is
1183the logged-in player. Ext commands can only be processed after a player
1184has logged in successfully.
588 1185
589If the callback returns something, it is sent back as if reply was being 1186If the callback returns something, it is sent back as if reply was being
590called. 1187called.
591 1188
1189=item cf::register_exticmd $name => \&callback($ns,$packet);
1190
1191Register a callback for execution when the client sends an (asynchronous)
1192exticmd packet. Exti commands are processed by the server as soon as they
1193are received, i.e. out of order w.r.t. other commands. The first argument
1194is a client socket. Exti commands can be received anytime, even before
1195log-in.
1196
1197If the callback returns something, it is sent back as if reply was being
1198called.
1199
592=cut 1200=cut
593 1201
594sub register_extcmd { 1202sub register_extcmd {
595 my ($name, $cb) = @_; 1203 my ($name, $cb) = @_;
596 1204
597 my $caller = caller;
598 #warn "registering extcmd '$name' to '$caller'";
599
600 $EXTCMD{$name} = [$cb, $caller]; 1205 $EXTCMD{$name} = $cb;
1206}
1207
1208sub register_exticmd {
1209 my ($name, $cb) = @_;
1210
1211 $EXTICMD{$name} = $cb;
601} 1212}
602 1213
603cf::player->attach ( 1214cf::player->attach (
604 on_command => sub { 1215 on_command => sub {
605 my ($pl, $name, $params) = @_; 1216 my ($pl, $name, $params) = @_;
… …
614 cf::override; 1225 cf::override;
615 }, 1226 },
616 on_extcmd => sub { 1227 on_extcmd => sub {
617 my ($pl, $buf) = @_; 1228 my ($pl, $buf) = @_;
618 1229
619 my $msg = eval { from_json $buf }; 1230 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
620 1231
621 if (ref $msg) { 1232 if (ref $msg) {
1233 my ($type, $reply, @payload) =
1234 "ARRAY" eq ref $msg
1235 ? @$msg
1236 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1237
1238 my @reply;
1239
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1240 if (my $cb = $EXTCMD{$type}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) { 1241 @reply = $cb->($pl, @payload);
624 $pl->ext_reply ($msg->{msgid}, %reply);
625 }
626 } 1242 }
1243
1244 $pl->ext_reply ($reply, @reply)
1245 if $reply;
1246
627 } else { 1247 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1248 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
629 } 1249 }
630 1250
631 cf::override; 1251 cf::override;
632 }, 1252 },
633); 1253);
634 1254
1255sub load_extensions {
1256 cf::sync_job {
1257 my %todo;
1258
1259 for my $path (<$LIBDIR/*.ext>) {
1260 next unless -r $path;
1261
1262 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1263 my $base = $1;
1264 my $pkg = $1;
1265 $pkg =~ s/[^[:word:]]/_/g;
1266 $pkg = "ext::$pkg";
1267
1268 open my $fh, "<:utf8", $path
1269 or die "$path: $!";
1270
1271 my $source = do { local $/; <$fh> };
1272
1273 my %ext = (
1274 path => $path,
1275 base => $base,
1276 pkg => $pkg,
1277 );
1278
1279 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1280 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1281
1282 $ext{source} =
1283 "package $pkg; use strict; use utf8;\n"
1284 . "#line 1 \"$path\"\n{\n"
1285 . $source
1286 . "\n};\n1";
1287
1288 $todo{$base} = \%ext;
1289 }
1290
1291 my %done;
1292 while (%todo) {
1293 my $progress;
1294
1295 while (my ($k, $v) = each %todo) {
1296 for (split /,\s*/, $v->{meta}{depends}) {
1297 goto skip
1298 unless exists $done{$_};
1299 }
1300
1301 warn "... loading '$k' into '$v->{pkg}'\n";
1302
1303 unless (eval $v->{source}) {
1304 my $msg = $@ ? "$v->{path}: $@\n"
1305 : "$v->{base}: extension inactive.\n";
1306
1307 if (exists $v->{meta}{mandatory}) {
1308 warn $msg;
1309 warn "mandatory extension failed to load, exiting.\n";
1310 exit 1;
1311 }
1312
1313 warn $msg;
1314 }
1315
1316 $done{$k} = delete $todo{$k};
1317 push @EXTS, $v->{pkg};
1318 $progress = 1;
1319 }
1320
1321 skip:
1322 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1323 unless $progress;
1324 }
1325 };
1326}
1327
1328#############################################################################
1329
1330=back
1331
1332=head2 CORE EXTENSIONS
1333
1334Functions and methods that extend core crossfire objects.
1335
1336=cut
1337
1338package cf::player;
1339
1340use Coro::AIO;
1341
1342=head3 cf::player
1343
1344=over 4
1345
1346=item cf::player::num_playing
1347
1348Returns the official number of playing players, as per the Crossfire metaserver rules.
1349
1350=cut
1351
1352sub num_playing {
1353 scalar grep
1354 $_->ob->map
1355 && !$_->hidden
1356 && !$_->ob->flag (cf::FLAG_WIZ),
1357 cf::player::list
1358}
1359
1360=item cf::player::find $login
1361
1362Returns the given player object, loading it if necessary (might block).
1363
1364=cut
1365
1366sub playerdir($) {
1367 "$PLAYERDIR/"
1368 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1369}
1370
1371sub path($) {
1372 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1373
1374 (playerdir $login) . "/playerdata"
1375}
1376
1377sub find_active($) {
1378 $cf::PLAYER{$_[0]}
1379 and $cf::PLAYER{$_[0]}->active
1380 and $cf::PLAYER{$_[0]}
1381}
1382
1383sub exists($) {
1384 my ($login) = @_;
1385
1386 $cf::PLAYER{$login}
1387 or cf::sync_job { !aio_stat path $login }
1388}
1389
1390sub find($) {
1391 return $cf::PLAYER{$_[0]} || do {
1392 my $login = $_[0];
1393
1394 my $guard = cf::lock_acquire "user_find:$login";
1395
1396 $cf::PLAYER{$_[0]} || do {
1397 # rename old playerfiles to new ones
1398 #TODO: remove when no longer required
1399 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1400 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1401 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1402 aio_unlink +(playerdir $login) . "/$login.pl";
1403
1404 my $f = new_from_file cf::object::thawer path $login
1405 or return;
1406
1407 my $pl = cf::player::load_pl $f
1408 or return;
1409 local $cf::PLAYER_LOADING{$login} = $pl;
1410 $f->resolve_delayed_derefs;
1411 $cf::PLAYER{$login} = $pl
1412 }
1413 }
1414}
1415
1416sub save($) {
1417 my ($pl) = @_;
1418
1419 return if $pl->{deny_save};
1420
1421 my $path = path $pl;
1422 my $guard = cf::lock_acquire "user_save:$path";
1423
1424 return if $pl->{deny_save};
1425
1426 aio_mkdir playerdir $pl, 0770;
1427 $pl->{last_save} = $cf::RUNTIME;
1428
1429 $pl->save_pl ($path);
1430 cf::cede_to_tick;
1431}
1432
1433sub new($) {
1434 my ($login) = @_;
1435
1436 my $self = create;
1437
1438 $self->ob->name ($login);
1439 $self->{deny_save} = 1;
1440
1441 $cf::PLAYER{$login} = $self;
1442
1443 $self
1444}
1445
1446=item $player->send_msg ($channel, $msg, $color, [extra...])
1447
1448=cut
1449
1450sub send_msg {
1451 my $ns = shift->ns
1452 or return;
1453 $ns->send_msg (@_);
1454}
1455
1456=item $pl->quit_character
1457
1458Nukes the player without looking back. If logged in, the connection will
1459be destroyed. May block for a long time.
1460
1461=cut
1462
1463sub quit_character {
1464 my ($pl) = @_;
1465
1466 my $name = $pl->ob->name;
1467
1468 $pl->{deny_save} = 1;
1469 $pl->password ("*"); # this should lock out the player until we nuked the dir
1470
1471 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1472 $pl->deactivate;
1473 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1474 $pl->ns->destroy if $pl->ns;
1475
1476 my $path = playerdir $pl;
1477 my $temp = "$path~$cf::RUNTIME~deleting~";
1478 aio_rename $path, $temp;
1479 delete $cf::PLAYER{$pl->ob->name};
1480 $pl->destroy;
1481
1482 my $prefix = qr<^~\Q$name\E/>;
1483
1484 # nuke player maps
1485 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1486
1487 IO::AIO::aio_rmtree $temp;
1488}
1489
1490=item $pl->kick
1491
1492Kicks a player out of the game. This destroys the connection.
1493
1494=cut
1495
1496sub kick {
1497 my ($pl, $kicker) = @_;
1498
1499 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1500 $pl->killer ("kicked");
1501 $pl->ns->destroy;
1502}
1503
1504=item cf::player::list_logins
1505
1506Returns am arrayref of all valid playernames in the system, can take a
1507while and may block, so not sync_job-capable, ever.
1508
1509=cut
1510
1511sub list_logins {
1512 my $dirs = aio_readdir $PLAYERDIR
1513 or return [];
1514
1515 my @logins;
1516
1517 for my $login (@$dirs) {
1518 my $path = path $login;
1519
1520 # a .pst is a dead give-away for a valid player
1521 unless (-e "$path.pst") {
1522 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1523 aio_read $fh, 0, 512, my $buf, 0 or next;
1524 $buf !~ /^password -------------$/m or next; # official not-valid tag
1525 }
1526
1527 utf8::decode $login;
1528 push @logins, $login;
1529 }
1530
1531 \@logins
1532}
1533
1534=item $player->maps
1535
1536Returns an arrayref of map paths that are private for this
1537player. May block.
1538
1539=cut
1540
1541sub maps($) {
1542 my ($pl) = @_;
1543
1544 $pl = ref $pl ? $pl->ob->name : $pl;
1545
1546 my $files = aio_readdir playerdir $pl
1547 or return;
1548
1549 my @paths;
1550
1551 for (@$files) {
1552 utf8::decode $_;
1553 next if /\.(?:pl|pst)$/;
1554 next unless /^$PATH_SEP/o;
1555
1556 push @paths, cf::map::normalise "~$pl/$_";
1557 }
1558
1559 \@paths
1560}
1561
1562=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1563
1564Expand crossfire pod fragments into protocol xml.
1565
1566=cut
1567
1568use re 'eval';
1569
1570my $group;
1571my $interior; $interior = qr{
1572 # match a pod interior sequence sans C<< >>
1573 (?:
1574 \ (.*?)\ (?{ $group = $^N })
1575 | < (??{$interior}) >
1576 )
1577}x;
1578
1579sub expand_cfpod {
1580 my ($self, $pod) = @_;
1581
1582 my $xml;
1583
1584 while () {
1585 if ($pod =~ /\G( (?: [^BCGHITU]+ | .(?!<) )+ )/xgcs) {
1586 $group = $1;
1587
1588 $group =~ s/&/&amp;/g;
1589 $group =~ s/</&lt;/g;
1590
1591 $xml .= $group;
1592 } elsif ($pod =~ m%\G
1593 ([BCGHITU])
1594 <
1595 (?:
1596 ([^<>]*) (?{ $group = $^N })
1597 | < $interior >
1598 )
1599 >
1600 %gcsx
1601 ) {
1602 my ($code, $data) = ($1, $group);
1603
1604 if ($code eq "B") {
1605 $xml .= "<b>" . expand_cfpod ($self, $data) . "</b>";
1606 } elsif ($code eq "I") {
1607 $xml .= "<i>" . expand_cfpod ($self, $data) . "</i>";
1608 } elsif ($code eq "U") {
1609 $xml .= "<u>" . expand_cfpod ($self, $data) . "</u>";
1610 } elsif ($code eq "C") {
1611 $xml .= "<tt>" . expand_cfpod ($self, $data) . "</tt>";
1612 } elsif ($code eq "T") {
1613 $xml .= "<big><b>" . expand_cfpod ($self, $data) . "</b></big>";
1614 } elsif ($code eq "G") {
1615 my ($male, $female) = split /\|/, $data;
1616 $data = $self->gender ? $female : $male;
1617 $xml .= expand_cfpod ($self, $data);
1618 } elsif ($code eq "H") {
1619 $xml .= ("<fg name=\"lightblue\">[" . expand_cfpod ($self, $data) . " (Use hintmode to suppress hints)]</fg>",
1620 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1621 "")
1622 [$self->{hintmode}];
1623 } else {
1624 $xml .= "error processing '$code($data)' directive";
1625 }
1626 } else {
1627 if ($pod =~ /\G(.+)/) {
1628 warn "parse error while expanding $pod (at $1)";
1629 }
1630 last;
1631 }
1632 }
1633
1634 for ($xml) {
1635 # create single paragraphs (very hackish)
1636 s/(?<=\S)\n(?=\w)/ /g;
1637
1638 # compress some whitespace
1639 s/\s+\n/\n/g; # ws line-ends
1640 s/\n\n+/\n/g; # double lines
1641 s/^\n+//; # beginning lines
1642 s/\n+$//; # ending lines
1643 }
1644
1645 $xml
1646}
1647
1648no re 'eval';
1649
1650sub hintmode {
1651 $_[0]{hintmode} = $_[1] if @_ > 1;
1652 $_[0]{hintmode}
1653}
1654
1655=item $player->ext_reply ($msgid, @msg)
1656
1657Sends an ext reply to the player.
1658
1659=cut
1660
1661sub ext_reply($$@) {
1662 my ($self, $id, @msg) = @_;
1663
1664 $self->ns->ext_reply ($id, @msg)
1665}
1666
1667=item $player->ext_msg ($type, @msg)
1668
1669Sends an ext event to the client.
1670
1671=cut
1672
1673sub ext_msg($$@) {
1674 my ($self, $type, @msg) = @_;
1675
1676 $self->ns->ext_msg ($type, @msg);
1677}
1678
1679=head3 cf::region
1680
1681=over 4
1682
1683=cut
1684
1685package cf::region;
1686
1687=item cf::region::find_by_path $path
1688
1689Tries to decuce the likely region for a map knowing only its path.
1690
1691=cut
1692
1693sub find_by_path($) {
1694 my ($path) = @_;
1695
1696 my ($match, $specificity);
1697
1698 for my $region (list) {
1699 if ($region->{match} && $path =~ $region->{match}) {
1700 ($match, $specificity) = ($region, $region->specificity)
1701 if $region->specificity > $specificity;
1702 }
1703 }
1704
1705 $match
1706}
1707
1708=back
1709
1710=head3 cf::map
1711
1712=over 4
1713
1714=cut
1715
1716package cf::map;
1717
1718use Fcntl;
1719use Coro::AIO;
1720
1721use overload
1722 '""' => \&as_string,
1723 fallback => 1;
1724
1725our $MAX_RESET = 3600;
1726our $DEFAULT_RESET = 3000;
1727
1728sub generate_random_map {
1729 my ($self, $rmp) = @_;
1730 # mit "rum" bekleckern, nicht
1731 $self->_create_random_map (
1732 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1733 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1734 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1735 $rmp->{exit_on_final_map},
1736 $rmp->{xsize}, $rmp->{ysize},
1737 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1738 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1739 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1740 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1741 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1742 (cf::region::find $rmp->{region}), $rmp->{custom}
1743 )
1744}
1745
1746=item cf::map->register ($regex, $prio)
1747
1748Register a handler for the map path matching the given regex at the
1749givne priority (higher is better, built-in handlers have priority 0, the
1750default).
1751
1752=cut
1753
635sub register { 1754sub register {
1755 my (undef, $regex, $prio) = @_;
1756 my $pkg = caller;
1757
1758 no strict;
1759 push @{"$pkg\::ISA"}, __PACKAGE__;
1760
1761 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1762}
1763
1764# also paths starting with '/'
1765$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1766
1767sub thawer_merge {
636 my ($base, $pkg) = @_; 1768 my ($self, $merge) = @_;
637 1769
638 #TODO 1770 # we have to keep some variables in memory intact
639} 1771 local $self->{path};
1772 local $self->{load_path};
640 1773
641sub load_extension { 1774 $self->SUPER::thawer_merge ($merge);
1775}
1776
1777sub normalise {
642 my ($path) = @_; 1778 my ($path, $base) = @_;
643 1779
644 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1780 $path = "$path"; # make sure its a string
645 my $base = $1;
646 my $pkg = $1;
647 $pkg =~ s/[^[:word:]]/_/g;
648 $pkg = "ext::$pkg";
649 1781
650 warn "loading '$path' into '$pkg'\n"; 1782 $path =~ s/\.map$//;
651 1783
652 open my $fh, "<:utf8", $path 1784 # map plan:
653 or die "$path: $!"; 1785 #
1786 # /! non-realised random map exit (special hack!)
1787 # {... are special paths that are not being touched
1788 # ?xxx/... are special absolute paths
1789 # ?random/... random maps
1790 # /... normal maps
1791 # ~user/... per-player map of a specific user
654 1792
655 my $source = 1793 $path =~ s/$PATH_SEP/\//go;
656 "package $pkg; use strict; use utf8;\n"
657 . "#line 1 \"$path\"\n{\n"
658 . (do { local $/; <$fh> })
659 . "\n};\n1";
660 1794
661 eval $source 1795 # treat it as relative path if it starts with
662 or die $@ ? "$path: $@\n" 1796 # something that looks reasonable
663 : "extension disabled.\n"; 1797 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1798 $base or Carp::carp "normalise called with relative path and no base: '$path'";
664 1799
665 push @exts, $pkg; 1800 $base =~ s{[^/]+/?$}{};
666 $ext_pkg{$base} = $pkg; 1801 $path = "$base/$path";
667
668# no strict 'refs';
669# @{"$pkg\::ISA"} = ext::;
670
671 register $base, $pkg;
672}
673
674sub unload_extension {
675 my ($pkg) = @_;
676
677 warn "removing extension $pkg\n";
678
679 # remove hooks
680 #TODO
681# for my $idx (0 .. $#PLUGIN_EVENT) {
682# delete $hook[$idx]{$pkg};
683# } 1802 }
684 1803
685 # remove commands 1804 for ($path) {
686 for my $name (keys %COMMAND) { 1805 redo if s{//}{/};
687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1806 redo if s{/\.?/}{/};
1807 redo if s{/[^/]+/\.\./}{/};
1808 }
688 1809
689 if (@cb) { 1810 $path
690 $COMMAND{$name} = \@cb; 1811}
1812
1813sub new_from_path {
1814 my (undef, $path, $base) = @_;
1815
1816 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1817
1818 $path = normalise $path, $base;
1819
1820 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1821 if ($path =~ $EXT_MAP{$pkg}[1]) {
1822 my $self = bless cf::map::new, $pkg;
1823 $self->{path} = $path; $self->path ($path);
1824 $self->init; # pass $1 etc.
1825 return $self;
1826 }
1827 }
1828
1829 Carp::cluck "unable to resolve path '$path' (base '$base').";
1830 ()
1831}
1832
1833sub init {
1834 my ($self) = @_;
1835
1836 $self
1837}
1838
1839sub as_string {
1840 my ($self) = @_;
1841
1842 "$self->{path}"
1843}
1844
1845# the displayed name, this is a one way mapping
1846sub visible_name {
1847 &as_string
1848}
1849
1850# the original (read-only) location
1851sub load_path {
1852 my ($self) = @_;
1853
1854 "$MAPDIR/$self->{path}.map"
1855}
1856
1857# the temporary/swap location
1858sub save_path {
1859 my ($self) = @_;
1860
1861 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1862 "$TMPDIR/$path.map"
1863}
1864
1865# the unique path, undef == no special unique path
1866sub uniq_path {
1867 my ($self) = @_;
1868
1869 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1870 "$UNIQUEDIR/$path"
1871}
1872
1873# and all this just because we cannot iterate over
1874# all maps in C++...
1875sub change_all_map_light {
1876 my ($change) = @_;
1877
1878 $_->change_map_light ($change)
1879 for grep $_->outdoor, values %cf::MAP;
1880}
1881
1882sub decay_objects {
1883 my ($self) = @_;
1884
1885 return if $self->{deny_reset};
1886
1887 $self->do_decay_objects;
1888}
1889
1890sub unlink_save {
1891 my ($self) = @_;
1892
1893 utf8::encode (my $save = $self->save_path);
1894 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1895 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1896}
1897
1898sub load_header_from($) {
1899 my ($self, $path) = @_;
1900
1901 utf8::encode $path;
1902 my $f = new_from_file cf::object::thawer $path
1903 or return;
1904
1905 $self->_load_header ($f)
1906 or return;
1907
1908 local $MAP_LOADING{$self->{path}} = $self;
1909 $f->resolve_delayed_derefs;
1910
1911 $self->{load_path} = $path;
1912
1913 1
1914}
1915
1916sub load_header_orig {
1917 my ($self) = @_;
1918
1919 $self->load_header_from ($self->load_path)
1920}
1921
1922sub load_header_temp {
1923 my ($self) = @_;
1924
1925 $self->load_header_from ($self->save_path)
1926}
1927
1928sub prepare_temp {
1929 my ($self) = @_;
1930
1931 $self->last_access ((delete $self->{last_access})
1932 || $cf::RUNTIME); #d#
1933 # safety
1934 $self->{instantiate_time} = $cf::RUNTIME
1935 if $self->{instantiate_time} > $cf::RUNTIME;
1936}
1937
1938sub prepare_orig {
1939 my ($self) = @_;
1940
1941 $self->{load_original} = 1;
1942 $self->{instantiate_time} = $cf::RUNTIME;
1943 $self->last_access ($cf::RUNTIME);
1944 $self->instantiate;
1945}
1946
1947sub load_header {
1948 my ($self) = @_;
1949
1950 if ($self->load_header_temp) {
1951 $self->prepare_temp;
691 } else { 1952 } else {
692 delete $COMMAND{$name}; 1953 $self->load_header_orig
693 } 1954 or return;
1955 $self->prepare_orig;
1956 }
1957
1958 $self->{deny_reset} = 1
1959 if $self->no_reset;
1960
1961 $self->default_region (cf::region::find_by_path $self->{path})
1962 unless $self->default_region;
1963
694 } 1964 1
1965}
695 1966
696 # remove extcmds 1967sub find;
697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1968sub find {
698 delete $EXTCMD{$name}; 1969 my ($path, $origin) = @_;
1970
1971 $path = normalise $path, $origin && $origin->path;
1972
1973 cf::lock_wait "map_data:$path";#d#remove
1974 cf::lock_wait "map_find:$path";
1975
1976 $cf::MAP{$path} || do {
1977 my $guard1 = cf::lock_acquire "map_find:$path";
1978 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1979
1980 my $map = new_from_path cf::map $path
1981 or return;
1982
1983 $map->{last_save} = $cf::RUNTIME;
1984
1985 $map->load_header
1986 or return;
1987
1988 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1989 # doing this can freeze the server in a sync job, obviously
1990 #$cf::WAIT_FOR_TICK->wait;
1991 undef $guard1;
1992 undef $guard2;
1993 $map->reset;
1994 return find $path;
1995 }
1996
1997 $cf::MAP{$path} = $map
1998 }
1999}
2000
2001sub pre_load { }
2002sub post_load { }
2003
2004sub load {
2005 my ($self) = @_;
2006
2007 local $self->{deny_reset} = 1; # loading can take a long time
2008
2009 my $path = $self->{path};
2010
699 } 2011 {
2012 my $guard = cf::lock_acquire "map_data:$path";
700 2013
701 if (my $cb = $pkg->can ("unload")) { 2014 return unless $self->valid;
702 eval { 2015 return unless $self->in_memory == cf::MAP_SWAPPED;
703 $cb->($pkg); 2016
2017 $self->in_memory (cf::MAP_LOADING);
2018
2019 $self->alloc;
2020
2021 $self->pre_load;
2022 cf::cede_to_tick;
2023
2024 my $f = new_from_file cf::object::thawer $self->{load_path};
2025 $f->skip_block;
2026 $self->_load_objects ($f)
2027 or return;
2028
2029 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
2030 if delete $self->{load_original};
2031
2032 if (my $uniq = $self->uniq_path) {
2033 utf8::encode $uniq;
2034 unless (aio_stat $uniq) {
2035 if (my $f = new_from_file cf::object::thawer $uniq) {
2036 $self->clear_unique_items;
2037 $self->_load_objects ($f);
2038 $f->resolve_delayed_derefs;
2039 }
704 1 2040 }
705 } or warn "$pkg unloaded, but with errors: $@"; 2041 }
706 }
707 2042
708 Symbol::delete_package $pkg; 2043 $f->resolve_delayed_derefs;
709}
710 2044
711sub load_extensions { 2045 cf::cede_to_tick;
712 for my $ext (<$LIBDIR/*.ext>) { 2046 # now do the right thing for maps
713 next unless -r $ext; 2047 $self->link_multipart_objects;
714 eval { 2048 $self->difficulty ($self->estimate_difficulty)
715 load_extension $ext; 2049 unless $self->difficulty;
716 1 2050 cf::cede_to_tick;
717 } or warn "$ext not loaded: $@";
718 }
719}
720 2051
721############################################################################# 2052 unless ($self->{deny_activate}) {
722# load/save/clean perl data associated with a map 2053 $self->decay_objects;
2054 $self->fix_auto_apply;
2055 $self->update_buttons;
2056 cf::cede_to_tick;
2057 $self->set_darkness_map;
2058 cf::cede_to_tick;
2059 $self->activate;
2060 }
723 2061
724*cf::mapsupport::on_clean = sub { 2062 $self->{last_save} = $cf::RUNTIME;
2063 $self->last_access ($cf::RUNTIME);
2064
2065 $self->in_memory (cf::MAP_IN_MEMORY);
2066 }
2067
2068 $self->post_load;
2069}
2070
2071sub customise_for {
2072 my ($self, $ob) = @_;
2073
2074 return find "~" . $ob->name . "/" . $self->{path}
2075 if $self->per_player;
2076
2077# return find "?party/" . $ob->name . "/" . $self->{path}
2078# if $self->per_party;
2079
2080 $self
2081}
2082
2083# find and load all maps in the 3x3 area around a map
2084sub load_neighbours {
725 my ($map) = @_; 2085 my ($map) = @_;
726 2086
727 my $path = $map->tmpname; 2087 my @neigh; # diagonal neighbours
728 defined $path or return;
729 2088
730 unlink "$path.pst"; 2089 for (0 .. 3) {
731}; 2090 my $neigh = $map->tile_path ($_)
2091 or next;
2092 $neigh = find $neigh, $map
2093 or next;
2094 $neigh->load;
732 2095
733cf::map->attach (prio => -10000, package => cf::mapsupport::); 2096 push @neigh,
2097 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2098 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2099 }
734 2100
735############################################################################# 2101 for (grep defined $_->[0], @neigh) {
736# load/save perl data associated with player->ob objects 2102 my ($path, $origin) = @$_;
737 2103 my $neigh = find $path, $origin
738sub all_objects(@) { 2104 or next;
739 @_, map all_objects ($_->inv), @_ 2105 $neigh->load;
2106 }
740} 2107}
741 2108
742# TODO: compatibility cruft, remove when no longer needed 2109sub find_sync {
743cf::player->attach ( 2110 my ($path, $origin) = @_;
744 on_load => sub {
745 my ($pl, $path) = @_;
746 2111
747 for my $o (all_objects $pl->ob) { 2112 cf::sync_job { find $path, $origin }
748 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2113}
749 $o->set_ob_key_value ("_perl_data");
750 2114
751 %$o = %{ Storable::thaw pack "H*", $value }; 2115sub do_load_sync {
2116 my ($map) = @_;
2117
2118 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2119 if $Coro::current == $Coro::main;
2120
2121 cf::sync_job { $map->load };
2122}
2123
2124our %MAP_PREFETCH;
2125our $MAP_PREFETCHER = undef;
2126
2127sub find_async {
2128 my ($path, $origin, $load) = @_;
2129
2130 $path = normalise $path, $origin && $origin->{path};
2131
2132 if (my $map = $cf::MAP{$path}) {
2133 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
2134 }
2135
2136 $MAP_PREFETCH{$path} |= $load;
2137
2138 $MAP_PREFETCHER ||= cf::async {
2139 $Coro::current->{desc} = "map prefetcher";
2140
2141 while (%MAP_PREFETCH) {
2142 while (my ($k, $v) = each %MAP_PREFETCH) {
2143 if (my $map = find $k) {
2144 $map->load if $v;
2145 }
2146
2147 delete $MAP_PREFETCH{$k};
752 } 2148 }
753 } 2149 }
2150 undef $MAP_PREFETCHER;
2151 };
2152 $MAP_PREFETCHER->prio (6);
2153
2154 ()
2155}
2156
2157sub save {
2158 my ($self) = @_;
2159
2160 my $lock = cf::lock_acquire "map_data:$self->{path}";
2161
2162 $self->{last_save} = $cf::RUNTIME;
2163
2164 return unless $self->dirty;
2165
2166 my $save = $self->save_path; utf8::encode $save;
2167 my $uniq = $self->uniq_path; utf8::encode $uniq;
2168
2169 $self->{load_path} = $save;
2170
2171 return if $self->{deny_save};
2172
2173 local $self->{last_access} = $self->last_access;#d#
2174
2175 cf::async {
2176 $Coro::current->{desc} = "map player save";
2177 $_->contr->save for $self->players;
2178 };
2179
2180 if ($uniq) {
2181 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
2182 $self->_save_objects ($uniq, cf::IO_UNIQUES);
2183 } else {
2184 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754 }, 2185 }
755); 2186}
756 2187
757############################################################################# 2188sub swap_out {
2189 my ($self) = @_;
758 2190
759=head2 CORE EXTENSIONS 2191 # save first because save cedes
2192 $self->save;
760 2193
761Functions and methods that extend core crossfire objects. 2194 my $lock = cf::lock_acquire "map_data:$self->{path}";
762 2195
763=head3 cf::player 2196 return if $self->players;
2197 return if $self->in_memory != cf::MAP_IN_MEMORY;
2198 return if $self->{deny_save};
2199
2200 $self->in_memory (cf::MAP_SWAPPED);
2201
2202 $self->deactivate;
2203 $_->clear_links_to ($self) for values %cf::MAP;
2204 $self->clear;
2205}
2206
2207sub reset_at {
2208 my ($self) = @_;
2209
2210 # TODO: safety, remove and allow resettable per-player maps
2211 return 1e99 if $self->{deny_reset};
2212
2213 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
2214 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
2215
2216 $time + $to
2217}
2218
2219sub should_reset {
2220 my ($self) = @_;
2221
2222 $self->reset_at <= $cf::RUNTIME
2223}
2224
2225sub reset {
2226 my ($self) = @_;
2227
2228 my $lock = cf::lock_acquire "map_data:$self->{path}";
2229
2230 return if $self->players;
2231
2232 warn "resetting map ", $self->path;
2233
2234 $self->in_memory (cf::MAP_SWAPPED);
2235
2236 # need to save uniques path
2237 unless ($self->{deny_save}) {
2238 my $uniq = $self->uniq_path; utf8::encode $uniq;
2239
2240 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2241 if $uniq;
2242 }
2243
2244 delete $cf::MAP{$self->path};
2245
2246 $self->deactivate;
2247 $_->clear_links_to ($self) for values %cf::MAP;
2248 $self->clear;
2249
2250 $self->unlink_save;
2251 $self->destroy;
2252}
2253
2254my $nuke_counter = "aaaa";
2255
2256sub nuke {
2257 my ($self) = @_;
2258
2259 {
2260 my $lock = cf::lock_acquire "map_data:$self->{path}";
2261
2262 delete $cf::MAP{$self->path};
2263
2264 $self->unlink_save;
2265
2266 bless $self, "cf::map";
2267 delete $self->{deny_reset};
2268 $self->{deny_save} = 1;
2269 $self->reset_timeout (1);
2270 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2271
2272 $cf::MAP{$self->path} = $self;
2273 }
2274
2275 $self->reset; # polite request, might not happen
2276}
2277
2278=item $maps = cf::map::tmp_maps
2279
2280Returns an arrayref with all map paths of currently instantiated and saved
2281maps. May block.
2282
2283=cut
2284
2285sub tmp_maps() {
2286 [
2287 map {
2288 utf8::decode $_;
2289 /\.map$/
2290 ? normalise $_
2291 : ()
2292 } @{ aio_readdir $TMPDIR or [] }
2293 ]
2294}
2295
2296=item $maps = cf::map::random_maps
2297
2298Returns an arrayref with all map paths of currently instantiated and saved
2299random maps. May block.
2300
2301=cut
2302
2303sub random_maps() {
2304 [
2305 map {
2306 utf8::decode $_;
2307 /\.map$/
2308 ? normalise "?random/$_"
2309 : ()
2310 } @{ aio_readdir $RANDOMDIR or [] }
2311 ]
2312}
2313
2314=item cf::map::unique_maps
2315
2316Returns an arrayref of paths of all shared maps that have
2317instantiated unique items. May block.
2318
2319=cut
2320
2321sub unique_maps() {
2322 [
2323 map {
2324 utf8::decode $_;
2325 /\.map$/
2326 ? normalise $_
2327 : ()
2328 } @{ aio_readdir $UNIQUEDIR or [] }
2329 ]
2330}
2331
2332package cf;
2333
2334=back
2335
2336=head3 cf::object
2337
2338=cut
2339
2340package cf::object;
764 2341
765=over 4 2342=over 4
766 2343
767=item cf::player::exists $login 2344=item $ob->inv_recursive
768 2345
769Returns true when the given account exists. 2346Returns the inventory of the object _and_ their inventories, recursively.
770 2347
771=cut 2348=cut
772 2349
773sub cf::player::exists($) { 2350sub inv_recursive_;
774 cf::player::find $_[0] 2351sub inv_recursive_ {
775 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2352 map { $_, inv_recursive_ $_->inv } @_
776} 2353}
777 2354
778=item $player->ext_reply ($msgid, $msgtype, %msg) 2355sub inv_recursive {
779 2356 inv_recursive_ inv $_[0]
780Sends an ext reply to the player.
781
782=cut
783
784sub cf::player::ext_reply($$$%) {
785 my ($self, $id, %msg) = @_;
786
787 $msg{msgid} = $id;
788
789 $self->send ("ext " . to_json \%msg);
790} 2357}
2358
2359=item $ref = $ob->ref
2360
2361creates and returns a persistent reference to an objetc that can be stored as a string.
2362
2363=item $ob = cf::object::deref ($refstring)
2364
2365returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2366even if the object actually exists. May block.
2367
2368=cut
2369
2370sub deref {
2371 my ($ref) = @_;
2372
2373 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2374 my ($uuid, $name) = ($1, $2);
2375 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2376 or return;
2377 $pl->ob->uuid eq $uuid
2378 or return;
2379
2380 $pl->ob
2381 } else {
2382 warn "$ref: cannot resolve object reference\n";
2383 undef
2384 }
2385}
2386
2387package cf;
791 2388
792=back 2389=back
793 2390
794=head3 cf::object::player 2391=head3 cf::object::player
795 2392
… …
811 2408
812 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2409 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
813 2410
814 if ($self->{record_replies}) { 2411 if ($self->{record_replies}) {
815 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2412 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2413
816 } else { 2414 } else {
2415 my $pl = $self->contr;
2416
2417 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2418 my $dialog = $pl->{npc_dialog};
2419 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2420
2421 } else {
817 $msg = $npc->name . " says: $msg" if $npc; 2422 $msg = $npc->name . " says: $msg" if $npc;
818 $self->message ($msg, $flags); 2423 $self->message ($msg, $flags);
2424 }
819 } 2425 }
2426}
2427
2428=item $object->send_msg ($channel, $msg, $color, [extra...])
2429
2430=cut
2431
2432sub cf::object::send_msg {
2433 my $pl = shift->contr
2434 or return;
2435 $pl->send_msg (@_);
820} 2436}
821 2437
822=item $player_object->may ("access") 2438=item $player_object->may ("access")
823 2439
824Returns wether the given player is authorized to access resource "access" 2440Returns wether the given player is authorized to access resource "access"
… …
833 (ref $cf::CFG{"may_$access"} 2449 (ref $cf::CFG{"may_$access"}
834 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2450 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835 : $cf::CFG{"may_$access"}) 2451 : $cf::CFG{"may_$access"})
836} 2452}
837 2453
2454=item $player_object->enter_link
2455
2456Freezes the player and moves him/her to a special map (C<{link}>).
2457
2458The player should be reasonably safe there for short amounts of time. You
2459I<MUST> call C<leave_link> as soon as possible, though.
2460
2461Will never block.
2462
2463=item $player_object->leave_link ($map, $x, $y)
2464
2465Moves the player out of the special C<{link}> map onto the specified
2466map. If the map is not valid (or omitted), the player will be moved back
2467to the location he/she was before the call to C<enter_link>, or, if that
2468fails, to the emergency map position.
2469
2470Might block.
2471
2472=cut
2473
2474sub link_map {
2475 unless ($LINK_MAP) {
2476 $LINK_MAP = cf::map::find "{link}"
2477 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2478 $LINK_MAP->load;
2479 }
2480
2481 $LINK_MAP
2482}
2483
2484sub cf::object::player::enter_link {
2485 my ($self) = @_;
2486
2487 $self->deactivate_recursive;
2488
2489 return if UNIVERSAL::isa $self->map, "ext::map_link";
2490
2491 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
2492 if $self->map && $self->map->{path} ne "{link}";
2493
2494 $self->enter_map ($LINK_MAP || link_map, 10, 10);
2495}
2496
2497sub cf::object::player::leave_link {
2498 my ($self, $map, $x, $y) = @_;
2499
2500 return unless $self->contr->active;
2501
2502 my $link_pos = delete $self->{_link_pos};
2503
2504 unless ($map) {
2505 # restore original map position
2506 ($map, $x, $y) = @{ $link_pos || [] };
2507 $map = cf::map::find $map;
2508
2509 unless ($map) {
2510 ($map, $x, $y) = @$EMERGENCY_POSITION;
2511 $map = cf::map::find $map
2512 or die "FATAL: cannot load emergency map\n";
2513 }
2514 }
2515
2516 ($x, $y) = (-1, -1)
2517 unless (defined $x) && (defined $y);
2518
2519 # use -1 or undef as default coordinates, not 0, 0
2520 ($x, $y) = ($map->enter_x, $map->enter_y)
2521 if $x <=0 && $y <= 0;
2522
2523 $map->load;
2524 $map->load_neighbours;
2525
2526 return unless $self->contr->active;
2527 $self->activate_recursive;
2528
2529 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2530 $self->enter_map ($map, $x, $y);
2531}
2532
2533=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
2534
2535Moves the player to the given map-path and coordinates by first freezing
2536her, loading and preparing them map, calling the provided $check callback
2537that has to return the map if sucecssful, and then unfreezes the player on
2538the new (success) or old (failed) map position. In either case, $done will
2539be called at the end of this process.
2540
2541=cut
2542
2543our $GOTOGEN;
2544
2545sub cf::object::player::goto {
2546 my ($self, $path, $x, $y, $check, $done) = @_;
2547
2548 # do generation counting so two concurrent goto's will be executed in-order
2549 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2550
2551 $self->enter_link;
2552
2553 (async {
2554 $Coro::current->{desc} = "player::goto $path $x $y";
2555
2556 # *tag paths override both path and x|y
2557 if ($path =~ /^\*(.*)$/) {
2558 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2559 my $ob = $obs[rand @obs];
2560
2561 # see if we actually can go there
2562 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2563 $ob = $obs[rand @obs];
2564 } else {
2565 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2566 }
2567 # else put us there anyways for now #d#
2568
2569 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2570 } else {
2571 ($path, $x, $y) = (undef, undef, undef);
2572 }
2573 }
2574
2575 my $map = eval {
2576 my $map = defined $path ? cf::map::find $path : undef;
2577
2578 if ($map) {
2579 $map = $map->customise_for ($self);
2580 $map = $check->($map) if $check && $map;
2581 } else {
2582 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2583 }
2584
2585 $map
2586 };
2587
2588 if ($@) {
2589 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2590 LOG llevError | logBacktrace, Carp::longmess $@;
2591 }
2592
2593 if ($gen == $self->{_goto_generation}) {
2594 delete $self->{_goto_generation};
2595 $self->leave_link ($map, $x, $y);
2596 }
2597
2598 $done->() if $done;
2599 })->prio (1);
2600}
2601
2602=item $player_object->enter_exit ($exit_object)
2603
2604=cut
2605
2606sub parse_random_map_params {
2607 my ($spec) = @_;
2608
2609 my $rmp = { # defaults
2610 xsize => (cf::rndm 15, 40),
2611 ysize => (cf::rndm 15, 40),
2612 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2613 #layout => string,
2614 };
2615
2616 for (split /\n/, $spec) {
2617 my ($k, $v) = split /\s+/, $_, 2;
2618
2619 $rmp->{lc $k} = $v if (length $k) && (length $v);
2620 }
2621
2622 $rmp
2623}
2624
2625sub prepare_random_map {
2626 my ($exit) = @_;
2627
2628 my $guard = cf::lock_acquire "exit_prepare:$exit";
2629
2630 # all this does is basically replace the /! path by
2631 # a new random map path (?random/...) with a seed
2632 # that depends on the exit object
2633
2634 my $rmp = parse_random_map_params $exit->msg;
2635
2636 if ($exit->map) {
2637 $rmp->{region} = $exit->region->name;
2638 $rmp->{origin_map} = $exit->map->path;
2639 $rmp->{origin_x} = $exit->x;
2640 $rmp->{origin_y} = $exit->y;
2641 }
2642
2643 $rmp->{random_seed} ||= $exit->random_seed;
2644
2645 my $data = cf::encode_json $rmp;
2646 my $md5 = Digest::MD5::md5_hex $data;
2647 my $meta = "$RANDOMDIR/$md5.meta";
2648
2649 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2650 aio_write $fh, 0, (length $data), $data, 0;
2651 undef $fh;
2652 aio_rename "$meta~", $meta;
2653
2654 $exit->slaying ("?random/$md5");
2655 $exit->msg (undef);
2656 }
2657}
2658
2659sub cf::object::player::enter_exit {
2660 my ($self, $exit) = @_;
2661
2662 return unless $self->type == cf::PLAYER;
2663
2664 if ($exit->slaying eq "/!") {
2665 #TODO: this should de-fi-ni-te-ly not be a sync-job
2666 # the problem is that $exit might not survive long enough
2667 # so it needs to be done right now, right here
2668 cf::sync_job { prepare_random_map $exit };
2669 }
2670
2671 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2672 my $hp = $exit->stats->hp;
2673 my $sp = $exit->stats->sp;
2674
2675 $self->enter_link;
2676
2677 # if exit is damned, update players death & WoR home-position
2678 $self->contr->savebed ($slaying, $hp, $sp)
2679 if $exit->flag (FLAG_DAMNED);
2680
2681 (async {
2682 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2683
2684 $self->deactivate_recursive; # just to be sure
2685 unless (eval {
2686 $self->goto ($slaying, $hp, $sp);
2687
2688 1;
2689 }) {
2690 $self->message ("Something went wrong deep within the crossfire server. "
2691 . "I'll try to bring you back to the map you were before. "
2692 . "Please report this to the dungeon master!",
2693 cf::NDI_UNIQUE | cf::NDI_RED);
2694
2695 warn "ERROR in enter_exit: $@";
2696 $self->leave_link;
2697 }
2698 })->prio (1);
2699}
2700
838=head3 cf::client 2701=head3 cf::client
839 2702
840=over 4 2703=over 4
841 2704
842=item $client->send_drawinfo ($text, $flags) 2705=item $client->send_drawinfo ($text, $flags)
… …
848 2711
849sub cf::client::send_drawinfo { 2712sub cf::client::send_drawinfo {
850 my ($self, $text, $flags) = @_; 2713 my ($self, $text, $flags) = @_;
851 2714
852 utf8::encode $text; 2715 utf8::encode $text;
853 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2716 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
854} 2717}
855 2718
2719=item $client->send_msg ($channel, $msg, $color, [extra...])
2720
2721Send a drawinfo or msg packet to the client, formatting the msg for the
2722client if neccessary. C<$type> should be a string identifying the type of
2723the message, with C<log> being the default. If C<$color> is negative, suppress
2724the message unless the client supports the msg packet.
2725
2726=cut
2727
2728# non-persistent channels (usually the info channel)
2729our %CHANNEL = (
2730 "c/identify" => {
2731 id => "infobox",
2732 title => "Identify",
2733 reply => undef,
2734 tooltip => "Items recently identified",
2735 },
2736 "c/examine" => {
2737 id => "infobox",
2738 title => "Examine",
2739 reply => undef,
2740 tooltip => "Signs and other items you examined",
2741 },
2742 "c/book" => {
2743 id => "infobox",
2744 title => "Book",
2745 reply => undef,
2746 tooltip => "The contents of a note or book",
2747 },
2748 "c/lookat" => {
2749 id => "infobox",
2750 title => "Look",
2751 reply => undef,
2752 tooltip => "What you saw there",
2753 },
2754 "c/who" => {
2755 id => "infobox",
2756 title => "Players",
2757 reply => undef,
2758 tooltip => "Shows players who are currently online",
2759 },
2760 "c/body" => {
2761 id => "infobox",
2762 title => "Body Parts",
2763 reply => undef,
2764 tooltip => "Shows which body parts you posess and are available",
2765 },
2766 "c/uptime" => {
2767 id => "infobox",
2768 title => "Uptime",
2769 reply => undef,
2770 tooltip => "How long the server has been running since last restart",
2771 },
2772 "c/mapinfo" => {
2773 id => "infobox",
2774 title => "Map Info",
2775 reply => undef,
2776 tooltip => "Information related to the maps",
2777 },
2778);
2779
2780sub cf::client::send_msg {
2781 my ($self, $channel, $msg, $color, @extra) = @_;
2782
2783 $msg = $self->pl->expand_cfpod ($msg);
2784
2785 $color &= cf::NDI_CLIENT_MASK; # just in case...
2786
2787 # check predefined channels, for the benefit of C
2788 if ($CHANNEL{$channel}) {
2789 $channel = $CHANNEL{$channel};
2790
2791 $self->ext_msg (channel_info => $channel)
2792 if $self->can_msg;
2793
2794 $channel = $channel->{id};
2795
2796 } elsif (ref $channel) {
2797 # send meta info to client, if not yet sent
2798 unless (exists $self->{channel}{$channel->{id}}) {
2799 $self->{channel}{$channel->{id}} = $channel;
2800 $self->ext_msg (channel_info => $channel)
2801 if $self->can_msg;
2802 }
2803
2804 $channel = $channel->{id};
2805 }
2806
2807 return unless @extra || length $msg;
2808
2809 if ($self->can_msg) {
2810 # default colour, mask it out
2811 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2812 if $color & cf::NDI_DEF;
2813
2814 $self->send_packet ("msg " . $self->{json_coder}->encode (
2815 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2816 } else {
2817 if ($color >= 0) {
2818 # replace some tags by gcfclient-compatible ones
2819 for ($msg) {
2820 1 while
2821 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2822 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2823 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2824 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2825 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2826 }
2827
2828 $color &= cf::NDI_COLOR_MASK;
2829
2830 utf8::encode $msg;
2831
2832 if (0 && $msg =~ /\[/) {
2833 # COMMAND/INFO
2834 $self->send_packet ("drawextinfo $color 10 8 $msg")
2835 } else {
2836 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2837 $self->send_packet ("drawinfo $color $msg")
2838 }
2839 }
2840 }
2841}
2842
2843=item $client->ext_msg ($type, @msg)
2844
2845Sends an ext event to the client.
2846
2847=cut
2848
2849sub cf::client::ext_msg($$@) {
2850 my ($self, $type, @msg) = @_;
2851
2852 if ($self->extcmd == 2) {
2853 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2854 } elsif ($self->extcmd == 1) { # TODO: remove
2855 push @msg, msgtype => "event_$type";
2856 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2857 }
2858}
2859
2860=item $client->ext_reply ($msgid, @msg)
2861
2862Sends an ext reply to the client.
2863
2864=cut
2865
2866sub cf::client::ext_reply($$@) {
2867 my ($self, $id, @msg) = @_;
2868
2869 if ($self->extcmd == 2) {
2870 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2871 } elsif ($self->extcmd == 1) {
2872 #TODO: version 1, remove
2873 unshift @msg, msgtype => "reply", msgid => $id;
2874 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2875 }
2876}
856 2877
857=item $success = $client->query ($flags, "text", \&cb) 2878=item $success = $client->query ($flags, "text", \&cb)
858 2879
859Queues a query to the client, calling the given callback with 2880Queues a query to the client, calling the given callback with
860the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2881the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
861C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2882C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
862 2883
863Queries can fail, so check the return code. Or don't, as queries will become 2884Queries can fail, so check the return code. Or don't, as queries will
864reliable at some point in the future. 2885become reliable at some point in the future.
865 2886
866=cut 2887=cut
867 2888
868sub cf::client::query { 2889sub cf::client::query {
869 my ($self, $flags, $text, $cb) = @_; 2890 my ($self, $flags, $text, $cb) = @_;
… …
877 utf8::encode $text; 2898 utf8::encode $text;
878 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2899 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
879 2900
880 $self->send_packet ($self->{query_queue}[0][0]) 2901 $self->send_packet ($self->{query_queue}[0][0])
881 if @{ $self->{query_queue} } == 1; 2902 if @{ $self->{query_queue} } == 1;
2903
2904 1
882} 2905}
883 2906
884cf::client->attach ( 2907cf::client->attach (
2908 on_connect => sub {
2909 my ($ns) = @_;
2910
2911 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2912 },
885 on_reply => sub { 2913 on_reply => sub {
886 my ($ns, $msg) = @_; 2914 my ($ns, $msg) = @_;
887 2915
888 # this weird shuffling is so that direct followup queries 2916 # this weird shuffling is so that direct followup queries
889 # get handled first 2917 # get handled first
890 my $queue = delete $ns->{query_queue}; 2918 my $queue = delete $ns->{query_queue}
2919 or return; # be conservative, not sure how that can happen, but we saw a crash here
891 2920
892 (shift @$queue)->[1]->($msg); 2921 (shift @$queue)->[1]->($msg);
2922 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
893 2923
894 push @{ $ns->{query_queue} }, @$queue; 2924 push @{ $ns->{query_queue} }, @$queue;
895 2925
896 if (@{ $ns->{query_queue} } == @$queue) { 2926 if (@{ $ns->{query_queue} } == @$queue) {
897 if (@$queue) { 2927 if (@$queue) {
898 $ns->send_packet ($ns->{query_queue}[0][0]); 2928 $ns->send_packet ($ns->{query_queue}[0][0]);
899 } else { 2929 } else {
900 $ns->state (ST_PLAYING); 2930 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
901 } 2931 }
902 } 2932 }
2933 },
2934 on_exticmd => sub {
2935 my ($ns, $buf) = @_;
2936
2937 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2938
2939 if (ref $msg) {
2940 my ($type, $reply, @payload) =
2941 "ARRAY" eq ref $msg
2942 ? @$msg
2943 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2944
2945 my @reply;
2946
2947 if (my $cb = $EXTICMD{$type}) {
2948 @reply = $cb->($ns, @payload);
2949 }
2950
2951 $ns->ext_reply ($reply, @reply)
2952 if $reply;
2953
2954 } else {
2955 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2956 }
2957
2958 cf::override;
2959 },
2960);
2961
2962=item $client->async (\&cb)
2963
2964Create a new coroutine, running the specified callback. The coroutine will
2965be automatically cancelled when the client gets destroyed (e.g. on logout,
2966or loss of connection).
2967
2968=cut
2969
2970sub cf::client::async {
2971 my ($self, $cb) = @_;
2972
2973 my $coro = &Coro::async ($cb);
2974
2975 $coro->on_destroy (sub {
2976 delete $self->{_coro}{$coro+0};
2977 });
2978
2979 $self->{_coro}{$coro+0} = $coro;
2980
2981 $coro
2982}
2983
2984cf::client->attach (
2985 on_destroy => sub {
2986 my ($ns) = @_;
2987
2988 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
903 }, 2989 },
904); 2990);
905 2991
906=back 2992=back
907 2993
… …
919our $safe = new Safe "safe"; 3005our $safe = new Safe "safe";
920our $safe_hole = new Safe::Hole; 3006our $safe_hole = new Safe::Hole;
921 3007
922$SIG{FPE} = 'IGNORE'; 3008$SIG{FPE} = 'IGNORE';
923 3009
924$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3010$safe->permit_only (Opcode::opset qw(
3011 :base_core :base_mem :base_orig :base_math
3012 grepstart grepwhile mapstart mapwhile
3013 sort time
3014));
925 3015
926# here we export the classes and methods available to script code 3016# here we export the classes and methods available to script code
927 3017
928=pod 3018=pod
929 3019
930The following fucntions and emthods are available within a safe environment: 3020The following functions and methods are available within a safe environment:
931 3021
932 cf::object contr pay_amount pay_player map 3022 cf::object
3023 contr pay_amount pay_player map x y force_find force_add destroy
3024 insert remove name archname title slaying race decrease_ob_nr
3025
933 cf::object::player player 3026 cf::object::player
934 cf::player peaceful 3027 player
935 cf::map trigger 3028
3029 cf::player
3030 peaceful
3031
3032 cf::map
3033 trigger
936 3034
937=cut 3035=cut
938 3036
939for ( 3037for (
940 ["cf::object" => qw(contr pay_amount pay_player map)], 3038 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3039 insert remove inv name archname title slaying race
3040 decrease_ob_nr destroy)],
941 ["cf::object::player" => qw(player)], 3041 ["cf::object::player" => qw(player)],
942 ["cf::player" => qw(peaceful)], 3042 ["cf::player" => qw(peaceful)],
943 ["cf::map" => qw(trigger)], 3043 ["cf::map" => qw(trigger)],
944) { 3044) {
945 no strict 'refs'; 3045 no strict 'refs';
… …
1016=back 3116=back
1017 3117
1018=cut 3118=cut
1019 3119
1020############################################################################# 3120#############################################################################
3121# the server's init and main functions
1021 3122
1022=head2 EXTENSION DATABASE SUPPORT 3123sub load_facedata($) {
3124 my ($path) = @_;
1023 3125
1024Crossfire maintains a very simple database for extension use. It can 3126 # HACK to clear player env face cache, we need some signal framework
1025currently store anything that can be serialised using Storable, which 3127 # for this (global event?)
1026excludes objects. 3128 %ext::player_env::MUSIC_FACE_CACHE = ();
1027 3129
1028The parameter C<$family> should best start with the name of the extension 3130 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1029using it, it should be unique.
1030 3131
1031=over 4 3132 warn "loading facedata from $path\n";
1032 3133
1033=item $hashref = cf::db_get $family 3134 my $facedata;
3135 0 < aio_load $path, $facedata
3136 or die "$path: $!";
1034 3137
1035Return a hashref for use by the extension C<$family>, which can be 3138 $facedata = Coro::Storable::thaw $facedata;
1036modified. After modifications, you have to call C<cf::db_dirty> or
1037C<cf::db_sync>.
1038 3139
1039=item $value = cf::db_get $family => $key 3140 $facedata->{version} == 2
3141 or cf::cleanup "$path: version mismatch, cannot proceed.";
1040 3142
1041Returns a single value from the database 3143 # patch in the exptable
1042 3144 $facedata->{resource}{"res/exp_table"} = {
1043=item cf::db_put $family => $hashref 3145 type => FT_RSRC,
1044 3146 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1045Stores the given family hashref into the database. Updates are delayed, if
1046you want the data to be synced to disk immediately, use C<cf::db_sync>.
1047
1048=item cf::db_put $family => $key => $value
1049
1050Stores the given C<$value> in the family hash. Updates are delayed, if you
1051want the data to be synced to disk immediately, use C<cf::db_sync>.
1052
1053=item cf::db_dirty
1054
1055Marks the database as dirty, to be updated at a later time.
1056
1057=item cf::db_sync
1058
1059Immediately write the database to disk I<if it is dirty>.
1060
1061=cut
1062
1063our $DB;
1064
1065{
1066 my $path = cf::localdir . "/database.pst";
1067
1068 sub db_load() {
1069 warn "loading database $path\n";#d# remove later
1070 $DB = stat $path ? Storable::retrieve $path : { };
1071 }
1072
1073 my $pid;
1074
1075 sub db_save() {
1076 warn "saving database $path\n";#d# remove later
1077 waitpid $pid, 0 if $pid;
1078 if (0 == ($pid = fork)) {
1079 $DB->{_meta}{version} = 1;
1080 Storable::nstore $DB, "$path~";
1081 rename "$path~", $path;
1082 cf::_exit 0 if defined $pid;
1083 }
1084 }
1085
1086 my $dirty;
1087
1088 sub db_sync() {
1089 db_save if $dirty;
1090 undef $dirty;
1091 }
1092
1093 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1094 db_sync;
1095 }); 3147 };
3148 cf::cede_to_tick;
1096 3149
1097 sub db_dirty() {
1098 $dirty = 1;
1099 $idle->start;
1100 } 3150 {
3151 my $faces = $facedata->{faceinfo};
1101 3152
1102 sub db_get($;$) { 3153 while (my ($face, $info) = each %$faces) {
1103 @_ >= 2 3154 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1104 ? $DB->{$_[0]}{$_[1]}
1105 : ($DB->{$_[0]} ||= { })
1106 }
1107 3155
1108 sub db_put($$;$) { 3156 cf::face::set_visibility $idx, $info->{visibility};
1109 if (@_ >= 3) { 3157 cf::face::set_magicmap $idx, $info->{magicmap};
1110 $DB->{$_[0]}{$_[1]} = $_[2]; 3158 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1111 } else { 3159 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1112 $DB->{$_[0]} = $_[1];
1113 }
1114 db_dirty;
1115 }
1116 3160
1117 cf::global->attach ( 3161 cf::cede_to_tick;
1118 prio => 10000,
1119 on_cleanup => sub {
1120 db_sync;
1121 }, 3162 }
1122 );
1123}
1124 3163
1125############################################################################# 3164 while (my ($face, $info) = each %$faces) {
1126# the server's main() 3165 next unless $info->{smooth};
1127 3166
1128sub cfg_load { 3167 my $idx = cf::face::find $face
3168 or next;
3169
3170 if (my $smooth = cf::face::find $info->{smooth}) {
3171 cf::face::set_smooth $idx, $smooth;
3172 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3173 } else {
3174 warn "smooth face '$info->{smooth}' not found for face '$face'";
3175 }
3176
3177 cf::cede_to_tick;
3178 }
3179 }
3180
3181 {
3182 my $anims = $facedata->{animinfo};
3183
3184 while (my ($anim, $info) = each %$anims) {
3185 cf::anim::set $anim, $info->{frames}, $info->{facings};
3186 cf::cede_to_tick;
3187 }
3188
3189 cf::anim::invalidate_all; # d'oh
3190 }
3191
3192 {
3193 # TODO: for gcfclient pleasure, we should give resources
3194 # that gcfclient doesn't grok a >10000 face index.
3195 my $res = $facedata->{resource};
3196
3197 while (my ($name, $info) = each %$res) {
3198 if (defined $info->{type}) {
3199 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3200 my $data;
3201
3202 if ($info->{type} & 1) {
3203 # prepend meta info
3204
3205 my $meta = $enc->encode ({
3206 name => $name,
3207 %{ $info->{meta} || {} },
3208 });
3209
3210 $data = pack "(w/a*)*", $meta, $info->{data};
3211 } else {
3212 $data = $info->{data};
3213 }
3214
3215 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3216 cf::face::set_type $idx, $info->{type};
3217 } else {
3218 $RESOURCE{$name} = $info;
3219 }
3220
3221 cf::cede_to_tick;
3222 }
3223 }
3224
3225 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3226
3227 1
3228}
3229
3230cf::global->attach (on_resource_update => sub {
3231 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3232 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3233
3234 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3235 my $sound = $soundconf->{compat}[$_]
3236 or next;
3237
3238 my $face = cf::face::find "sound/$sound->[1]";
3239 cf::sound::set $sound->[0] => $face;
3240 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3241 }
3242
3243 while (my ($k, $v) = each %{$soundconf->{event}}) {
3244 my $face = cf::face::find "sound/$v";
3245 cf::sound::set $k => $face;
3246 }
3247 }
3248});
3249
3250register_exticmd fx_want => sub {
3251 my ($ns, $want) = @_;
3252
3253 while (my ($k, $v) = each %$want) {
3254 $ns->fx_want ($k, $v);
3255 }
3256};
3257
3258sub reload_regions {
3259 # HACK to clear player env face cache, we need some signal framework
3260 # for this (global event?)
3261 %ext::player_env::MUSIC_FACE_CACHE = ();
3262
3263 load_resource_file "$MAPDIR/regions"
3264 or die "unable to load regions file\n";
3265
3266 for (cf::region::list) {
3267 $_->{match} = qr/$_->{match}/
3268 if exists $_->{match};
3269 }
3270}
3271
3272sub reload_facedata {
3273 load_facedata "$DATADIR/facedata"
3274 or die "unable to load facedata\n";
3275}
3276
3277sub reload_archetypes {
3278 load_resource_file "$DATADIR/archetypes"
3279 or die "unable to load archetypes\n";
3280 #d# NEED to laod twice to resolve forward references
3281 # this really needs to be done in an extra post-pass
3282 # (which needs to be synchronous, so solve it differently)
3283 load_resource_file "$DATADIR/archetypes"
3284 or die "unable to load archetypes\n";
3285}
3286
3287sub reload_treasures {
3288 load_resource_file "$DATADIR/treasures"
3289 or die "unable to load treasurelists\n";
3290}
3291
3292sub reload_resources {
3293 warn "reloading resource files...\n";
3294
3295 reload_regions;
3296 reload_facedata;
3297 #reload_archetypes;#d#
3298 reload_archetypes;
3299 reload_treasures;
3300
3301 warn "finished reloading resource files\n";
3302}
3303
3304sub init {
3305 reload_resources;
3306}
3307
3308sub reload_config {
1129 open my $fh, "<:utf8", cf::confdir . "/config" 3309 open my $fh, "<:utf8", "$CONFDIR/config"
1130 or return; 3310 or return;
1131 3311
1132 local $/; 3312 local $/;
1133 *CFG = YAML::Syck::Load <$fh>; 3313 *CFG = YAML::Syck::Load <$fh>;
3314
3315 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3316
3317 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3318 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3319
3320 if (exists $CFG{mlockall}) {
3321 eval {
3322 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3323 and die "WARNING: m(un)lockall failed: $!\n";
3324 };
3325 warn $@ if $@;
3326 }
1134} 3327}
1135 3328
1136sub main { 3329sub main {
1137 cfg_load; 3330 # we must not ever block the main coroutine
1138 db_load; 3331 local $Coro::idle = sub {
3332 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
3333 (async {
3334 $Coro::current->{desc} = "IDLE BUG HANDLER";
3335 EV::loop EV::LOOP_ONESHOT;
3336 })->prio (Coro::PRIO_MAX);
3337 };
3338
3339 reload_config;
3340 db_init;
1139 load_extensions; 3341 load_extensions;
3342
3343 $TICK_WATCHER->start;
3344 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
1140 Event::loop; 3345 EV::loop;
1141} 3346}
1142 3347
1143############################################################################# 3348#############################################################################
1144# initialisation 3349# initialisation and cleanup
1145 3350
1146sub _perl_reload(&) { 3351# install some emergency cleanup handlers
1147 my ($msg) = @_; 3352BEGIN {
1148 3353 our %SIGWATCHER = ();
1149 $msg->("reloading..."); 3354 for my $signal (qw(INT HUP TERM)) {
1150 3355 $SIGWATCHER{$signal} = EV::signal $signal, sub {
1151 eval { 3356 cf::cleanup "SIG$signal";
1152 # cancel all watchers
1153 for (Event::all_watchers) {
1154 $_->cancel if $_->data & WF_AUTOCANCEL;
1155 } 3357 };
3358 }
3359}
1156 3360
1157 # unload all extensions 3361sub write_runtime {
3362 my $runtime = "$LOCALDIR/runtime";
3363
3364 # first touch the runtime file to show we are still running:
3365 # the fsync below can take a very very long time.
3366
3367 IO::AIO::aio_utime $runtime, undef, undef;
3368
3369 my $guard = cf::lock_acquire "write_runtime";
3370
3371 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3372 or return;
3373
3374 my $value = $cf::RUNTIME + 90 + 10;
3375 # 10 is the runtime save interval, for a monotonic clock
3376 # 60 allows for the watchdog to kill the server.
3377
3378 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3379 and return;
3380
3381 # always fsync - this file is important
3382 aio_fsync $fh
3383 and return;
3384
3385 # touch it again to show we are up-to-date
3386 aio_utime $fh, undef, undef;
3387
3388 close $fh
3389 or return;
3390
3391 aio_rename "$runtime~", $runtime
3392 and return;
3393
3394 warn "runtime file written.\n";
3395
3396 1
3397}
3398
3399sub emergency_save() {
3400 my $freeze_guard = cf::freeze_mainloop;
3401
3402 warn "enter emergency perl save\n";
3403
3404 cf::sync_job {
3405 # use a peculiar iteration method to avoid tripping on perl
3406 # refcount bugs in for. also avoids problems with players
3407 # and maps saved/destroyed asynchronously.
3408 warn "begin emergency player save\n";
3409 for my $login (keys %cf::PLAYER) {
3410 my $pl = $cf::PLAYER{$login} or next;
3411 $pl->valid or next;
3412 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3413 $pl->save;
3414 }
3415 warn "end emergency player save\n";
3416
3417 warn "begin emergency map save\n";
3418 for my $path (keys %cf::MAP) {
3419 my $map = $cf::MAP{$path} or next;
3420 $map->valid or next;
3421 $map->save;
3422 }
3423 warn "end emergency map save\n";
3424
3425 warn "begin emergency database checkpoint\n";
3426 BDB::db_env_txn_checkpoint $DB_ENV;
3427 warn "end emergency database checkpoint\n";
3428 };
3429
3430 warn "leave emergency perl save\n";
3431}
3432
3433sub post_cleanup {
3434 my ($make_core) = @_;
3435
3436 warn Carp::longmess "post_cleanup backtrace"
3437 if $make_core;
3438}
3439
3440sub do_reload_perl() {
3441 # can/must only be called in main
3442 if ($Coro::current != $Coro::main) {
3443 warn "can only reload from main coroutine";
3444 return;
3445 }
3446
3447 warn "reloading...";
3448
3449 warn "entering sync_job";
3450
3451 cf::sync_job {
3452 cf::write_runtime; # external watchdog should not bark
3453 cf::emergency_save;
3454 cf::write_runtime; # external watchdog should not bark
3455
3456 warn "syncing database to disk";
3457 BDB::db_env_txn_checkpoint $DB_ENV;
3458
3459 # if anything goes wrong in here, we should simply crash as we already saved
3460
3461 warn "flushing outstanding aio requests";
1158 for (@exts) { 3462 for (;;) {
1159 $msg->("unloading <$_>"); 3463 BDB::flush;
1160 unload_extension $_; 3464 IO::AIO::flush;
3465 Coro::cede_notself;
3466 last unless IO::AIO::nreqs || BDB::nreqs;
3467 warn "iterate...";
3468 }
3469
3470 ++$RELOAD;
3471
3472 warn "cancelling all extension coros";
3473 $_->cancel for values %EXT_CORO;
3474 %EXT_CORO = ();
3475
3476 warn "removing commands";
3477 %COMMAND = ();
3478
3479 warn "removing ext/exti commands";
3480 %EXTCMD = ();
3481 %EXTICMD = ();
3482
3483 warn "unloading/nuking all extensions";
3484 for my $pkg (@EXTS) {
3485 warn "... unloading $pkg";
3486
3487 if (my $cb = $pkg->can ("unload")) {
3488 eval {
3489 $cb->($pkg);
3490 1
3491 } or warn "$pkg unloaded, but with errors: $@";
1161 } 3492 }
1162 3493
3494 warn "... nuking $pkg";
3495 Symbol::delete_package $pkg;
3496 }
3497
1163 # unload all modules loaded from $LIBDIR 3498 warn "unloading all perl modules loaded from $LIBDIR";
1164 while (my ($k, $v) = each %INC) { 3499 while (my ($k, $v) = each %INC) {
1165 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3500 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166 3501
1167 $msg->("removing <$k>"); 3502 warn "... unloading $k";
1168 delete $INC{$k}; 3503 delete $INC{$k};
1169 3504
1170 $k =~ s/\.pm$//; 3505 $k =~ s/\.pm$//;
1171 $k =~ s/\//::/g; 3506 $k =~ s/\//::/g;
1172 3507
… …
1175 } 3510 }
1176 3511
1177 Symbol::delete_package $k; 3512 Symbol::delete_package $k;
1178 } 3513 }
1179 3514
1180 # sync database to disk
1181 cf::db_sync;
1182
1183 # get rid of safe::, as good as possible 3515 warn "getting rid of safe::, as good as possible";
1184 Symbol::delete_package "safe::$_" 3516 Symbol::delete_package "safe::$_"
1185 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 3517 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1186 3518
1187 # remove register_script_function callbacks
1188 # TODO
1189
1190 # unload cf.pm "a bit" 3519 warn "unloading cf.pm \"a bit\"";
1191 delete $INC{"cf.pm"}; 3520 delete $INC{"cf.pm"};
3521 delete $INC{"cf/pod.pm"};
1192 3522
1193 # don't, removes xs symbols, too, 3523 # don't, removes xs symbols, too,
1194 # and global variables created in xs 3524 # and global variables created in xs
1195 #Symbol::delete_package __PACKAGE__; 3525 #Symbol::delete_package __PACKAGE__;
1196 3526
1197 # reload cf.pm 3527 warn "unload completed, starting to reload now";
3528
1198 $msg->("reloading cf.pm"); 3529 warn "reloading cf.pm";
1199 require cf; 3530 require cf;
3531 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1200 3532
1201 # load config and database again 3533 warn "loading config and database again";
1202 cf::cfg_load; 3534 cf::reload_config;
1203 cf::db_load;
1204 3535
1205 # load extensions 3536 warn "loading extensions";
1206 $msg->("load extensions");
1207 cf::load_extensions; 3537 cf::load_extensions;
1208 3538
1209 # reattach attachments to objects 3539 warn "reattaching attachments to objects/players";
1210 $msg->("reattach"); 3540 _global_reattach; # objects, sockets
1211 _global_reattach; 3541 warn "reattaching attachments to maps";
3542 reattach $_ for values %MAP;
3543 warn "reattaching attachments to players";
3544 reattach $_ for values %PLAYER;
3545
3546 warn "leaving sync_job";
3547
3548 1
3549 } or do {
3550 warn $@;
3551 warn "error while reloading, exiting.";
3552 exit 1;
1212 }; 3553 };
1213 $msg->($@) if $@;
1214 3554
1215 $msg->("reloaded"); 3555 warn "reloaded";
1216}; 3556};
1217 3557
1218sub perl_reload() { 3558our $RELOAD_WATCHER; # used only during reload
1219 _perl_reload { 3559
1220 warn $_[0]; 3560sub reload_perl() {
1221 print "$_[0]\n"; 3561 # doing reload synchronously and two reloads happen back-to-back,
3562 # coro crashes during coro_state_free->destroy here.
3563
3564 $RELOAD_WATCHER ||= EV::timer 0, 0, sub {
3565 undef $RELOAD_WATCHER;
3566 do_reload_perl;
1222 }; 3567 };
1223} 3568}
1224 3569
1225register "<global>", __PACKAGE__;
1226
1227register_command "perl-reload" => sub { 3570register_command "reload" => sub {
1228 my ($who, $arg) = @_; 3571 my ($who, $arg) = @_;
1229 3572
1230 if ($who->flag (FLAG_WIZ)) { 3573 if ($who->flag (FLAG_WIZ)) {
1231 _perl_reload { 3574 $who->message ("reloading server.");
1232 warn $_[0]; 3575 async {
1233 $who->message ($_[0]); 3576 $Coro::current->{desc} = "perl_reload";
3577 reload_perl;
1234 }; 3578 };
1235 } 3579 }
1236}; 3580};
1237 3581
1238unshift @INC, $LIBDIR; 3582unshift @INC, $LIBDIR;
1239 3583
1240$TICK_WATCHER = Event->timer ( 3584my $bug_warning = 0;
1241 prio => 0, 3585
1242 at => $NEXT_TICK || 1, 3586our @WAIT_FOR_TICK;
1243 data => WF_AUTOCANCEL, 3587our @WAIT_FOR_TICK_BEGIN;
1244 cb => sub { 3588
3589sub wait_for_tick {
3590 return unless $TICK_WATCHER->is_active;
3591 return if $Coro::current == $Coro::main;
3592
3593 my $signal = new Coro::Signal;
3594 push @WAIT_FOR_TICK, $signal;
3595 $signal->wait;
3596}
3597
3598sub wait_for_tick_begin {
3599 return unless $TICK_WATCHER->is_active;
3600 return if $Coro::current == $Coro::main;
3601
3602 my $signal = new Coro::Signal;
3603 push @WAIT_FOR_TICK_BEGIN, $signal;
3604 $signal->wait;
3605}
3606
3607$TICK_WATCHER = EV::periodic_ns 0, $TICK, 0, sub {
3608 if ($Coro::current != $Coro::main) {
3609 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3610 unless ++$bug_warning > 10;
3611 return;
3612 }
3613
3614 $NOW = $tick_start = EV::now;
3615
1245 cf::server_tick; # one server iteration 3616 cf::server_tick; # one server iteration
1246 3617
1247 my $NOW = Event::time; 3618 $RUNTIME += $TICK;
1248 $NEXT_TICK += $TICK; 3619 $NEXT_TICK = $_[0]->at;
1249 3620
1250 # if we are delayed by four ticks or more, skip them all 3621 if ($NOW >= $NEXT_RUNTIME_WRITE) {
1251 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 3622 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1252 3623 Coro::async_pool {
1253 $TICK_WATCHER->at ($NEXT_TICK); 3624 $Coro::current->{desc} = "runtime saver";
1254 $TICK_WATCHER->start; 3625 write_runtime
3626 or warn "ERROR: unable to write runtime file: $!";
3627 };
1255 }, 3628 }
1256);
1257 3629
3630 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3631 $sig->send;
3632 }
3633 while (my $sig = shift @WAIT_FOR_TICK) {
3634 $sig->send;
3635 }
3636
3637 $LOAD = ($NOW - $tick_start) / $TICK;
3638 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3639
3640 _post_tick;
3641};
3642$TICK_WATCHER->priority (EV::MAXPRI);
3643
3644{
3645 # configure BDB
3646
3647 BDB::min_parallel 8;
3648 BDB::max_poll_reqs $TICK * 0.1;
3649 $Coro::BDB::WATCHER->priority (1);
3650
3651 unless ($DB_ENV) {
3652 $DB_ENV = BDB::db_env_create;
3653 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC
3654 | BDB::LOG_AUTOREMOVE, 1);
3655 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3656 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3657
3658 cf::sync_job {
3659 eval {
3660 BDB::db_env_open
3661 $DB_ENV,
3662 $BDBDIR,
3663 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3664 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3665 0666;
3666
3667 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3668 };
3669
3670 cf::cleanup "db_env_open(db): $@" if $@;
3671 };
3672 }
3673
3674 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3675 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3676 };
3677 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3678 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3679 };
3680 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3681 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3682 };
3683}
3684
3685{
3686 # configure IO::AIO
3687
3688 IO::AIO::min_parallel 8;
1258IO::AIO::max_poll_time $TICK * 0.2; 3689 IO::AIO::max_poll_time $TICK * 0.1;
3690 $Coro::AIO::WATCHER->priority (1);
3691}
1259 3692
1260Event->io (fd => IO::AIO::poll_fileno, 3693my $_log_backtrace;
1261 poll => 'r', 3694
1262 prio => 5, 3695sub _log_backtrace {
1263 data => WF_AUTOCANCEL, 3696 my ($msg, @addr) = @_;
1264 cb => \&IO::AIO::poll_cb); 3697
3698 $msg =~ s/\n//;
3699
3700 # limit the # of concurrent backtraces
3701 if ($_log_backtrace < 2) {
3702 ++$_log_backtrace;
3703 async {
3704 $Coro::current->{desc} = "abt $msg";
3705
3706 my @bt = fork_call {
3707 @addr = map { sprintf "%x", $_ } @addr;
3708 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3709 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3710 or die "addr2line: $!";
3711
3712 my @funcs;
3713 my @res = <$fh>;
3714 chomp for @res;
3715 while (@res) {
3716 my ($func, $line) = splice @res, 0, 2, ();
3717 push @funcs, "[$func] $line";
3718 }
3719
3720 @funcs
3721 };
3722
3723 LOG llevInfo, "[ABT] $msg\n";
3724 LOG llevInfo, "[ABT] $_\n" for @bt;
3725 --$_log_backtrace;
3726 };
3727 } else {
3728 LOG llevInfo, "[ABT] $msg\n";
3729 LOG llevInfo, "[ABT] [suppressed]\n";
3730 }
3731}
3732
3733# load additional modules
3734use cf::pod;
3735
3736END { cf::emergency_save }
1265 3737
12661 37381
1267 3739

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines