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.217 by root, Thu Feb 15 21:07:49 2007 UTC vs.
Revision 1.311 by root, Fri Jul 20 16:11:10 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.5 (); 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 ();
20use BDB (); 26use BDB ();
21use Data::Dumper; 27use Data::Dumper;
22use Digest::MD5; 28use Digest::MD5;
23use Fcntl; 29use Fcntl;
30use YAML::Syck ();
24use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 32use Time::HiRes;
27use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
28 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
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 41
31use 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
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 43
35# 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?
36$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
37 46
38$Coro::main->prio (Coro::PRIO_MAX); # 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
39 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
40our %COMMAND = (); 51our %COMMAND = ();
41our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
42 53
43our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
47 59
60our $RELOAD; # number of reloads so far
48our @EVENT; 61our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 62
51our $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(!)
52our $TICK_WATCHER; 76our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
54our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 79our $NEXT_TICK;
56our $NOW; 80our $NOW;
65our $RUNTIME; 89our $RUNTIME;
66 90
67our %PLAYER; # all users 91our %PLAYER; # all users
68our %MAP; # all maps 92our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 94
76# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 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
101
79binmode STDOUT; 102binmode STDOUT;
80binmode STDERR; 103binmode STDERR;
81 104
82# read virtual server time, if available 105# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
87} 110}
88 111
89mkdir cf::localdir; 112mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 114
96our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
97 116
98sub cf::map::normalise; 117sub cf::map::normalise;
99 118
110=item $cf::RUNTIME 129=item $cf::RUNTIME
111 130
112The 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
113every server tick. 132every server tick.
114 133
115=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
116 137
117The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
118be 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.
119 142
120=item $cf::NOW 143=item $cf::NOW
121 144
122The time of the last (current) server tick. 145The time of the last (current) server tick.
123 146
124=item $cf::TICK 147=item $cf::TICK
125 148
126The 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.
127 160
128=item %cf::CFG 161=item %cf::CFG
129 162
130Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 164from wherever your confdir points to.
132 165
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
134 167
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 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.
139 177
140=back 178=back
141 179
142=cut 180=cut
143 181
144BEGIN { 182BEGIN {
145 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 184 my $msg = join "", @_;
147 utf8::encode $msg;
148 185
149 $msg .= "\n" 186 $msg .= "\n"
150 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
151 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
152 LOG llevError, $msg; 192 LOG llevError, $msg;
153 }; 193 };
154} 194}
155 195
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@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';
161@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)
162 203
163# 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
164# within the Safe compartment. 205# within the Safe compartment.
165for my $pkg (qw( 206for my $pkg (qw(
166 cf::global cf::attachable 207 cf::global cf::attachable
174} 215}
175 216
176$Event::DIED = sub { 217$Event::DIED = sub {
177 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
178}; 219};
220
221#############################################################################
179 222
180=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
181 224
182=over 4 225=over 4
183 226
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 246 $d
204 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
205} 248}
206 249
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
210 251
211Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
212 253
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
221 255
222Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
223 257
224=cut 258=cut
225 259
226sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
228 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
229} 263sub from_json ($) { $json_coder->decode ($_[0]) }
230 264
231=item cf::lock_wait $string 265=item cf::lock_wait $string
232 266
233Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
234 268
240returned. 274returned.
241 275
242Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
244 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
245=cut 283=cut
246 284
247our %LOCK; 285our %LOCK;
248 286
249sub lock_wait($) { 287sub lock_wait($) {
266 304
267 Coro::guard { 305 Coro::guard {
268 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
270 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
271} 315}
272 316
273sub freeze_mainloop { 317sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
275 319
290 334
291BEGIN { *async = \&Coro::async_pool } 335BEGIN { *async = \&Coro::async_pool }
292 336
293=item cf::sync_job { BLOCK } 337=item cf::sync_job { BLOCK }
294 338
295The design of crossfire+ requires that the main coro ($Coro::main) is 339The design of Crossfire TRT requires that the main coroutine ($Coro::main)
296always able to handle events or runnable, as crossfire+ is only partly 340is always able to handle events or runnable, as Crossfire TRT is only
297reentrant. 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.
298 343
299If 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
300the given BLOCK in another coroutine while waiting for the result. The 345the given BLOCK in another coroutine while waiting for the result. The
301server 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
302fast or be very important. 347fast or be very important.
305 350
306sub sync_job(&) { 351sub sync_job(&) {
307 my ($job) = @_; 352 my ($job) = @_;
308 353
309 if ($Coro::current == $Coro::main) { 354 if ($Coro::current == $Coro::main) {
355 my $time = Event::time;
356
310 # this is the main coro, too bad, we have to block 357 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/ 358 # till the operation succeeds, freezing the server :/
312 359
313 # TODO: use suspend/resume instead 360 # TODO: use suspend/resume instead
314 # (but this is cancel-safe) 361 # (but this is cancel-safe)
325 372
326 while ($busy) { 373 while ($busy) {
327 Coro::cede or Event::one_event; 374 Coro::cede or Event::one_event;
328 } 375 }
329 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
330 wantarray ? @res : $res[0] 384 wantarray ? @res : $res[0]
331 } else { 385 } else {
332 # we are in another coroutine, how wonderful, everything just works 386 # we are in another coroutine, how wonderful, everything just works
333 387
334 $job->() 388 $job->()
353 $EXT_CORO{$coro+0} = $coro; 407 $EXT_CORO{$coro+0} = $coro;
354 408
355 $coro 409 $coro
356} 410}
357 411
358sub write_runtime { 412=item fork_call { }, $args
359 my $runtime = cf::localdir . "/runtime";
360 413
361 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 414Executes the given code block with the given arguments in a seperate
362 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.
363 418
364 my $value = $cf::RUNTIME + 90 + 10; 419=cut
365 # 10 is the runtime save interval, for a monotonic clock
366 # 60 allows for the watchdog to kill the server.
367 420
368 (aio_write $fh, 0, (length $value), $value, 0) <= 0 421sub _store_scalar {
369 and return; 422 open my $fh, ">", \my $buf
370 423 or die "fork_call: cannot open fh-to-buf in child : $!";
371 # always fsync - this file is important 424 Storable::store_fd $_[0], $fh;
372 aio_fsync $fh
373 and return;
374
375 close $fh 425 close $fh;
376 or return;
377 426
378 aio_rename "$runtime~", $runtime 427 $buf
379 and return; 428}
380 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;
381 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 });
382} 599}
383 600
384=back 601=back
385 602
386=cut 603=cut
393attach callbacks/event handlers (a collection of which is called an "attachment") 610attach callbacks/event handlers (a collection of which is called an "attachment")
394to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
395 612
396In 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>
397C<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
398crossfire+). 615Crossfire TRT).
399 616
400=over 4 617=over 4
401 618
402=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
403 620
566 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
567 784
568 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
569 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
570 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
571 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
572 789
573 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
574 my $pkg = shift @arg; 791 my $pkg = shift @arg;
575 792
576 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
605 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
606 } 823 }
607 824
608 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
609 } else { 826 } else {
610 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
611 } 828 }
612 829
613 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
614} 831}
615 832
617 if (ref $_[0]) { 834 if (ref $_[0]) {
618 _object_attach @_; 835 _object_attach @_;
619 } else { 836 } else {
620 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
621 } 838 }
839 _recalc_want;
622}; 840};
623 841
624# all those should be optimised 842# all those should be optimised
625sub cf::attachable::detach { 843sub cf::attachable::detach {
626 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
629 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
630 reattach ($obj); 848 reattach ($obj);
631 } else { 849 } else {
632 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
633 } 851 }
852 _recalc_want;
634}; 853};
635 854
636sub cf::attachable::attached { 855sub cf::attachable::attached {
637 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
638 857
653 "; 872 ";
654 die if $@; 873 die if $@;
655} 874}
656 875
657our $override; 876our $override;
658our @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?
659 878
660sub override { 879sub override {
661 $override = 1; 880 $override = 1;
662 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
663} 882}
664 883
665sub do_invoke { 884sub do_invoke {
666 my $event = shift; 885 my $event = shift;
667 my $callbacks = shift; 886 my $callbacks = shift;
668 887
669 @invoke_results = (); 888 @INVOKE_RESULTS = ();
670 889
671 local $override; 890 local $override;
672 891
673 for (@$callbacks) { 892 for (@$callbacks) {
674 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
691 910
692Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
693 912
694This 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
695removed 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
696results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
697 916
698=back 917=back
699 918
700=cut 919=cut
701 920
811 or return; 1030 or return;
812 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
813 } 1032 }
814 1033
815 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
816 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
817 return ($data, $av); 1036 return ($data, $av);
818} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
819 1044
820############################################################################# 1045#############################################################################
821# command handling &c 1046# command handling &c
822 1047
823=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
836 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
837} 1062}
838 1063
839=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
840 1065
841Register a callbackf ro execution when the client sends an extcmd packet. 1066Register a callback for execution when the client sends an (synchronous)
1067extcmd packet. Ext commands will be processed in the order they are
1068received by the server, like other user commands. The first argument is
1069the logged-in player. Ext commands can only be processed after a player
1070has logged in successfully.
842 1071
843If the callback returns something, it is sent back as if reply was being 1072If the callback returns something, it is sent back as if reply was being
844called. 1073called.
845 1074
1075=item cf::register_exticmd $name => \&callback($ns,$packet);
1076
1077Register a callback for execution when the client sends an (asynchronous)
1078exticmd packet. Exti commands are processed by the server as soon as they
1079are received, i.e. out of order w.r.t. other commands. The first argument
1080is a client socket. Exti commands can be received anytime, even before
1081log-in.
1082
1083If the callback returns something, it is sent back as if reply was being
1084called.
1085
846=cut 1086=cut
847 1087
848sub register_extcmd { 1088sub register_extcmd {
849 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
850 1090
851 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
852} 1098}
853 1099
854cf::player->attach ( 1100cf::player->attach (
855 on_command => sub { 1101 on_command => sub {
856 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
865 cf::override; 1111 cf::override;
866 }, 1112 },
867 on_extcmd => sub { 1113 on_extcmd => sub {
868 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
869 1115
870 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871 1117
872 if (ref $msg) { 1118 if (ref $msg) {
873 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
874 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
875 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
881 1127
882 cf::override; 1128 cf::override;
883 }, 1129 },
884); 1130);
885 1131
886sub load_extension {
887 my ($path) = @_;
888
889 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
890 my $base = $1;
891 my $pkg = $1;
892 $pkg =~ s/[^[:word:]]/_/g;
893 $pkg = "ext::$pkg";
894
895 warn "... loading '$path' into '$pkg'\n";
896
897 open my $fh, "<:utf8", $path
898 or die "$path: $!";
899
900 my $source =
901 "package $pkg; use strict; use utf8;\n"
902 . "#line 1 \"$path\"\n{\n"
903 . (do { local $/; <$fh> })
904 . "\n};\n1";
905
906 unless (eval $source) {
907 my $msg = $@ ? "$path: $@\n"
908 : "extension disabled.\n";
909 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910 warn $@;
911 warn "mandatory extension failed to load, exiting.\n";
912 exit 1;
913 }
914 die $@;
915 }
916
917 push @EXTS, $pkg;
918}
919
920sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
921 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
922 next unless -r $ext; 1137 next unless -r $path;
923 eval { 1138
924 load_extension $ext; 1139 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1140 my $base = $1;
1141 my $pkg = $1;
1142 $pkg =~ s/[^[:word:]]/_/g;
1143 $pkg = "ext::$pkg";
1144
1145 open my $fh, "<:utf8", $path
1146 or die "$path: $!";
1147
1148 my $source = do { local $/; <$fh> };
1149
1150 my %ext = (
1151 path => $path,
1152 base => $base,
1153 pkg => $pkg,
1154 );
1155
1156 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1157 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1158
1159 $ext{source} =
1160 "package $pkg; use strict; use utf8;\n"
1161 . "#line 1 \"$path\"\n{\n"
1162 . $source
1163 . "\n};\n1";
1164
1165 $todo{$base} = \%ext;
1166 }
1167
1168 my %done;
1169 while (%todo) {
1170 my $progress;
1171
1172 while (my ($k, $v) = each %todo) {
1173 for (split /,\s*/, $v->{meta}{depends}) {
1174 goto skip
1175 unless exists $done{$_};
1176 }
1177
1178 warn "... loading '$k' into '$v->{pkg}'\n";
1179
1180 unless (eval $v->{source}) {
1181 my $msg = $@ ? "$v->{path}: $@\n"
1182 : "$v->{base}: extension inactive.\n";
1183
1184 if (exists $v->{meta}{mandatory}) {
1185 warn $msg;
1186 warn "mandatory extension failed to load, exiting.\n";
1187 exit 1;
1188 }
1189
1190 warn $msg;
1191 }
1192
1193 $done{$k} = delete $todo{$k};
1194 push @EXTS, $v->{pkg};
1195 $progress = 1;
925 1 1196 }
926 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
927 } 1202 };
928} 1203}
929 1204
930############################################################################# 1205#############################################################################
931 1206
1207=back
1208
932=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
933 1210
934Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
935 1212
936=cut 1213=cut
948Returns the given player object, loading it if necessary (might block). 1225Returns the given player object, loading it if necessary (might block).
949 1226
950=cut 1227=cut
951 1228
952sub playerdir($) { 1229sub playerdir($) {
953 cf::localdir 1230 "$PLAYERDIR/"
954 . "/"
955 . cf::playerdir
956 . "/"
957 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1231 . (ref $_[0] ? $_[0]->ob->name : $_[0])
958} 1232}
959 1233
960sub path($) { 1234sub path($) {
961 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1235 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962 1236
963 (playerdir $login) . "/$login.pl" 1237 (playerdir $login) . "/playerdata"
964} 1238}
965 1239
966sub find_active($) { 1240sub find_active($) {
967 $cf::PLAYER{$_[0]} 1241 $cf::PLAYER{$_[0]}
968 and $cf::PLAYER{$_[0]}->active 1242 and $cf::PLAYER{$_[0]}->active
981 my $login = $_[0]; 1255 my $login = $_[0];
982 1256
983 my $guard = cf::lock_acquire "user_find:$login"; 1257 my $guard = cf::lock_acquire "user_find:$login";
984 1258
985 $cf::PLAYER{$_[0]} || do { 1259 $cf::PLAYER{$_[0]} || do {
1260 # rename old playerfiles to new ones
1261 #TODO: remove when no longer required
1262 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1263 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1264 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1265 aio_unlink +(playerdir $login) . "/$login.pl";
1266
986 my $pl = load_pl path $login 1267 my $pl = load_pl path $login
987 or return; 1268 or return;
988 $cf::PLAYER{$login} = $pl 1269 $cf::PLAYER{$login} = $pl
989 } 1270 }
990 } 1271 }
1027 1308
1028=cut 1309=cut
1029 1310
1030sub quit_character { 1311sub quit_character {
1031 my ($pl) = @_; 1312 my ($pl) = @_;
1313
1314 my $name = $pl->ob->name;
1032 1315
1033 $pl->{deny_save} = 1; 1316 $pl->{deny_save} = 1;
1034 $pl->password ("*"); # this should lock out the player until we nuked the dir 1317 $pl->password ("*"); # this should lock out the player until we nuked the dir
1035 1318
1036 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1319 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041 my $path = playerdir $pl; 1324 my $path = playerdir $pl;
1042 my $temp = "$path~$cf::RUNTIME~deleting~"; 1325 my $temp = "$path~$cf::RUNTIME~deleting~";
1043 aio_rename $path, $temp; 1326 aio_rename $path, $temp;
1044 delete $cf::PLAYER{$pl->ob->name}; 1327 delete $cf::PLAYER{$pl->ob->name};
1045 $pl->destroy; 1328 $pl->destroy;
1329
1330 my $prefix = qr<^~\Q$name\E/>;
1331
1332 # nuke player maps
1333 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1334
1046 IO::AIO::aio_rmtree $temp; 1335 IO::AIO::aio_rmtree $temp;
1336}
1337
1338=item $pl->kick
1339
1340Kicks a player out of the game. This destroys the connection.
1341
1342=cut
1343
1344sub kick {
1345 my ($pl, $kicker) = @_;
1346
1347 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1348 $pl->killer ("kicked");
1349 $pl->ns->destroy;
1047} 1350}
1048 1351
1049=item cf::player::list_logins 1352=item cf::player::list_logins
1050 1353
1051Returns am arrayref of all valid playernames in the system, can take a 1354Returns am arrayref of all valid playernames in the system, can take a
1052while and may block, so not sync_job-capable, ever. 1355while and may block, so not sync_job-capable, ever.
1053 1356
1054=cut 1357=cut
1055 1358
1056sub list_logins { 1359sub list_logins {
1057 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1360 my $dirs = aio_readdir $PLAYERDIR
1058 or return []; 1361 or return [];
1059 1362
1060 my @logins; 1363 my @logins;
1061 1364
1062 for my $login (@$dirs) { 1365 for my $login (@$dirs) {
1097 } 1400 }
1098 1401
1099 \@paths 1402 \@paths
1100} 1403}
1101 1404
1405=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1406
1407Expand crossfire pod fragments into protocol xml.
1408
1409=cut
1410
1411sub expand_cfpod {
1412 ((my $self), (local $_)) = @_;
1413
1414 # escape & and <
1415 s/&/&amp;/g;
1416 s/(?<![BIUGH])</&lt;/g;
1417
1418 # this is buggy, it needs to properly take care of nested <'s
1419
1420 1 while
1421 # replace B<>, I<>, U<> etc.
1422 s/B<([^\>]*)>/<b>$1<\/b>/
1423 || s/I<([^\>]*)>/<i>$1<\/i>/
1424 || s/U<([^\>]*)>/<u>$1<\/u>/
1425 # replace G<male|female> tags
1426 || s{G<([^>|]*)\|([^>]*)>}{
1427 $self->gender ? $2 : $1
1428 }ge
1429 # replace H<hint text>
1430 || s{H<([^\>]*)>}
1431 {
1432 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1433 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1434 "")
1435 [$self->{hintmode}]
1436 }ge;
1437
1438 # create single paragraphs (very hackish)
1439 s/(?<=\S)\n(?=\w)/ /g;
1440
1441 # compress some whitespace
1442 s/\s+\n/\n/g; # ws line-ends
1443 s/\n\n+/\n/g; # double lines
1444 s/^\n+//; # beginning lines
1445 s/\n+$//; # ending lines
1446
1447 $_
1448}
1449
1450sub hintmode {
1451 $_[0]{hintmode} = $_[1] if @_ > 1;
1452 $_[0]{hintmode}
1453}
1454
1102=item $player->ext_reply ($msgid, $msgtype, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1103 1456
1104Sends an ext reply to the player. 1457Sends an ext reply to the player.
1105 1458
1106=cut 1459=cut
1107 1460
1108sub ext_reply($$$%) { 1461sub ext_reply($$%) {
1109 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1110 1463
1111 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1112 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1113 $self->send ("ext " . cf::to_json \%msg);
1114} 1466}
1115 1467
1116package cf; 1468=item $player->ext_event ($type, %msg)
1469
1470Sends an ext event to the client.
1471
1472=cut
1473
1474sub ext_event($$%) {
1475 my ($self, $type, %msg) = @_;
1476
1477 $self->ns->ext_event ($type, %msg);
1478}
1479
1480=head3 cf::region
1481
1482=over 4
1483
1484=cut
1485
1486package cf::region;
1487
1488=item cf::region::find_by_path $path
1489
1490Tries to decuce the likely region for a map knowing only its path.
1491
1492=cut
1493
1494sub find_by_path($) {
1495 my ($path) = @_;
1496
1497 my ($match, $specificity);
1498
1499 for my $region (list) {
1500 if ($region->{match} && $path =~ $region->{match}) {
1501 ($match, $specificity) = ($region, $region->specificity)
1502 if $region->specificity > $specificity;
1503 }
1504 }
1505
1506 $match
1507}
1117 1508
1118=back 1509=back
1119
1120 1510
1121=head3 cf::map 1511=head3 cf::map
1122 1512
1123=over 4 1513=over 4
1124 1514
1179 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1180 1570
1181 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1182 local $self->{path}; 1572 local $self->{path};
1183 local $self->{load_path}; 1573 local $self->{load_path};
1184 local $self->{deny_save};
1185 local $self->{deny_reset};
1186 1574
1187 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1188} 1576}
1189 1577
1190sub normalise { 1578sub normalise {
1237 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1238 return $self; 1626 return $self;
1239 } 1627 }
1240 } 1628 }
1241 1629
1242 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1243 () 1631 ()
1244} 1632}
1245 1633
1246sub init { 1634sub init {
1247 my ($self) = @_; 1635 my ($self) = @_;
1262 1650
1263# the original (read-only) location 1651# the original (read-only) location
1264sub load_path { 1652sub load_path {
1265 my ($self) = @_; 1653 my ($self) = @_;
1266 1654
1267 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1655 "$MAPDIR/$self->{path}.map"
1268} 1656}
1269 1657
1270# the temporary/swap location 1658# the temporary/swap location
1271sub save_path { 1659sub save_path {
1272 my ($self) = @_; 1660 my ($self) = @_;
1273 1661
1274 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1662 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1663 "$TMPDIR/$path.map"
1276} 1664}
1277 1665
1278# the unique path, undef == no special unique path 1666# the unique path, undef == no special unique path
1279sub uniq_path { 1667sub uniq_path {
1280 my ($self) = @_; 1668 my ($self) = @_;
1281 1669
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1670 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1671 "$UNIQUEDIR/$path"
1284} 1672}
1285 1673
1286# and all this just because we cannot iterate over 1674# and all this just because we cannot iterate over
1287# all maps in C++... 1675# all maps in C++...
1288sub change_all_map_light { 1676sub change_all_map_light {
1289 my ($change) = @_; 1677 my ($change) = @_;
1290 1678
1291 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1292 for grep $_->outdoor, values %cf::MAP; 1680 for grep $_->outdoor, values %cf::MAP;
1681}
1682
1683sub decay_objects {
1684 my ($self) = @_;
1685
1686 return if $self->{deny_reset};
1687
1688 $self->do_decay_objects;
1293} 1689}
1294 1690
1295sub unlink_save { 1691sub unlink_save {
1296 my ($self) = @_; 1692 my ($self) = @_;
1297 1693
1355 $self->load_header_orig 1751 $self->load_header_orig
1356 or return; 1752 or return;
1357 $self->prepare_orig; 1753 $self->prepare_orig;
1358 } 1754 }
1359 1755
1756 $self->{deny_reset} = 1
1757 if $self->no_reset;
1758
1759 $self->default_region (cf::region::find_by_path $self->{path})
1760 unless $self->default_region;
1761
1360 1 1762 1
1361} 1763}
1362 1764
1363sub find; 1765sub find;
1364sub find { 1766sub find {
1376 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1377 1779
1378 $map->load_header 1780 $map->load_header
1379 or return; 1781 or return;
1380 1782
1381 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1382 # doing this can freeze the server in a sync job, obviously 1784 # doing this can freeze the server in a sync job, obviously
1383 #$cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1384 $map->reset; 1786 $map->reset;
1385 undef $guard; 1787 undef $guard;
1386 return find $path; 1788 return find $path;
1397 my ($self) = @_; 1799 my ($self) = @_;
1398 1800
1399 local $self->{deny_reset} = 1; # loading can take a long time 1801 local $self->{deny_reset} = 1; # loading can take a long time
1400 1802
1401 my $path = $self->{path}; 1803 my $path = $self->{path};
1804
1805 {
1402 my $guard = cf::lock_acquire "map_load:$path"; 1806 my $guard = cf::lock_acquire "map_load:$path";
1403 1807
1404 return if $self->in_memory != cf::MAP_SWAPPED; 1808 return if $self->in_memory != cf::MAP_SWAPPED;
1405 1809
1406 $self->in_memory (cf::MAP_LOADING); 1810 $self->in_memory (cf::MAP_LOADING);
1407 1811
1408 $self->alloc; 1812 $self->alloc;
1409 1813
1410 $self->pre_load; 1814 $self->pre_load;
1411
1412 $self->_load_objects ($self->{load_path}, 1)
1413 or return;
1414
1415 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1416 if delete $self->{load_original};
1417
1418 if (my $uniq = $self->uniq_path) {
1419 utf8::encode $uniq;
1420 if (aio_open $uniq, O_RDONLY, 0) {
1421 $self->clear_unique_items;
1422 $self->_load_objects ($uniq, 0);
1423 }
1424 }
1425
1426 Coro::cede;
1427
1428 # now do the right thing for maps
1429 $self->link_multipart_objects;
1430
1431 unless ($self->{deny_activate}) {
1432 $self->decay_objects;
1433 $self->fix_auto_apply;
1434 $self->update_buttons;
1435 Coro::cede; 1815 Coro::cede;
1436 $self->set_darkness_map; 1816
1817 $self->_load_objects ($self->{load_path}, 1)
1818 or return;
1819
1820 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1821 if delete $self->{load_original};
1822
1823 if (my $uniq = $self->uniq_path) {
1824 utf8::encode $uniq;
1825 if (aio_open $uniq, O_RDONLY, 0) {
1826 $self->clear_unique_items;
1827 $self->_load_objects ($uniq, 0);
1828 }
1829 }
1830
1831 Coro::cede;
1832 # now do the right thing for maps
1833 $self->link_multipart_objects;
1437 $self->difficulty ($self->estimate_difficulty) 1834 $self->difficulty ($self->estimate_difficulty)
1438 unless $self->difficulty; 1835 unless $self->difficulty;
1439 Coro::cede; 1836 Coro::cede;
1837
1838 unless ($self->{deny_activate}) {
1839 $self->decay_objects;
1840 $self->fix_auto_apply;
1841 $self->update_buttons;
1842 Coro::cede;
1843 $self->set_darkness_map;
1844 Coro::cede;
1440 $self->activate; 1845 $self->activate;
1846 }
1847
1848 $self->in_memory (cf::MAP_IN_MEMORY);
1441 } 1849 }
1442 1850
1443 $self->post_load; 1851 $self->post_load;
1444
1445 $self->in_memory (cf::MAP_IN_MEMORY);
1446} 1852}
1447 1853
1448sub customise_for { 1854sub customise_for {
1449 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1450 1856
1451 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1452 if $self->per_player; 1858 if $self->per_player;
1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1453 1862
1454 $self 1863 $self
1455} 1864}
1456 1865
1457# find and load all maps in the 3x3 area around a map 1866# find and load all maps in the 3x3 area around a map
1504 1913
1505 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1506 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1507 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1508 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1509 my $map = find $path 1918 if (my $map = find $path) {
1510 or next;
1511 $map->load; 1919 $map->load;
1920 }
1512 1921
1513 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1514 } 1923 }
1515 } 1924 }
1516 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1568 1977
1569sub reset_at { 1978sub reset_at {
1570 my ($self) = @_; 1979 my ($self) = @_;
1571 1980
1572 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1573 return 1e99 if $self->isa ("ext::map_per_player");#d#
1574 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1575 1983
1576 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1577 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1985 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1578 1986
1589 my ($self) = @_; 1997 my ($self) = @_;
1590 1998
1591 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1592 2000
1593 return if $self->players; 2001 return if $self->players;
1594 return if $self->isa ("ext::map_per_player");#d#
1595 2002
1596 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
1597 2004
1598 $self->in_memory (cf::MAP_SWAPPED); 2005 $self->in_memory (cf::MAP_SWAPPED);
1599 2006
1600 # need to save uniques path 2007 # need to save uniques path
1601 unless ($self->{deny_save}) { 2008 unless ($self->{deny_save}) {
1633 $cf::MAP{$self->path} = $self; 2040 $cf::MAP{$self->path} = $self;
1634 2041
1635 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
1636} 2043}
1637 2044
2045=item $maps = cf::map::tmp_maps
2046
2047Returns an arrayref with all map paths of currently instantiated and saved
2048maps. May block.
2049
2050=cut
2051
2052sub tmp_maps() {
2053 [
2054 map {
2055 utf8::decode $_;
2056 /\.map$/
2057 ? normalise $_
2058 : ()
2059 } @{ aio_readdir $TMPDIR or [] }
2060 ]
2061}
2062
2063=item $maps = cf::map::random_maps
2064
2065Returns an arrayref with all map paths of currently instantiated and saved
2066random maps. May block.
2067
2068=cut
2069
2070sub random_maps() {
2071 [
2072 map {
2073 utf8::decode $_;
2074 /\.map$/
2075 ? normalise "?random/$_"
2076 : ()
2077 } @{ aio_readdir $RANDOMDIR or [] }
2078 ]
2079}
2080
1638=item cf::map::unique_maps 2081=item cf::map::unique_maps
1639 2082
1640Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1641instantiated unique items. May block. 2084instantiated unique items. May block.
1642 2085
1643=cut 2086=cut
1644 2087
1645sub unique_maps() { 2088sub unique_maps() {
1646 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2089 [
1647 or return; 2090 map {
1648
1649 my @paths;
1650
1651 for (@$files) {
1652 utf8::decode $_; 2091 utf8::decode $_;
1653 next if /\.pst$/; 2092 /\.map$/
1654 next unless /^$PATH_SEP/o; 2093 ? normalise $_
1655 2094 : ()
1656 push @paths, cf::map::normalise $_; 2095 } @{ aio_readdir $UNIQUEDIR or [] }
1657 } 2096 ]
1658
1659 \@paths
1660} 2097}
1661 2098
1662package cf; 2099package cf;
1663 2100
1664=back 2101=back
1710 2147
1711 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1712 2149
1713 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1714 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1715 } else { 2153 } else {
2154 my $pl = $self->contr;
2155
2156 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2157 my $diag = $pl->{npc_dialog};
2158 $diag->{pl}->ext_reply (
2159 $diag->{id},
2160 msgtype => "reply",
2161 msg => $diag->{pl}->expand_cfpod ($msg),
2162 add_topics => []
2163 );
2164
2165 } else {
1716 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1717 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1718 } 2169 }
1719} 2170}
1720 2171
1721=item $player_object->may ("access") 2172=item $player_object->may ("access")
1722 2173
1770 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1771 2222
1772 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1773 2224
1774 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1775 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1776 2227
1777 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1778} 2229}
1779 2230
1780sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1781 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1782 2235
1783 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1784 2237
1785 unless ($map) { 2238 unless ($map) {
1786 # restore original map position 2239 # restore original map position
1809 2262
1810 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1811 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1812} 2265}
1813 2266
1814cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1815 on_logout => sub {
1816 my ($pl) = @_;
1817 2268
1818 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1819 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1820 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1821 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1822 }; 2273be called at the end of this process.
1823 }
1824 },
1825 on_login => sub {
1826 my ($pl) = @_;
1827 2274
1828 # try to abort aborted map switching on player login :)
1829 # should happen only on crashes
1830 if ($pl->ob->{_link_pos}) {
1831 $pl->ob->enter_link;
1832 (async {
1833 $pl->ob->reply (undef,
1834 "There was an internal problem at your last logout, "
1835 . "the server will try to bring you to your intended destination in a second.",
1836 cf::NDI_RED);
1837 # we need this sleep as the login has a concurrent enter_exit running
1838 # and this sleep increases chances of the player not ending up in scorn
1839 Coro::Timer::sleep 1;
1840 $pl->ob->leave_link;
1841 })->prio (2);
1842 }
1843 },
1844);
1845
1846=item $player_object->goto ($path, $x, $y)
1847
1848=cut 2275=cut
2276
2277our $GOTOGEN;
1849 2278
1850sub cf::object::player::goto { 2279sub cf::object::player::goto {
1851 my ($self, $path, $x, $y) = @_; 2280 my ($self, $path, $x, $y, $check, $done) = @_;
2281
2282 # do generation counting so two concurrent goto's will be executed in-order
2283 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1852 2284
1853 $self->enter_link; 2285 $self->enter_link;
1854 2286
1855 (async { 2287 (async {
1856 my $map = eval { 2288 my $map = eval {
1857 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1858 $map = $map->customise_for ($self) if $map; 2292 $map = $map->customise_for ($self);
2293 $map = $check->($map) if $check && $map;
2294 } else {
2295 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2296 }
2297
1859 $map 2298 $map
2299 };
2300
2301 if ($@) {
2302 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2303 LOG llevError | logBacktrace, Carp::longmess $@;
1860 } or 2304 }
1861 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1862 2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1863 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1864 })->prio (1); 2312 })->prio (1);
1865} 2313}
1866 2314
1867=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1868 2316
1907 2355
1908 $rmp->{random_seed} ||= $exit->random_seed; 2356 $rmp->{random_seed} ||= $exit->random_seed;
1909 2357
1910 my $data = cf::to_json $rmp; 2358 my $data = cf::to_json $rmp;
1911 my $md5 = Digest::MD5::md5_hex $data; 2359 my $md5 = Digest::MD5::md5_hex $data;
1912 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2360 my $meta = "$RANDOMDIR/$md5.meta";
1913 2361
1914 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2362 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1915 aio_write $fh, 0, (length $data), $data, 0; 2363 aio_write $fh, 0, (length $data), $data, 0;
1916 undef $fh; 2364 undef $fh;
1917 aio_rename "$meta~", $meta; 2365 aio_rename "$meta~", $meta;
1926 2374
1927 return unless $self->type == cf::PLAYER; 2375 return unless $self->type == cf::PLAYER;
1928 2376
1929 if ($exit->slaying eq "/!") { 2377 if ($exit->slaying eq "/!") {
1930 #TODO: this should de-fi-ni-te-ly not be a sync-job 2378 #TODO: this should de-fi-ni-te-ly not be a sync-job
2379 # the problem is that $exit might not survive long enough
2380 # so it needs to be done right now, right here
1931 cf::sync_job { prepare_random_map $exit }; 2381 cf::sync_job { prepare_random_map $exit };
1932 } 2382 }
1933 2383
1934 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2384 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1935 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
1936 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
1937 2387
1938 $self->enter_link; 2388 $self->enter_link;
2389
2390 # if exit is damned, update players death & WoR home-position
2391 $self->contr->savebed ($slaying, $hp, $sp)
2392 if $exit->flag (FLAG_DAMNED);
1939 2393
1940 (async { 2394 (async {
1941 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
1942 unless (eval { 2396 unless (eval {
1943 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
1944 2398
1945 1; 2399 1;
1946 }) { 2400 }) {
1947 $self->message ("Something went wrong deep within the crossfire server. " 2401 $self->message ("Something went wrong deep within the crossfire server. "
1948 . "I'll try to bring you back to the map you were before. " 2402 . "I'll try to bring you back to the map you were before. "
1949 . "Please report this to the dungeon master!", 2403 . "Please report this to the dungeon master!",
1950 cf::NDI_UNIQUE | cf::NDI_RED); 2404 cf::NDI_UNIQUE | cf::NDI_RED);
1951 2405
1952 warn "ERROR in enter_exit: $@"; 2406 warn "ERROR in enter_exit: $@";
1953 $self->leave_link; 2407 $self->leave_link;
1954 } 2408 }
1955 })->prio (1); 2409 })->prio (1);
1968 2422
1969sub cf::client::send_drawinfo { 2423sub cf::client::send_drawinfo {
1970 my ($self, $text, $flags) = @_; 2424 my ($self, $text, $flags) = @_;
1971 2425
1972 utf8::encode $text; 2426 utf8::encode $text;
1973 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1974} 2428}
1975 2429
2430=item $client->send_msg ($channel, $msg, $color, [extra...])
2431
2432Send a drawinfo or msg packet to the client, formatting the msg for the
2433client if neccessary. C<$type> should be a string identifying the type of
2434the message, with C<log> being the default. If C<$color> is negative, suppress
2435the message unless the client supports the msg packet.
2436
2437=cut
2438
2439sub cf::client::send_msg {
2440 my ($self, $channel, $msg, $color, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 $color &= ~cf::NDI_UNIQUE; # just in case...
2447
2448 if (ref $channel) {
2449 # send meta info to client, if not yet sent
2450 unless (exists $self->{channel}{$channel->{id}}) {
2451 $self->{channel}{$channel->{id}} = $channel;
2452 $self->ext_event (channel_info => %$channel);
2453 }
2454
2455 $channel = $channel->{id};
2456 }
2457
2458 if ($self->can_msg) {
2459 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2460 } else {
2461 # replace some tags by gcfclient-compatible ones
2462 for ($msg) {
2463 1 while
2464 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2465 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2466 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2467 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2468 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2469 }
2470
2471 if ($color >= 0) {
2472 if (0 && $msg =~ /\[/) {
2473 $self->send_packet ("drawextinfo $color 4 0 $msg")
2474 } else {
2475 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2476 $self->send_packet ("drawinfo $color $msg")
2477 }
2478 }
2479 }
2480}
2481
2482=item $client->ext_event ($type, %msg)
2483
2484Sends an ext event to the client.
2485
2486=cut
2487
2488sub cf::client::ext_event($$%) {
2489 my ($self, $type, %msg) = @_;
2490
2491 return unless $self->extcmd;
2492
2493 $msg{msgtype} = "event_$type";
2494 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2495}
1976 2496
1977=item $success = $client->query ($flags, "text", \&cb) 2497=item $success = $client->query ($flags, "text", \&cb)
1978 2498
1979Queues a query to the client, calling the given callback with 2499Queues a query to the client, calling the given callback with
1980the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2500the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1981C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2501C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1982 2502
1983Queries can fail, so check the return code. Or don't, as queries will become 2503Queries can fail, so check the return code. Or don't, as queries will
1984reliable at some point in the future. 2504become reliable at some point in the future.
1985 2505
1986=cut 2506=cut
1987 2507
1988sub cf::client::query { 2508sub cf::client::query {
1989 my ($self, $flags, $text, $cb) = @_; 2509 my ($self, $flags, $text, $cb) = @_;
1997 utf8::encode $text; 2517 utf8::encode $text;
1998 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2518 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1999 2519
2000 $self->send_packet ($self->{query_queue}[0][0]) 2520 $self->send_packet ($self->{query_queue}[0][0])
2001 if @{ $self->{query_queue} } == 1; 2521 if @{ $self->{query_queue} } == 1;
2522
2523 1
2002} 2524}
2003 2525
2004cf::client->attach ( 2526cf::client->attach (
2527 on_connect => sub {
2528 my ($ns) = @_;
2529
2530 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2531 },
2005 on_reply => sub { 2532 on_reply => sub {
2006 my ($ns, $msg) = @_; 2533 my ($ns, $msg) = @_;
2007 2534
2008 # this weird shuffling is so that direct followup queries 2535 # this weird shuffling is so that direct followup queries
2009 # get handled first 2536 # get handled first
2021 } else { 2548 } else {
2022 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2549 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2023 } 2550 }
2024 } 2551 }
2025 }, 2552 },
2553 on_exticmd => sub {
2554 my ($ns, $buf) = @_;
2555
2556 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2557
2558 if (ref $msg) {
2559 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2560 if (my %reply = $cb->($ns, $msg)) {
2561 $reply{msgid} = $msg->{msgid};
2562 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2563 }
2564 }
2565 } else {
2566 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2567 }
2568
2569 cf::override;
2570 },
2026); 2571);
2027 2572
2028=item $client->async (\&cb) 2573=item $client->async (\&cb)
2029 2574
2030Create a new coroutine, running the specified callback. The coroutine will 2575Create a new coroutine, running the specified callback. The coroutine will
2077 2622
2078# here we export the classes and methods available to script code 2623# here we export the classes and methods available to script code
2079 2624
2080=pod 2625=pod
2081 2626
2082The following fucntions and emthods are available within a safe environment: 2627The following functions and methods are available within a safe environment:
2083 2628
2084 cf::object contr pay_amount pay_player map 2629 cf::object
2630 contr pay_amount pay_player map x y force_find force_add
2631 insert remove
2632
2085 cf::object::player player 2633 cf::object::player
2086 cf::player peaceful 2634 player
2087 cf::map trigger 2635
2636 cf::player
2637 peaceful
2638
2639 cf::map
2640 trigger
2088 2641
2089=cut 2642=cut
2090 2643
2091for ( 2644for (
2092 ["cf::object" => qw(contr pay_amount pay_player map)], 2645 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2646 insert remove)],
2093 ["cf::object::player" => qw(player)], 2647 ["cf::object::player" => qw(player)],
2094 ["cf::player" => qw(peaceful)], 2648 ["cf::player" => qw(peaceful)],
2095 ["cf::map" => qw(trigger)], 2649 ["cf::map" => qw(trigger)],
2096) { 2650) {
2097 no strict 'refs'; 2651 no strict 'refs';
2168=back 2722=back
2169 2723
2170=cut 2724=cut
2171 2725
2172############################################################################# 2726#############################################################################
2173
2174=head2 EXTENSION DATABASE SUPPORT
2175
2176Crossfire maintains a very simple database for extension use. It can
2177currently store anything that can be serialised using Storable, which
2178excludes objects.
2179
2180The parameter C<$family> should best start with the name of the extension
2181using it, it should be unique.
2182
2183=over 4
2184
2185=item $value = cf::db_get $family => $key
2186
2187Returns a single value from the database.
2188
2189=item cf::db_put $family => $key => $value
2190
2191Stores the given C<$value> in the family.
2192
2193=cut
2194
2195our $DB;
2196
2197sub db_init {
2198 unless ($DB) {
2199 $DB = BDB::db_create $DB_ENV;
2200
2201 cf::sync_job {
2202 eval {
2203 $DB->set_flags (BDB::CHKSUM);
2204
2205 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2206 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2207 cf::cleanup "db_open(db): $!" if $!;
2208 };
2209 cf::cleanup "db_open(db): $@" if $@;
2210 };
2211
2212 my $path = cf::localdir . "/database.pst";
2213 if (stat $path) {
2214 cf::sync_job {
2215 my $pst = Storable::retrieve $path;
2216
2217 cf::db_put (board => data => $pst->{board});
2218 cf::db_put (guildrules => data => $pst->{guildrules});
2219 cf::db_put (rent => balance => $pst->{rent}{balance});
2220 BDB::db_env_txn_checkpoint $DB_ENV;
2221
2222 unlink $path;
2223 };
2224 }
2225 }
2226}
2227
2228sub db_get($$) {
2229 my $key = "$_[0]/$_[1]";
2230
2231 cf::sync_job {
2232 BDB::db_get $DB, undef, $key, my $data;
2233
2234 $! ? ()
2235 : Compress::LZF::sthaw $data
2236 }
2237}
2238
2239sub db_put($$$) {
2240 BDB::dbreq_pri 4;
2241 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2242}
2243
2244#############################################################################
2245# the server's init and main functions 2727# the server's init and main functions
2246 2728
2247sub init_resources { 2729sub load_facedata($) {
2248 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2730 my ($path) = @_;
2731
2732 warn "loading facedata from $path\n";
2733
2734 my $facedata;
2735 0 < aio_load $path, $facedata
2736 or die "$path: $!";
2737
2738 $facedata = Coro::Storable::thaw $facedata;
2739
2740 $facedata->{version} == 2
2741 or cf::cleanup "$path: version mismatch, cannot proceed.";
2742
2743 {
2744 my $faces = $facedata->{faceinfo};
2745
2746 while (my ($face, $info) = each %$faces) {
2747 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2748 cf::face::set_visibility $idx, $info->{visibility};
2749 cf::face::set_magicmap $idx, $info->{magicmap};
2750 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2751 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2752
2753 cf::cede_to_tick;
2754 }
2755
2756 while (my ($face, $info) = each %$faces) {
2757 next unless $info->{smooth};
2758 my $idx = cf::face::find $face
2759 or next;
2760 if (my $smooth = cf::face::find $info->{smooth}) {
2761 cf::face::set_smooth $idx, $smooth;
2762 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2763 } else {
2764 warn "smooth face '$info->{smooth}' not found for face '$face'";
2765 }
2766
2767 cf::cede_to_tick;
2768 }
2769 }
2770
2771 {
2772 my $anims = $facedata->{animinfo};
2773
2774 while (my ($anim, $info) = each %$anims) {
2775 cf::anim::set $anim, $info->{frames}, $info->{facings};
2776 cf::cede_to_tick;
2777 }
2778
2779 cf::anim::invalidate_all; # d'oh
2780 }
2781
2782 {
2783 # TODO: for gcfclient pleasure, we should give resources
2784 # that gcfclient doesn't grok a >10000 face index.
2785 my $res = $facedata->{resource};
2786 my $enc = JSON::XS->new->utf8->canonical;
2787
2788 while (my ($name, $info) = each %$res) {
2789 my $meta = $enc->encode ({
2790 name => $name,
2791 type => $info->{type},
2792 copyright => $info->{copyright}, #TODO#
2793 });
2794
2795 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2796
2797 if ($name =~ /\.jpg$/) {
2798 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2799 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2800 } else {
2801 my $data = pack "(w/a*)*", $meta, $info->{data};
2802 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2803
2804 cf::face::set_type $idx, 1;
2805 cf::face::set_data $idx, 0, $data, $chk;
2806 }
2807
2808 cf::cede_to_tick;
2809 }
2810 }
2811
2812 1
2813}
2814
2815sub reload_regions {
2816 load_resource_file "$MAPDIR/regions"
2249 or die "unable to load regions file\n";#d# 2817 or die "unable to load regions file\n";
2818
2819 for (cf::region::list) {
2820 $_->{match} = qr/$_->{match}/
2821 if exists $_->{match};
2822 }
2823}
2824
2825sub reload_facedata {
2826 load_facedata "$DATADIR/facedata"
2827 or die "unable to load facedata\n";
2828}
2829
2830sub reload_archetypes {
2831 load_resource_file "$DATADIR/archetypes"
2832 or die "unable to load archetypes\n";
2833 #d# NEED to laod twice to resolve forward references
2834 # this really needs to be done in an extra post-pass
2835 # (which needs to be synchronous, so solve it differently)
2836 load_resource_file "$DATADIR/archetypes"
2837 or die "unable to load archetypes\n";
2838}
2839
2840sub reload_treasures {
2841 load_resource_file "$DATADIR/treasures"
2842 or die "unable to load treasurelists\n";
2843}
2844
2845sub reload_resources {
2846 warn "reloading resource files...\n";
2847
2848 reload_regions;
2849 reload_facedata;
2850 #reload_archetypes;#d#
2851 reload_archetypes;
2852 reload_treasures;
2853
2854 warn "finished reloading resource files\n";
2855}
2856
2857sub init {
2858 reload_resources;
2250} 2859}
2251 2860
2252sub cfg_load { 2861sub cfg_load {
2253 open my $fh, "<:utf8", cf::confdir . "/config" 2862 open my $fh, "<:utf8", "$CONFDIR/config"
2254 or return; 2863 or return;
2255 2864
2256 local $/; 2865 local $/;
2257 *CFG = YAML::Syck::Load <$fh>; 2866 *CFG = YAML::Syck::Load <$fh>;
2258 2867
2266 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2875 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2267 and die "WARNING: m(un)lockall failed: $!\n"; 2876 and die "WARNING: m(un)lockall failed: $!\n";
2268 }; 2877 };
2269 warn $@ if $@; 2878 warn $@ if $@;
2270 } 2879 }
2271}
2272
2273sub init {
2274 init_resources;
2275} 2880}
2276 2881
2277sub main { 2882sub main {
2278 # we must not ever block the main coroutine 2883 # we must not ever block the main coroutine
2279 local $Coro::idle = sub { 2884 local $Coro::idle = sub {
2307 }, 2912 },
2308 ); 2913 );
2309 } 2914 }
2310} 2915}
2311 2916
2917sub write_runtime {
2918 my $runtime = "$LOCALDIR/runtime";
2919
2920 # first touch the runtime file to show we are still running:
2921 # the fsync below can take a very very long time.
2922
2923 IO::AIO::aio_utime $runtime, undef, undef;
2924
2925 my $guard = cf::lock_acquire "write_runtime";
2926
2927 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2928 or return;
2929
2930 my $value = $cf::RUNTIME + 90 + 10;
2931 # 10 is the runtime save interval, for a monotonic clock
2932 # 60 allows for the watchdog to kill the server.
2933
2934 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2935 and return;
2936
2937 # always fsync - this file is important
2938 aio_fsync $fh
2939 and return;
2940
2941 # touch it again to show we are up-to-date
2942 aio_utime $fh, undef, undef;
2943
2944 close $fh
2945 or return;
2946
2947 aio_rename "$runtime~", $runtime
2948 and return;
2949
2950 warn "runtime file written.\n";
2951
2952 1
2953}
2954
2312sub emergency_save() { 2955sub emergency_save() {
2313 my $freeze_guard = cf::freeze_mainloop; 2956 my $freeze_guard = cf::freeze_mainloop;
2314 2957
2315 warn "enter emergency perl save\n"; 2958 warn "enter emergency perl save\n";
2316 2959
2347 2990
2348 warn Carp::longmess "post_cleanup backtrace" 2991 warn Carp::longmess "post_cleanup backtrace"
2349 if $make_core; 2992 if $make_core;
2350} 2993}
2351 2994
2352sub reload() { 2995sub do_reload_perl() {
2353 # can/must only be called in main 2996 # can/must only be called in main
2354 if ($Coro::current != $Coro::main) { 2997 if ($Coro::current != $Coro::main) {
2355 warn "can only reload from main coroutine"; 2998 warn "can only reload from main coroutine";
2356 return; 2999 return;
2357 } 3000 }
2382 Coro::cede; 3025 Coro::cede;
2383 last unless IO::AIO::nreqs || BDB::nreqs; 3026 last unless IO::AIO::nreqs || BDB::nreqs;
2384 warn "iterate..."; 3027 warn "iterate...";
2385 } 3028 }
2386 3029
3030 ++$RELOAD;
3031
2387 warn "cancelling all extension coros"; 3032 warn "cancelling all extension coros";
2388 $_->cancel for values %EXT_CORO; 3033 $_->cancel for values %EXT_CORO;
2389 %EXT_CORO = (); 3034 %EXT_CORO = ();
2390 3035
2391 warn "removing commands"; 3036 warn "removing commands";
2392 %COMMAND = (); 3037 %COMMAND = ();
2393 3038
2394 warn "removing ext commands"; 3039 warn "removing ext/exti commands";
2395 %EXTCMD = (); 3040 %EXTCMD = ();
3041 %EXTICMD = ();
2396 3042
2397 warn "unloading/nuking all extensions"; 3043 warn "unloading/nuking all extensions";
2398 for my $pkg (@EXTS) { 3044 for my $pkg (@EXTS) {
2399 warn "... unloading $pkg"; 3045 warn "... unloading $pkg";
2400 3046
2430 Symbol::delete_package "safe::$_" 3076 Symbol::delete_package "safe::$_"
2431 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3077 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2432 3078
2433 warn "unloading cf.pm \"a bit\""; 3079 warn "unloading cf.pm \"a bit\"";
2434 delete $INC{"cf.pm"}; 3080 delete $INC{"cf.pm"};
3081 delete $INC{"cf/pod.pm"};
2435 3082
2436 # don't, removes xs symbols, too, 3083 # don't, removes xs symbols, too,
2437 # and global variables created in xs 3084 # and global variables created in xs
2438 #Symbol::delete_package __PACKAGE__; 3085 #Symbol::delete_package __PACKAGE__;
2439 3086
2448 3095
2449 warn "loading extensions"; 3096 warn "loading extensions";
2450 cf::load_extensions; 3097 cf::load_extensions;
2451 3098
2452 warn "reattaching attachments to objects/players"; 3099 warn "reattaching attachments to objects/players";
2453 _global_reattach; 3100 _global_reattach; # objects, sockets
2454 warn "reattaching attachments to maps"; 3101 warn "reattaching attachments to maps";
2455 reattach $_ for values %MAP; 3102 reattach $_ for values %MAP;
2456 3103 warn "reattaching attachments to players";
2457 warn "loading reloadable resources"; 3104 reattach $_ for values %PLAYER;
2458 init_resources;
2459 3105
2460 warn "leaving sync_job"; 3106 warn "leaving sync_job";
2461 3107
2462 1 3108 1
2463 } or do { 3109 } or do {
2469 warn "reloaded"; 3115 warn "reloaded";
2470}; 3116};
2471 3117
2472our $RELOAD_WATCHER; # used only during reload 3118our $RELOAD_WATCHER; # used only during reload
2473 3119
3120sub reload_perl() {
3121 # doing reload synchronously and two reloads happen back-to-back,
3122 # coro crashes during coro_state_free->destroy here.
3123
3124 $RELOAD_WATCHER ||= Event->timer (
3125 reentrant => 0,
3126 after => 0,
3127 data => WF_AUTOCANCEL,
3128 cb => sub {
3129 do_reload_perl;
3130 undef $RELOAD_WATCHER;
3131 },
3132 );
3133}
3134
2474register_command "reload" => sub { 3135register_command "reload" => sub {
2475 my ($who, $arg) = @_; 3136 my ($who, $arg) = @_;
2476 3137
2477 if ($who->flag (FLAG_WIZ)) { 3138 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("reloading server."); 3139 $who->message ("reloading server.");
2479 3140 async { reload_perl };
2480 # doing reload synchronously and two reloads happen back-to-back,
2481 # coro crashes during coro_state_free->destroy here.
2482
2483 $RELOAD_WATCHER ||= Event->timer (
2484 reentrant => 0,
2485 after => 0,
2486 data => WF_AUTOCANCEL,
2487 cb => sub {
2488 reload;
2489 undef $RELOAD_WATCHER;
2490 },
2491 );
2492 } 3141 }
2493}; 3142};
2494 3143
2495unshift @INC, $LIBDIR; 3144unshift @INC, $LIBDIR;
2496 3145
2497my $bug_warning = 0; 3146my $bug_warning = 0;
2498 3147
3148our @WAIT_FOR_TICK;
3149our @WAIT_FOR_TICK_BEGIN;
3150
3151sub wait_for_tick {
3152 return unless $TICK_WATCHER->is_active;
3153 return if $Coro::current == $Coro::main;
3154
3155 my $signal = new Coro::Signal;
3156 push @WAIT_FOR_TICK, $signal;
3157 $signal->wait;
3158}
3159
3160sub wait_for_tick_begin {
3161 return unless $TICK_WATCHER->is_active;
3162 return if $Coro::current == $Coro::main;
3163
3164 my $signal = new Coro::Signal;
3165 push @WAIT_FOR_TICK_BEGIN, $signal;
3166 $signal->wait;
3167}
3168
3169 my $min = 1e6;#d#
3170 my $avg = 10;
2499$TICK_WATCHER = Event->timer ( 3171$TICK_WATCHER = Event->timer (
2500 reentrant => 0, 3172 reentrant => 0,
2501 parked => 1, 3173 parked => 1,
2502 prio => 0, 3174 prio => 0,
2503 at => $NEXT_TICK || $TICK, 3175 at => $NEXT_TICK || $TICK,
2507 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3179 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508 unless ++$bug_warning > 10; 3180 unless ++$bug_warning > 10;
2509 return; 3181 return;
2510 } 3182 }
2511 3183
2512 $NOW = Event::time; 3184 $NOW = $tick_start = Event::time;
2513 3185
2514 cf::server_tick; # one server iteration 3186 cf::server_tick; # one server iteration
3187
3188 0 && sync_job {#d#
3189 for(1..10) {
3190 my $t = Event::time;
3191 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3192 or die;
3193
3194 $map->width (50);
3195 $map->height (50);
3196 $map->alloc;
3197 $map->_load_objects ("/tmp/x.map", 1);
3198 my $t = Event::time - $t;
3199
3200 #next unless $t < 0.0013;#d#
3201 if ($t < $min) {
3202 $min = $t;
3203 }
3204 $avg = $avg * 0.99 + $t * 0.01;
3205 }
3206 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3207 exit 0;
3208 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3209 };
3210
2515 $RUNTIME += $TICK; 3211 $RUNTIME += $TICK;
2516 $NEXT_TICK += $TICK; 3212 $NEXT_TICK += $TICK;
2517 3213
2518 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3214 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519 $NEXT_RUNTIME_WRITE = $NOW + 10; 3215 $NEXT_RUNTIME_WRITE = $NOW + 10;
2521 write_runtime 3217 write_runtime
2522 or warn "ERROR: unable to write runtime file: $!"; 3218 or warn "ERROR: unable to write runtime file: $!";
2523 }; 3219 };
2524 } 3220 }
2525 3221
2526
2527 $WAIT_FOR_TICK->broadcast;
2528 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2529
2530# my $AFTER = Event::time; 3222# my $AFTER = Event::time;
2531# warn $AFTER - $NOW;#d# 3223# warn $AFTER - $NOW;#d#
2532 3224
3225 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3226 $sig->send;
3227 }
3228 while (my $sig = shift @WAIT_FOR_TICK) {
3229 $sig->send;
3230 }
3231
3232 $NOW = Event::time;
3233
2533 # if we are delayed by four ticks or more, skip them all 3234 # if we are delayed by four ticks or more, skip them all
2534 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3235 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2535 3236
2536 $TICK_WATCHER->at ($NEXT_TICK); 3237 $TICK_WATCHER->at ($NEXT_TICK);
2537 $TICK_WATCHER->start; 3238 $TICK_WATCHER->start;
3239
3240 $LOAD = ($NOW - $tick_start) / $TICK;
3241 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3242
3243 _post_tick;
3244
3245
2538 }, 3246 },
2539); 3247);
2540 3248
2541{ 3249{
2542 BDB::max_poll_time $TICK * 0.1; 3250 BDB::max_poll_time $TICK * 0.1;
2570 3278
2571 cf::sync_job { 3279 cf::sync_job {
2572 eval { 3280 eval {
2573 BDB::db_env_open 3281 BDB::db_env_open
2574 $DB_ENV, 3282 $DB_ENV,
2575 $BDB_ENV_DIR, 3283 $BDBDIR,
2576 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3284 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2577 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3285 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2578 0666; 3286 0666;
2579 3287
2580 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3288 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2581 3289
2582 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3290 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2583 $DB_ENV->set_lk_detect; 3291 $DB_ENV->set_lk_detect;
2584 }; 3292 };
2585 3293
2601 prio => 6, 3309 prio => 6,
2602 cb => \&IO::AIO::poll_cb, 3310 cb => \&IO::AIO::poll_cb,
2603 ); 3311 );
2604} 3312}
2605 3313
3314my $_log_backtrace;
3315
3316sub _log_backtrace {
3317 my ($msg, @addr) = @_;
3318
3319 $msg =~ s/\n//;
3320
3321 # limit the # of concurrent backtraces
3322 if ($_log_backtrace < 2) {
3323 ++$_log_backtrace;
3324 async {
3325 my @bt = fork_call {
3326 @addr = map { sprintf "%x", $_ } @addr;
3327 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3328 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3329 or die "addr2line: $!";
3330
3331 my @funcs;
3332 my @res = <$fh>;
3333 chomp for @res;
3334 while (@res) {
3335 my ($func, $line) = splice @res, 0, 2, ();
3336 push @funcs, "[$func] $line";
3337 }
3338
3339 @funcs
3340 };
3341
3342 LOG llevInfo, "[ABT] $msg\n";
3343 LOG llevInfo, "[ABT] $_\n" for @bt;
3344 --$_log_backtrace;
3345 };
3346 } else {
3347 LOG llevInfo, "[ABT] $msg\n";
3348 LOG llevInfo, "[ABT] [suppressed]\n";
3349 }
3350}
3351
3352# load additional modules
3353use cf::pod;
3354
2606END { cf::emergency_save } 3355END { cf::emergency_save }
2607 3356
26081 33571
2609 3358

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines