ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines