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.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.283 by root, Sun Jun 24 04:09:29 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
8use Socket;
5use Storable; 9use Storable;
10use Event;
6use Opcode; 11use Opcode;
7use Safe; 12use Safe;
8use Safe::Hole; 13use Safe::Hole;
9 14
10use IO::AIO (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::Event;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
24
25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
28use Fcntl;
11use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
12use Time::HiRes; 31use Time::HiRes;
13use 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
14$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
15 41
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
18 44
19use strict; 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
46
47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
20 48
21our %COMMAND = (); 49our %COMMAND = ();
22our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
23our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
24 56
25_init_vars; 57our $RELOAD; # number of reloads so far
26
27our @EVENT; 58our @EVENT;
28our $LIBDIR = maps_directory "perl";
29 59
30our $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(!)
31our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
32our $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;
33 82
34our %CFG; 83our %CFG;
35 84
36our $UPTIME; $UPTIME ||= time; 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;
37 115
38############################################################################# 116#############################################################################
39 117
40=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
41 119
43 121
44=item $cf::UPTIME 122=item $cf::UPTIME
45 123
46The timestamp of the server start (so not actually an uptime). 124The timestamp of the server start (so not actually an uptime).
47 125
48=item $cf::LIBDIR 126=item $cf::RUNTIME
49 127
50The perl library directory, where extensions and cf-specific modules can 128The time this server has run, starts at 0 and is increased by $cf::TICK on
51be found. It will be added to C<@INC> automatically. 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.
52 143
53=item $cf::TICK 144=item $cf::TICK
54 145
55The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
56 157
57=item %cf::CFG 158=item %cf::CFG
58 159
59Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
60from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
61 168
62=back 169=back
63 170
64=cut 171=cut
65 172
66BEGIN { 173BEGIN {
67 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
68 my $msg = join "", @_; 175 my $msg = join "", @_;
176
69 $msg .= "\n" 177 $msg .= "\n"
70 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
71 179
72 print STDERR "cfperl: $msg"; 180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
73 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
74 }; 184 };
75} 185}
76 186
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
77@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)
78 194
79# 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
80# within the Safe compartment. 196# within the Safe compartment.
81for my $pkg (qw( 197for my $pkg (qw(
198 cf::global cf::attachable
82 cf::object cf::object::player 199 cf::object cf::object::player
83 cf::client_socket cf::player 200 cf::client cf::player
84 cf::arch cf::living 201 cf::arch cf::living
85 cf::map cf::party cf::region 202 cf::map cf::party cf::region
86)) { 203)) {
87 no strict 'refs'; 204 no strict 'refs';
88 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 205 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
90 207
91$Event::DIED = sub { 208$Event::DIED = sub {
92 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
93}; 210};
94 211
95my %ext_pkg; 212#############################################################################
96my @exts;
97my @hook;
98 213
99=head2 UTILITY FUNCTIONS 214=head2 UTILITY FUNCTIONS
100 215
101=over 4 216=over 4
102 217
103=cut 218=item dumpval $ref
104 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
105use JSON::Syck (); # TODO# replace by JSON::PC once working 241use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
106 242
107=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
108 244
109Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
110 246
111=cut
112
113sub from_json($) {
114 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
115 JSON::Syck::Load $_[0]
116}
117
118=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
119 248
120Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
121 250
122=cut 251=item cf::lock_wait $string
123 252
124sub to_json($) { 253Wait until the given lock is available. See cf::lock_acquire.
125 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 254
126 JSON::Syck::Dump $_[0] 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 }
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 });
127} 567}
128 568
129=back 569=back
130 570
131=cut 571=cut
132 572
133############################################################################# 573#############################################################################
134 574
135=head2 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).
136 584
137=over 4 585=over 4
138 586
139=item $object->attach ($attachment, key => $value...)
140
141=item $object->detach ($attachment)
142
143Attach/detach a pre-registered attachment to an object.
144
145=item $player->attach ($attachment, key => $value...)
146
147=item $player->detach ($attachment)
148
149Attach/detach a pre-registered attachment to a player.
150
151=item $map->attach ($attachment, key => $value...) 587=item $attachable->attach ($attachment, key => $value...)
152 588
153=item $map->detach ($attachment) 589=item $attachable->detach ($attachment)
154 590
155Attach/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.
156 593
157=item $bool = $object->attached ($name) 594Example, attach a minesweeper attachment to the given object, making it a
59510x10 minesweeper game:
158 596
159=item $bool = $player->attached ($name) 597 $obj->attach (minesweeper => width => 10, height => 10);
160 598
161=item $bool = $map->attached ($name) 599=item $bool = $attachable->attached ($name)
162 600
163Checks wether the named attachment is currently attached to the object. 601Checks wether the named attachment is currently attached to the object.
164 602
165=item cf::attach_global ... 603=item cf::CLASS->attach ...
166 604
167Attach handlers for global events. 605=item cf::CLASS->detach ...
168 606
169This and all following C<attach_*>-functions expect any number of the 607Define an anonymous attachment and attach it to all objects of the given
170following 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:
171 641
172=over 4 642=over 4
173 643
174=item prio => $number 644=item prio => $number
175 645
177by another C<prio> setting). Lower priority handlers get executed 647by another C<prio> setting). Lower priority handlers get executed
178earlier. 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
179registered at priority C<-1000>, so lower priorities should not be used 649registered at priority C<-1000>, so lower priorities should not be used
180unless you know what you are doing. 650unless you know what you are doing.
181 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
182=item on_I<event> => \&cb 658=item on_I<event> => \&cb
183 659
184Call the given code reference whenever the named event happens (event is 660Call the given code reference whenever the named event happens (event is
185something 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
186handlers are recognised generally depends on the type of object these 662handlers are recognised generally depends on the type of object these
195package and register them. Only handlers for eevents supported by the 671package and register them. Only handlers for eevents supported by the
196object/class are recognised. 672object/class are recognised.
197 673
198=back 674=back
199 675
200=item cf::attach_to_type $object_type, $subtype, ... 676Example, define an attachment called "sockpuppet" that calls the given
677event handler when a monster attacks:
201 678
202Attach handlers for a specific object type (e.g. TRANSPORT) and 679 cf::object::attachment sockpuppet =>
203subtype. If C<$subtype> is zero or undef, matches all objects of the given 680 on_skill_attack => sub {
204type. 681 my ($self, $victim) = @_;
205 682 ...
206=item cf::attach_to_objects ...
207
208Attach handlers to all objects. Do not use this except for debugging or
209very rare events, as handlers are (obviously) called for I<all> objects in
210the game.
211
212=item cf::attach_to_players ...
213
214Attach handlers to all players.
215
216=item cf::attach_to_maps ...
217
218Attach handlers to all maps.
219
220=item cf:register_attachment $name, ...
221
222Register an attachment by name through which objects can refer to this
223attachment.
224
225=item cf:register_player_attachment $name, ...
226
227Register an attachment by name through which players can refer to this
228attachment.
229
230=item cf:register_map_attachment $name, ...
231
232Register an attachment by name through which maps can refer to this
233attachment.
234
235=cut
236
237# the following variables are defined in .xs and must not be re-created
238our @CB_GLOBAL = (); # registry for all global events
239our @CB_OBJECT = (); # all objects (should not be used except in emergency)
240our @CB_PLAYER = ();
241our @CB_TYPE = (); # registry for type (cf-object class) based events
242our @CB_MAP = ();
243
244my %attachment;
245
246sub _attach_cb($\%$$$) {
247 my ($registry, $undo, $event, $prio, $cb) = @_;
248
249 use sort 'stable';
250
251 $cb = [$prio, $cb];
252
253 @{$registry->[$event]} = sort
254 { $a->[0] cmp $b->[0] }
255 @{$registry->[$event] || []}, $cb;
256
257 push @{$undo->{cb}}, [$event, $cb];
258}
259
260# attach handles attaching event callbacks
261# the only thing the caller has to do is pass the correct
262# registry (== where the callback attaches to).
263sub _attach(\@$@) {
264 my ($registry, $klass, @arg) = @_;
265
266 my $prio = 0;
267
268 my %undo = (
269 registry => $registry,
270 cb => [],
271 );
272
273 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
274
275 while (@arg) {
276 my $type = shift @arg;
277
278 if ($type eq "prio") {
279 $prio = shift @arg;
280
281 } elsif ($type eq "package") {
282 my $pkg = shift @arg;
283
284 while (my ($name, $id) = each %cb_id) {
285 if (my $cb = $pkg->can ($name)) {
286 _attach_cb $registry, %undo, $id, $prio, $cb;
287 }
288 } 683 }
289
290 } elsif (exists $cb_id{$type}) {
291 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
292
293 } elsif (ref $type) {
294 warn "attaching objects not supported, ignoring.\n";
295
296 } else {
297 shift @arg;
298 warn "attach argument '$type' not supported, ignoring.\n";
299 }
300 }
301
302 \%undo
303}
304
305sub _attach_attachment {
306 my ($obj, $name, %arg) = @_;
307
308 return if exists $obj->{_attachment}{$name};
309
310 my $res;
311
312 if (my $attach = $attachment{$name}) {
313 my $registry = $obj->registry;
314
315 for (@$attach) {
316 my ($klass, @attach) = @$_;
317 $res = _attach @$registry, $klass, @attach;
318 }
319
320 $obj->{$name} = \%arg;
321 } else {
322 warn "object uses attachment '$name' that is not available, postponing.\n";
323 }
324
325 $obj->{_attachment}{$name} = undef;
326
327 $res->{attachment} = $name;
328 $res
329}
330
331*cf::object::attach =
332*cf::player::attach =
333*cf::map::attach = sub {
334 my ($obj, $name, %arg) = @_;
335
336 _attach_attachment $obj, $name, %arg;
337};
338
339# all those should be optimised
340*cf::object::detach =
341*cf::player::detach =
342*cf::map::detach = sub {
343 my ($obj, $name) = @_;
344
345 delete $obj->{_attachment}{$name};
346 reattach ($obj);
347};
348
349*cf::object::attached =
350*cf::player::attached =
351*cf::map::attached = sub {
352 my ($obj, $name) = @_;
353
354 exists $obj->{_attachment}{$name}
355};
356
357sub attach_global {
358 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
359}
360
361sub attach_to_type {
362 my $type = shift;
363 my $subtype = shift;
364
365 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
366}
367
368sub attach_to_objects {
369 _attach @CB_OBJECT, KLASS_OBJECT, @_
370}
371
372sub attach_to_players {
373 _attach @CB_PLAYER, KLASS_PLAYER, @_
374}
375
376sub attach_to_maps {
377 _attach @CB_MAP, KLASS_MAP, @_
378}
379
380sub register_attachment {
381 my $name = shift;
382
383 $attachment{$name} = [[KLASS_OBJECT, @_]];
384}
385
386sub register_player_attachment {
387 my $name = shift;
388
389 $attachment{$name} = [[KLASS_PLAYER, @_]];
390}
391
392sub register_map_attachment {
393 my $name = shift;
394
395 $attachment{$name} = [[KLASS_MAP, @_]];
396}
397
398our $override;
399our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
400
401sub override {
402 $override = 1;
403 @invoke_results = ();
404}
405
406sub do_invoke {
407 my $event = shift;
408 my $callbacks = shift;
409
410 @invoke_results = ();
411
412 local $override;
413
414 for (@$callbacks) {
415 eval { &{$_->[1]} };
416
417 if ($@) {
418 warn "$@";
419 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
420 override;
421 }
422
423 return 1 if $override;
424 }
425
426 0 684 }
427}
428 685
429=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 686=item $attachable->valid
430
431=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
432
433=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
434
435=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
436
437Generate a global/object/player/map-specific event with the given arguments.
438
439This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
440removed in future versions), and there is no public API to access override
441results (if you must, access C<@cf::invoke_results> directly).
442
443=back
444
445=cut
446
447#############################################################################
448
449=head2 METHODS VALID FOR ALL CORE OBJECTS
450
451=over 4
452
453=item $object->valid, $player->valid, $map->valid
454 687
455Just 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
456C-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
457valid C counterpart anymore you get an exception at runtime. This method 690valid C counterpart anymore you get an exception at runtime. This method
458can 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
459exception. 692exception.
460 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
461=back 885=back
462 886
463=cut 887=cut
464
465*cf::object::valid =
466*cf::player::valid =
467*cf::map::valid = \&cf::_valid;
468 888
469############################################################################# 889#############################################################################
470# object support 890# object support
471 891
472sub instantiate {
473 my ($obj, $data) = @_;
474
475 $data = from_json $data;
476
477 for (@$data) {
478 my ($name, $args) = @$_;
479
480 $obj->attach ($name, %{$args || {} });
481 }
482}
483
484# basically do the same as instantiate, without calling instantiate
485sub reattach { 892sub reattach {
893 # basically do the same as instantiate, without calling instantiate
486 my ($obj) = @_; 894 my ($obj) = @_;
895
896 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
897
487 my $registry = $obj->registry; 898 my $registry = $obj->registry;
488 899
489 @$registry = (); 900 @$registry = ();
490 901
491 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 902 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
492 903
493 for my $name (keys %{ $obj->{_attachment} || {} }) { 904 for my $name (keys %{ $obj->{_attachment} || {} }) {
494 if (my $attach = $attachment{$name}) { 905 if (my $attach = $attachment{$name}) {
495 for (@$attach) { 906 for (@$attach) {
496 my ($klass, @attach) = @$_; 907 my ($klass, @attach) = @$_;
497 _attach @$registry, $klass, @attach; 908 _attach $registry, $klass, @attach;
498 } 909 }
499 } else { 910 } else {
500 warn "object uses attachment '$name' that is not available, postponing.\n"; 911 warn "object uses attachment '$name' that is not available, postponing.\n";
501 } 912 }
502 } 913 }
503} 914}
504 915
505sub object_freezer_save { 916cf::attachable->attach (
506 my ($filename, $rdata, $objs) = @_;
507
508 if (length $$rdata) {
509 warn sprintf "saving %s (%d,%d)\n",
510 $filename, length $$rdata, scalar @$objs;
511
512 if (open my $fh, ">:raw", "$filename~") {
513 chmod SAVE_MODE, $fh;
514 syswrite $fh, $$rdata;
515 close $fh;
516
517 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
518 chmod SAVE_MODE, $fh;
519 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
520 close $fh;
521 rename "$filename.pst~", "$filename.pst";
522 } else {
523 unlink "$filename.pst";
524 }
525
526 rename "$filename~", $filename;
527 } else {
528 warn "FATAL: $filename~: $!\n";
529 }
530 } else {
531 unlink $filename;
532 unlink "$filename.pst";
533 }
534}
535
536sub object_freezer_as_string {
537 my ($rdata, $objs) = @_;
538
539 use Data::Dumper;
540
541 $$rdata . Dumper $objs
542}
543
544sub object_thawer_load {
545 my ($filename) = @_;
546
547 local $/;
548
549 my $av;
550
551 #TODO: use sysread etc.
552 if (open my $data, "<:raw:perlio", $filename) {
553 $data = <$data>;
554 if (open my $pst, "<:raw:perlio", "$filename.pst") {
555 $av = eval { (Storable::thaw <$pst>)->{objs} };
556 }
557 return ($data, $av);
558 }
559
560 ()
561}
562
563attach_to_objects
564 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,
565 on_clone => sub { 930 on_clone => sub {
566 my ($src, $dst) = @_; 931 my ($src, $dst) = @_;
567 932
568 @{$dst->registry} = @{$src->registry}; 933 @{$dst->registry} = @{$src->registry};
569 934
570 %$dst = %$src; 935 %$dst = %$src;
571 936
572 %{$dst->{_attachment}} = %{$src->{_attachment}} 937 %{$dst->{_attachment}} = %{$src->{_attachment}}
573 if exists $src->{_attachment}; 938 if exists $src->{_attachment};
574 }, 939 },
575; 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
576 1012
577############################################################################# 1013#############################################################################
578# command handling &c 1014# command handling &c
579 1015
580=item cf::register_command $name => \&callback($ob,$args); 1016=item cf::register_command $name => \&callback($ob,$args);
593 push @{ $COMMAND{$name} }, [$caller, $cb]; 1029 push @{ $COMMAND{$name} }, [$caller, $cb];
594} 1030}
595 1031
596=item cf::register_extcmd $name => \&callback($pl,$packet); 1032=item cf::register_extcmd $name => \&callback($pl,$packet);
597 1033
598Register a callbackf ro execution when the client sends an extcmd packet. 1034Register a callback fro execution when the client sends an extcmd packet.
599 1035
600If the callback returns something, it is sent back as if reply was being 1036If the callback returns something, it is sent back as if reply was being
601called. 1037called.
602 1038
603=cut 1039=cut
604 1040
605sub register_extcmd { 1041sub register_extcmd {
606 my ($name, $cb) = @_; 1042 my ($name, $cb) = @_;
607 1043
608 my $caller = caller;
609 #warn "registering extcmd '$name' to '$caller'";
610
611 $EXTCMD{$name} = [$cb, $caller]; 1044 $EXTCMD{$name} = $cb;
612} 1045}
613 1046
614attach_to_players 1047cf::player->attach (
615 on_command => sub { 1048 on_command => sub {
616 my ($pl, $name, $params) = @_; 1049 my ($pl, $name, $params) = @_;
617 1050
618 my $cb = $COMMAND{$name} 1051 my $cb = $COMMAND{$name}
619 or return; 1052 or return;
629 1062
630 my $msg = eval { from_json $buf }; 1063 my $msg = eval { from_json $buf };
631 1064
632 if (ref $msg) { 1065 if (ref $msg) {
633 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1066 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
634 if (my %reply = $cb->[0]->($pl, $msg)) { 1067 if (my %reply = $cb->($pl, $msg)) {
635 $pl->ext_reply ($msg->{msgid}, %reply); 1068 $pl->ext_reply ($msg->{msgid}, %reply);
636 } 1069 }
637 } 1070 }
638 } else { 1071 } else {
639 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1072 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
640 } 1073 }
641 1074
642 cf::override; 1075 cf::override;
643 }, 1076 },
644; 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}
1151
1152#############################################################################
1153
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
645 1485
646sub register { 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 {
647 my ($base, $pkg) = @_; 1500 my ($self, $merge) = @_;
648 1501
649 #TODO 1502 # we have to keep some variables in memory intact
650} 1503 local $self->{path};
1504 local $self->{load_path};
651 1505
652sub load_extension { 1506 $self->SUPER::thawer_merge ($merge);
1507}
1508
1509sub normalise {
653 my ($path) = @_; 1510 my ($path, $base) = @_;
654 1511
655 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1512 $path = "$path"; # make sure its a string
656 my $base = $1;
657 my $pkg = $1;
658 $pkg =~ s/[^[:word:]]/_/g;
659 $pkg = "ext::$pkg";
660 1513
661 warn "loading '$path' into '$pkg'\n"; 1514 $path =~ s/\.map$//;
662 1515
663 open my $fh, "<:utf8", $path 1516 # map plan:
664 or die "$path: $!"; 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
665 1524
666 my $source = 1525 $path =~ s/$PATH_SEP/\//go;
667 "package $pkg; use strict; use utf8;\n"
668 . "#line 1 \"$path\"\n{\n"
669 . (do { local $/; <$fh> })
670 . "\n};\n1";
671 1526
672 eval $source 1527 # treat it as relative path if it starts with
673 or die $@ ? "$path: $@\n" 1528 # something that looks reasonable
674 : "extension disabled.\n"; 1529 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1530 $base or Carp::carp "normalise called with relative path and no base: '$path'";
675 1531
676 push @exts, $pkg; 1532 $base =~ s{[^/]+/?$}{};
677 $ext_pkg{$base} = $pkg; 1533 $path = "$base/$path";
678
679# no strict 'refs';
680# @{"$pkg\::ISA"} = ext::;
681
682 register $base, $pkg;
683}
684
685sub unload_extension {
686 my ($pkg) = @_;
687
688 warn "removing extension $pkg\n";
689
690 # remove hooks
691 #TODO
692# for my $idx (0 .. $#PLUGIN_EVENT) {
693# delete $hook[$idx]{$pkg};
694# } 1534 }
695 1535
696 # remove commands 1536 for ($path) {
697 for my $name (keys %COMMAND) { 1537 redo if s{//}{/};
698 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1538 redo if s{/\.?/}{/};
1539 redo if s{/[^/]+/\.\./}{/};
1540 }
699 1541
700 if (@cb) { 1542 $path
701 $COMMAND{$name} = \@cb; 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;
702 } else { 1681 } else {
703 delete $COMMAND{$name}; 1682 $self->load_header_orig
704 } 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
705 } 1693 1
1694}
706 1695
707 # remove extcmds 1696sub find;
708 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1697sub find {
709 delete $EXTCMD{$name}; 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
710 } 1736 {
1737 my $guard = cf::lock_acquire "map_load:$path";
711 1738
712 if (my $cb = $pkg->can ("unload")) { 1739 return if $self->in_memory != cf::MAP_SWAPPED;
713 eval { 1740
714 $cb->($pkg); 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);
715 1 1759 }
716 } or warn "$pkg unloaded, but with errors: $@"; 1760 }
717 }
718 1761
719 Symbol::delete_package $pkg; 1762 Coro::cede;
720} 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;
721 1768
722sub load_extensions { 1769 unless ($self->{deny_activate}) {
723 my $LIBDIR = maps_directory "perl"; 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 }
724 1778
725 for my $ext (<$LIBDIR/*.ext>) { 1779 $self->in_memory (cf::MAP_IN_MEMORY);
726 next unless -r $ext;
727 eval {
728 load_extension $ext;
729 1
730 } or warn "$ext not loaded: $@";
731 } 1780 }
732}
733 1781
734############################################################################# 1782 $self->post_load;
735# load/save/clean perl data associated with a map 1783}
736 1784
737*cf::mapsupport::on_clean = sub { 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 {
738 my ($map) = @_; 1799 my ($map) = @_;
739 1800
740 my $path = $map->tmpname; 1801 my @diag; # diagonal neighbours
741 defined $path or return;
742 1802
743 unlink "$path.pst"; 1803 for (0 .. 3) {
744}; 1804 my $neigh = $map->tile_path ($_)
1805 or next;
1806 $neigh = find $neigh, $map
1807 or next;
1808 $neigh->load;
745 1809
746attach_to_maps prio => -10000, package => cf::mapsupport::; 1810 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1811 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1812 }
747 1813
748############################################################################# 1814 for (@diag) {
749# load/save perl data associated with player->ob objects 1815 my $neigh = find @$_
750 1816 or next;
751sub all_objects(@) { 1817 $neigh->load;
752 @_, map all_objects ($_->inv), @_ 1818 }
753} 1819}
754 1820
755# TODO: compatibility cruft, remove when no longer needed 1821sub find_sync {
756attach_to_players 1822 my ($path, $origin) = @_;
757 on_load => sub {
758 my ($pl, $path) = @_;
759 1823
760 for my $o (all_objects $pl->ob) { 1824 cf::sync_job { find $path, $origin }
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1825}
762 $o->set_ob_key_value ("_perl_data");
763 1826
764 %$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};
765 } 1854 }
766 } 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);
767 }, 1890 }
768; 1891}
769 1892
770############################################################################# 1893sub swap_out {
1894 my ($self) = @_;
771 1895
772=head2 CORE EXTENSIONS 1896 # save first because save cedes
1897 $self->save;
773 1898
774Functions and methods that extend core crossfire objects. 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;
775 2039
776=over 4 2040=over 4
777 2041
778=item cf::player::exists $login 2042=item $ob->inv_recursive
779 2043
780Returns true when the given account exists. 2044Returns the inventory of the object _and_ their inventories, recursively.
781 2045
782=cut 2046=cut
783 2047
784sub cf::player::exists($) { 2048sub inv_recursive_;
785 cf::player::find $_[0] 2049sub inv_recursive_ {
786 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2050 map { $_, inv_recursive_ $_->inv } @_
787} 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
788 2064
789=item $player_object->reply ($npc, $msg[, $flags]) 2065=item $player_object->reply ($npc, $msg[, $flags])
790 2066
791Sends 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>
792can 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
794 2070
795=cut 2071=cut
796 2072
797# rough implementation of a future "reply" method that works 2073# rough implementation of a future "reply" method that works
798# with dialog boxes. 2074# with dialog boxes.
2075#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 2076sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 2077 my ($self, $npc, $msg, $flags) = @_;
801 2078
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2079 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 2080
804 if ($self->{record_replies}) { 2081 if ($self->{record_replies}) {
805 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2082 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2083
806 } 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 {
807 $msg = $npc->name . " says: $msg" if $npc; 2097 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 2098 $self->message ($msg, $flags);
2099 }
809 } 2100 }
810}
811
812=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814Sends an ext reply to the player.
815
816=cut
817
818sub cf::player::ext_reply($$$%) {
819 my ($self, $id, %msg) = @_;
820
821 $msg{msgid} = $id;
822
823 $self->send ("ext " . to_json \%msg);
824} 2101}
825 2102
826=item $player_object->may ("access") 2103=item $player_object->may ("access")
827 2104
828Returns wether the given player is authorized to access resource "access" 2105Returns wether the given player is authorized to access resource "access"
837 (ref $cf::CFG{"may_$access"} 2114 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2115 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 2116 : $cf::CFG{"may_$access"})
840} 2117}
841 2118
842=cut 2119=item $player_object->enter_link
843 2120
844############################################################################# 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,
2255 };
2256
2257 for (split /\n/, $spec) {
2258 my ($k, $v) = split /\s+/, $_, 2;
2259
2260 $rmp->{lc $k} = $v if (length $k) && (length $v);
2261 }
2262
2263 $rmp
2264}
2265
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]${1}[\/color]/;
2379 }
2380
2381 if ($color >= 0) {
2382 if ($msg =~ /\[/) {
2383 $self->send_packet ("drawextinfo $color 4 0 $msg")
2384 } else {
2385 $self->send_packet ("drawinfo $color $msg")
2386 }
2387 }
2388 }
2389}
2390
2391=item $client->ext_event ($type, %msg)
2392
2393Sends an exti event to the client.
2394
2395=cut
2396
2397sub cf::client::ext_event($$%) {
2398 my ($self, $type, %msg) = @_;
2399
2400 $msg{msgtype} = "event_$type";
2401 $self->send_packet ("ext " . cf::to_json \%msg);
2402}
2403
2404=item $success = $client->query ($flags, "text", \&cb)
2405
2406Queues a query to the client, calling the given callback with
2407the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2408C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2409
2410Queries can fail, so check the return code. Or don't, as queries will become
2411reliable at some point in the future.
2412
2413=cut
2414
2415sub cf::client::query {
2416 my ($self, $flags, $text, $cb) = @_;
2417
2418 return unless $self->state == ST_PLAYING
2419 || $self->state == ST_SETUP
2420 || $self->state == ST_CUSTOM;
2421
2422 $self->state (ST_CUSTOM);
2423
2424 utf8::encode $text;
2425 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2426
2427 $self->send_packet ($self->{query_queue}[0][0])
2428 if @{ $self->{query_queue} } == 1;
2429}
2430
2431cf::client->attach (
2432 on_reply => sub {
2433 my ($ns, $msg) = @_;
2434
2435 # this weird shuffling is so that direct followup queries
2436 # get handled first
2437 my $queue = delete $ns->{query_queue}
2438 or return; # be conservative, not sure how that can happen, but we saw a crash here
2439
2440 (shift @$queue)->[1]->($msg);
2441 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2442
2443 push @{ $ns->{query_queue} }, @$queue;
2444
2445 if (@{ $ns->{query_queue} } == @$queue) {
2446 if (@$queue) {
2447 $ns->send_packet ($ns->{query_queue}[0][0]);
2448 } else {
2449 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2450 }
2451 }
2452 },
2453);
2454
2455=item $client->async (\&cb)
2456
2457Create a new coroutine, running the specified callback. The coroutine will
2458be automatically cancelled when the client gets destroyed (e.g. on logout,
2459or loss of connection).
2460
2461=cut
2462
2463sub cf::client::async {
2464 my ($self, $cb) = @_;
2465
2466 my $coro = &Coro::async ($cb);
2467
2468 $coro->on_destroy (sub {
2469 delete $self->{_coro}{$coro+0};
2470 });
2471
2472 $self->{_coro}{$coro+0} = $coro;
2473
2474 $coro
2475}
2476
2477cf::client->attach (
2478 on_destroy => sub {
2479 my ($ns) = @_;
2480
2481 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2482 },
2483);
2484
2485=back
2486
845 2487
846=head2 SAFE SCRIPTING 2488=head2 SAFE SCRIPTING
847 2489
848Functions that provide a safe environment to compile and execute 2490Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 2491snippets of perl code without them endangering the safety of the server
862 2504
863# here we export the classes and methods available to script code 2505# here we export the classes and methods available to script code
864 2506
865=pod 2507=pod
866 2508
867The following fucntions and emthods are available within a safe environment: 2509The following functions and methods are available within a safe environment:
868 2510
869 cf::object contr pay_amount pay_player 2511 cf::object contr pay_amount pay_player map
870 cf::object::player player 2512 cf::object::player player
871 cf::player peaceful 2513 cf::player peaceful
2514 cf::map trigger
872 2515
873=cut 2516=cut
874 2517
875for ( 2518for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 2519 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 2520 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 2521 ["cf::player" => qw(peaceful)],
2522 ["cf::map" => qw(trigger)],
879) { 2523) {
880 no strict 'refs'; 2524 no strict 'refs';
881 my ($pkg, @funs) = @$_; 2525 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2526 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 2527 for @funs;
951=back 2595=back
952 2596
953=cut 2597=cut
954 2598
955############################################################################# 2599#############################################################################
2600# the server's init and main functions
956 2601
957=head2 EXTENSION DATABASE SUPPORT 2602sub load_facedata($) {
2603 my ($path) = @_;
958 2604
959Crossfire maintains a very simple database for extension use. It can 2605 warn "loading facedata from $path\n";
960currently store anything that can be serialised using Storable, which
961excludes objects.
962 2606
963The parameter C<$family> should best start with the name of the extension 2607 my $facedata;
964using it, it should be unique. 2608 0 < aio_load $path, $facedata
2609 or die "$path: $!";
965 2610
966=over 4 2611 $facedata = Coro::Storable::thaw $facedata;
967 2612
968=item $hashref = cf::db_get $family 2613 $facedata->{version} == 2
2614 or cf::cleanup "$path: version mismatch, cannot proceed.";
969 2615
970Return a hashref for use by the extension C<$family>, which can be
971modified. After modifications, you have to call C<cf::db_dirty> or
972C<cf::db_sync>.
973
974=item $value = cf::db_get $family => $key
975
976Returns a single value from the database
977
978=item cf::db_put $family => $hashref
979
980Stores the given family hashref into the database. Updates are delayed, if
981you want the data to be synced to disk immediately, use C<cf::db_sync>.
982
983=item cf::db_put $family => $key => $value
984
985Stores the given C<$value> in the family hash. Updates are delayed, if you
986want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988=item cf::db_dirty
989
990Marks the database as dirty, to be updated at a later time.
991
992=item cf::db_sync
993
994Immediately write the database to disk I<if it is dirty>.
995
996=cut
997
998our $DB;
999
1000{
1001 my $path = cf::localdir . "/database.pst";
1002
1003 sub db_load() {
1004 warn "loading database $path\n";#d# remove later
1005 $DB = stat $path ? Storable::retrieve $path : { };
1006 } 2616 {
2617 my $faces = $facedata->{faceinfo};
1007 2618
1008 my $pid; 2619 while (my ($face, $info) = each %$faces) {
1009 2620 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1010 sub db_save() { 2621 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1011 warn "saving database $path\n";#d# remove later 2622 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1012 waitpid $pid, 0 if $pid; 2623 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1013 if (0 == ($pid = fork)) { 2624 Coro::cede;
1014 $DB->{_meta}{version} = 1;
1015 Storable::nstore $DB, "$path~";
1016 rename "$path~", $path;
1017 cf::_exit 0 if defined $pid;
1018 }
1019 }
1020
1021 my $dirty;
1022
1023 sub db_sync() {
1024 db_save if $dirty;
1025 undef $dirty;
1026 }
1027
1028 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1029 db_sync;
1030 });
1031
1032 sub db_dirty() {
1033 $dirty = 1;
1034 $idle->start;
1035 }
1036
1037 sub db_get($;$) {
1038 @_ >= 2
1039 ? $DB->{$_[0]}{$_[1]}
1040 : ($DB->{$_[0]} ||= { })
1041 }
1042
1043 sub db_put($$;$) {
1044 if (@_ >= 3) {
1045 $DB->{$_[0]}{$_[1]} = $_[2];
1046 } else {
1047 $DB->{$_[0]} = $_[1];
1048 }
1049 db_dirty;
1050 }
1051
1052 attach_global
1053 prio => 10000,
1054 on_cleanup => sub {
1055 db_sync;
1056 }, 2625 }
2626
2627 while (my ($face, $info) = each %$faces) {
2628 next unless $info->{smooth};
2629 my $idx = cf::face::find $face
2630 or next;
2631 if (my $smooth = cf::face::find $info->{smooth}) {
2632 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2633 } else {
2634 warn "smooth face '$info->{smooth}' not found for face '$face'";
2635 }
2636 Coro::cede;
2637 }
1057 ; 2638 }
1058}
1059 2639
1060############################################################################# 2640 {
1061# the server's main() 2641 my $anims = $facedata->{animinfo};
2642
2643 while (my ($anim, $info) = each %$anims) {
2644 cf::anim::set $anim, $info->{frames}, $info->{facings};
2645 Coro::cede;
2646 }
2647
2648 cf::anim::invalidate_all; # d'oh
2649 }
2650
2651 1
2652}
2653
2654sub reload_regions {
2655 load_resource_file "$MAPDIR/regions"
2656 or die "unable to load regions file\n";
2657}
2658
2659sub reload_facedata {
2660 load_facedata "$DATADIR/facedata"
2661 or die "unable to load facedata\n";
2662}
2663
2664sub reload_archetypes {
2665 load_resource_file "$DATADIR/archetypes"
2666 or die "unable to load archetypes\n";
2667}
2668
2669sub reload_treasures {
2670 load_resource_file "$DATADIR/treasures"
2671 or die "unable to load treasurelists\n";
2672}
2673
2674sub reload_resources {
2675 warn "reloading resource files...\n";
2676
2677 reload_regions;
2678 reload_facedata;
2679 #reload_archetypes;#d#
2680 reload_archetypes;
2681 reload_treasures;
2682
2683 warn "finished reloading resource files\n";
2684}
2685
2686sub init {
2687 reload_resources;
2688}
1062 2689
1063sub cfg_load { 2690sub cfg_load {
1064 open my $fh, "<:utf8", cf::confdir . "/config" 2691 open my $fh, "<:utf8", "$CONFDIR/config"
1065 or return; 2692 or return;
1066 2693
1067 local $/; 2694 local $/;
1068 *CFG = YAML::Syck::Load <$fh>; 2695 *CFG = YAML::Syck::Load <$fh>;
2696
2697 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2698
2699 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2700 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2701
2702 if (exists $CFG{mlockall}) {
2703 eval {
2704 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2705 and die "WARNING: m(un)lockall failed: $!\n";
2706 };
2707 warn $@ if $@;
2708 }
1069} 2709}
1070 2710
1071sub main { 2711sub main {
2712 # we must not ever block the main coroutine
2713 local $Coro::idle = sub {
2714 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2715 (async {
2716 Event::one_event;
2717 })->prio (Coro::PRIO_MAX);
2718 };
2719
1072 cfg_load; 2720 cfg_load;
1073 db_load; 2721 db_init;
1074 load_extensions; 2722 load_extensions;
2723
2724 $TICK_WATCHER->start;
1075 Event::loop; 2725 Event::loop;
1076} 2726}
1077 2727
1078############################################################################# 2728#############################################################################
1079# initialisation 2729# initialisation and cleanup
1080 2730
1081sub _perl_reload(&) { 2731# install some emergency cleanup handlers
2732BEGIN {
2733 for my $signal (qw(INT HUP TERM)) {
2734 Event->signal (
2735 reentrant => 0,
2736 data => WF_AUTOCANCEL,
2737 signal => $signal,
2738 prio => 0,
2739 cb => sub {
2740 cf::cleanup "SIG$signal";
2741 },
2742 );
2743 }
2744}
2745
2746sub write_runtime {
2747 my $runtime = "$LOCALDIR/runtime";
2748
2749 # first touch the runtime file to show we are still running:
2750 # the fsync below can take a very very long time.
2751
2752 IO::AIO::aio_utime $runtime, undef, undef;
2753
2754 my $guard = cf::lock_acquire "write_runtime";
2755
2756 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2757 or return;
2758
2759 my $value = $cf::RUNTIME + 90 + 10;
2760 # 10 is the runtime save interval, for a monotonic clock
2761 # 60 allows for the watchdog to kill the server.
2762
2763 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2764 and return;
2765
2766 # always fsync - this file is important
2767 aio_fsync $fh
2768 and return;
2769
2770 # touch it again to show we are up-to-date
2771 aio_utime $fh, undef, undef;
2772
2773 close $fh
2774 or return;
2775
2776 aio_rename "$runtime~", $runtime
2777 and return;
2778
2779 warn "runtime file written.\n";
2780
2781 1
2782}
2783
2784sub emergency_save() {
2785 my $freeze_guard = cf::freeze_mainloop;
2786
2787 warn "enter emergency perl save\n";
2788
2789 cf::sync_job {
2790 # use a peculiar iteration method to avoid tripping on perl
2791 # refcount bugs in for. also avoids problems with players
2792 # and maps saved/destroyed asynchronously.
2793 warn "begin emergency player save\n";
2794 for my $login (keys %cf::PLAYER) {
2795 my $pl = $cf::PLAYER{$login} or next;
2796 $pl->valid or next;
2797 $pl->save;
2798 }
2799 warn "end emergency player save\n";
2800
2801 warn "begin emergency map save\n";
2802 for my $path (keys %cf::MAP) {
2803 my $map = $cf::MAP{$path} or next;
2804 $map->valid or next;
2805 $map->save;
2806 }
2807 warn "end emergency map save\n";
2808
2809 warn "begin emergency database checkpoint\n";
2810 BDB::db_env_txn_checkpoint $DB_ENV;
2811 warn "end emergency database checkpoint\n";
2812 };
2813
2814 warn "leave emergency perl save\n";
2815}
2816
2817sub post_cleanup {
1082 my ($msg) = @_; 2818 my ($make_core) = @_;
1083 2819
1084 $msg->("reloading..."); 2820 warn Carp::longmess "post_cleanup backtrace"
2821 if $make_core;
2822}
1085 2823
1086 eval { 2824sub do_reload_perl() {
1087 # cancel all watchers 2825 # can/must only be called in main
2826 if ($Coro::current != $Coro::main) {
2827 warn "can only reload from main coroutine";
2828 return;
2829 }
2830
2831 warn "reloading...";
2832
2833 warn "entering sync_job";
2834
2835 cf::sync_job {
2836 cf::write_runtime; # external watchdog should not bark
2837 cf::emergency_save;
2838 cf::write_runtime; # external watchdog should not bark
2839
2840 warn "syncing database to disk";
2841 BDB::db_env_txn_checkpoint $DB_ENV;
2842
2843 # if anything goes wrong in here, we should simply crash as we already saved
2844
2845 warn "cancelling all WF_AUTOCANCEL watchers";
1088 $_->cancel for Event::all_watchers; 2846 for (Event::all_watchers) {
2847 $_->cancel if $_->data & WF_AUTOCANCEL;
2848 }
1089 2849
1090 # unload all extensions 2850 warn "flushing outstanding aio requests";
1091 for (@exts) { 2851 for (;;) {
1092 $msg->("unloading <$_>"); 2852 BDB::flush;
1093 unload_extension $_; 2853 IO::AIO::flush;
2854 Coro::cede;
2855 last unless IO::AIO::nreqs || BDB::nreqs;
2856 warn "iterate...";
2857 }
2858
2859 ++$RELOAD;
2860
2861 warn "cancelling all extension coros";
2862 $_->cancel for values %EXT_CORO;
2863 %EXT_CORO = ();
2864
2865 warn "removing commands";
2866 %COMMAND = ();
2867
2868 warn "removing ext commands";
2869 %EXTCMD = ();
2870
2871 warn "unloading/nuking all extensions";
2872 for my $pkg (@EXTS) {
2873 warn "... unloading $pkg";
2874
2875 if (my $cb = $pkg->can ("unload")) {
2876 eval {
2877 $cb->($pkg);
2878 1
2879 } or warn "$pkg unloaded, but with errors: $@";
1094 } 2880 }
1095 2881
2882 warn "... nuking $pkg";
2883 Symbol::delete_package $pkg;
2884 }
2885
1096 # unload all modules loaded from $LIBDIR 2886 warn "unloading all perl modules loaded from $LIBDIR";
1097 while (my ($k, $v) = each %INC) { 2887 while (my ($k, $v) = each %INC) {
1098 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2888 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1099 2889
1100 $msg->("removing <$k>"); 2890 warn "... unloading $k";
1101 delete $INC{$k}; 2891 delete $INC{$k};
1102 2892
1103 $k =~ s/\.pm$//; 2893 $k =~ s/\.pm$//;
1104 $k =~ s/\//::/g; 2894 $k =~ s/\//::/g;
1105 2895
1108 } 2898 }
1109 2899
1110 Symbol::delete_package $k; 2900 Symbol::delete_package $k;
1111 } 2901 }
1112 2902
1113 # sync database to disk
1114 cf::db_sync;
1115
1116 # get rid of safe::, as good as possible 2903 warn "getting rid of safe::, as good as possible";
1117 Symbol::delete_package "safe::$_" 2904 Symbol::delete_package "safe::$_"
1118 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2905 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1119 2906
1120 # remove register_script_function callbacks
1121 # TODO
1122
1123 # unload cf.pm "a bit" 2907 warn "unloading cf.pm \"a bit\"";
1124 delete $INC{"cf.pm"}; 2908 delete $INC{"cf.pm"};
2909 delete $INC{"cf/pod.pm"};
1125 2910
1126 # don't, removes xs symbols, too, 2911 # don't, removes xs symbols, too,
1127 # and global variables created in xs 2912 # and global variables created in xs
1128 #Symbol::delete_package __PACKAGE__; 2913 #Symbol::delete_package __PACKAGE__;
1129 2914
1130 # reload cf.pm 2915 warn "unload completed, starting to reload now";
2916
1131 $msg->("reloading cf.pm"); 2917 warn "reloading cf.pm";
1132 require cf; 2918 require cf;
2919 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1133 2920
1134 # load config and database again 2921 warn "loading config and database again";
1135 cf::cfg_load; 2922 cf::cfg_load;
1136 cf::db_load;
1137 2923
1138 # load extensions 2924 warn "loading extensions";
1139 $msg->("load extensions");
1140 cf::load_extensions; 2925 cf::load_extensions;
1141 2926
1142 # reattach attachments to objects 2927 warn "reattaching attachments to objects/players";
1143 $msg->("reattach"); 2928 _global_reattach; # objects, sockets
1144 _global_reattach; 2929 warn "reattaching attachments to maps";
2930 reattach $_ for values %MAP;
2931 warn "reattaching attachments to players";
2932 reattach $_ for values %PLAYER;
2933
2934 warn "leaving sync_job";
2935
2936 1
2937 } or do {
2938 warn $@;
2939 warn "error while reloading, exiting.";
2940 exit 1;
1145 }; 2941 };
1146 $msg->($@) if $@;
1147 2942
1148 $msg->("reloaded"); 2943 warn "reloaded";
1149}; 2944};
1150 2945
1151sub perl_reload() { 2946our $RELOAD_WATCHER; # used only during reload
1152 _perl_reload { 2947
1153 warn $_[0]; 2948sub reload_perl() {
1154 print "$_[0]\n"; 2949 # doing reload synchronously and two reloads happen back-to-back,
2950 # coro crashes during coro_state_free->destroy here.
2951
2952 $RELOAD_WATCHER ||= Event->timer (
2953 reentrant => 0,
2954 after => 0,
2955 data => WF_AUTOCANCEL,
2956 cb => sub {
2957 do_reload_perl;
2958 undef $RELOAD_WATCHER;
2959 },
1155 }; 2960 );
1156} 2961}
1157 2962
1158register "<global>", __PACKAGE__;
1159
1160register_command "perl-reload" => sub { 2963register_command "reload" => sub {
1161 my ($who, $arg) = @_; 2964 my ($who, $arg) = @_;
1162 2965
1163 if ($who->flag (FLAG_WIZ)) { 2966 if ($who->flag (FLAG_WIZ)) {
1164 _perl_reload { 2967 $who->message ("reloading server.");
1165 warn $_[0]; 2968 async { reload_perl };
1166 $who->message ($_[0]); 2969 }
2970};
2971
2972unshift @INC, $LIBDIR;
2973
2974my $bug_warning = 0;
2975
2976our @WAIT_FOR_TICK;
2977our @WAIT_FOR_TICK_BEGIN;
2978
2979sub wait_for_tick {
2980 return unless $TICK_WATCHER->is_active;
2981 return if $Coro::current == $Coro::main;
2982
2983 my $signal = new Coro::Signal;
2984 push @WAIT_FOR_TICK, $signal;
2985 $signal->wait;
2986}
2987
2988sub wait_for_tick_begin {
2989 return unless $TICK_WATCHER->is_active;
2990 return if $Coro::current == $Coro::main;
2991
2992 my $signal = new Coro::Signal;
2993 push @WAIT_FOR_TICK_BEGIN, $signal;
2994 $signal->wait;
2995}
2996
2997 my $min = 1e6;#d#
2998 my $avg = 10;
2999$TICK_WATCHER = Event->timer (
3000 reentrant => 0,
3001 parked => 1,
3002 prio => 0,
3003 at => $NEXT_TICK || $TICK,
3004 data => WF_AUTOCANCEL,
3005 cb => sub {
3006 if ($Coro::current != $Coro::main) {
3007 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3008 unless ++$bug_warning > 10;
3009 return;
3010 }
3011
3012 $NOW = $tick_start = Event::time;
3013
3014 cf::server_tick; # one server iteration
3015
3016 0 && sync_job {#d#
3017 for(1..10) {
3018 my $t = Event::time;
3019 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3020 or die;
3021
3022 $map->width (50);
3023 $map->height (50);
3024 $map->alloc;
3025 $map->_load_objects ("/tmp/x.map", 1);
3026 my $t = Event::time - $t;
3027
3028 #next unless $t < 0.0013;#d#
3029 if ($t < $min) {
3030 $min = $t;
3031 }
3032 $avg = $avg * 0.99 + $t * 0.01;
3033 }
3034 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3035 exit 0;
3036 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1167 }; 3037 };
1168 }
1169};
1170 3038
1171unshift @INC, $LIBDIR; 3039 $RUNTIME += $TICK;
1172
1173$TICK_WATCHER = Event->timer (
1174 prio => 1,
1175 async => 1,
1176 at => $NEXT_TICK || 1,
1177 cb => sub {
1178 cf::server_tick; # one server iteration
1179
1180 my $NOW = Event::time;
1181 $NEXT_TICK += $TICK; 3040 $NEXT_TICK += $TICK;
3041
3042 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3043 $NEXT_RUNTIME_WRITE = $NOW + 10;
3044 Coro::async_pool {
3045 write_runtime
3046 or warn "ERROR: unable to write runtime file: $!";
3047 };
3048 }
3049
3050# my $AFTER = Event::time;
3051# warn $AFTER - $NOW;#d#
3052
3053 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3054 $sig->send;
3055 }
3056 while (my $sig = shift @WAIT_FOR_TICK) {
3057 $sig->send;
3058 }
3059
3060 $NOW = Event::time;
1182 3061
1183 # if we are delayed by four ticks or more, skip them all 3062 # if we are delayed by four ticks or more, skip them all
1184 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 3063 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1185 3064
1186 $TICK_WATCHER->at ($NEXT_TICK); 3065 $TICK_WATCHER->at ($NEXT_TICK);
1187 $TICK_WATCHER->start; 3066 $TICK_WATCHER->start;
3067
3068 $LOAD = ($NOW - $tick_start) / $TICK;
3069 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3070
3071 _post_tick;
3072
3073
1188 }, 3074 },
1189); 3075);
1190 3076
3077{
3078 BDB::max_poll_time $TICK * 0.1;
3079 $BDB_POLL_WATCHER = Event->io (
3080 reentrant => 0,
3081 fd => BDB::poll_fileno,
3082 poll => 'r',
3083 prio => 0,
3084 data => WF_AUTOCANCEL,
3085 cb => \&BDB::poll_cb,
3086 );
3087 BDB::min_parallel 8;
3088
3089 BDB::set_sync_prepare {
3090 my $status;
3091 my $current = $Coro::current;
3092 (
3093 sub {
3094 $status = $!;
3095 $current->ready; undef $current;
3096 },
3097 sub {
3098 Coro::schedule while defined $current;
3099 $! = $status;
3100 },
3101 )
3102 };
3103
3104 unless ($DB_ENV) {
3105 $DB_ENV = BDB::db_env_create;
3106
3107 cf::sync_job {
3108 eval {
3109 BDB::db_env_open
3110 $DB_ENV,
3111 $BDBDIR,
3112 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3113 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3114 0666;
3115
3116 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3117
3118 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3119 $DB_ENV->set_lk_detect;
3120 };
3121
3122 cf::cleanup "db_env_open(db): $@" if $@;
3123 };
3124 }
3125}
3126
3127{
3128 IO::AIO::min_parallel 8;
3129
3130 undef $Coro::AIO::WATCHER;
1191IO::AIO::max_poll_time $TICK * 0.2; 3131 IO::AIO::max_poll_time $TICK * 0.1;
1192 3132 $AIO_POLL_WATCHER = Event->io (
1193Event->io (fd => IO::AIO::poll_fileno, 3133 reentrant => 0,
3134 data => WF_AUTOCANCEL,
3135 fd => IO::AIO::poll_fileno,
1194 poll => 'r', 3136 poll => 'r',
1195 prio => 5, 3137 prio => 6,
1196 cb => \&IO::AIO::poll_cb); 3138 cb => \&IO::AIO::poll_cb,
3139 );
3140}
3141
3142my $_log_backtrace;
3143
3144sub _log_backtrace {
3145 my ($msg, @addr) = @_;
3146
3147 $msg =~ s/\n//;
3148
3149 # limit the # of concurrent backtraces
3150 if ($_log_backtrace < 2) {
3151 ++$_log_backtrace;
3152 async {
3153 my @bt = fork_call {
3154 @addr = map { sprintf "%x", $_ } @addr;
3155 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3156 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3157 or die "addr2line: $!";
3158
3159 my @funcs;
3160 my @res = <$fh>;
3161 chomp for @res;
3162 while (@res) {
3163 my ($func, $line) = splice @res, 0, 2, ();
3164 push @funcs, "[$func] $line";
3165 }
3166
3167 @funcs
3168 };
3169
3170 LOG llevInfo, "[ABT] $msg\n";
3171 LOG llevInfo, "[ABT] $_\n" for @bt;
3172 --$_log_backtrace;
3173 };
3174 } else {
3175 LOG llevInfo, "[ABT] $msg\n";
3176 LOG llevInfo, "[ABT] [suppressed]\n";
3177 }
3178}
3179
3180# load additional modules
3181use cf::pod;
3182
3183END { cf::emergency_save }
1197 3184
11981 31851
1199 3186

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines