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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines