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.107 by root, Sun Dec 31 18:10:40 2006 UTC vs.
Revision 1.346 by root, Tue Aug 28 19:38:40 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines