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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines