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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines