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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines