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.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.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
702############################################################################# 921#############################################################################
703# 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}
704 934
705sub reattach { 935sub reattach {
706 # basically do the same as instantiate, without calling instantiate 936 # basically do the same as instantiate, without calling instantiate
707 my ($obj) = @_; 937 my ($obj) = @_;
708 938
811 or return; 1041 or return;
812 $av = eval { (Storable::thaw $av)->{objs} }; 1042 $av = eval { (Storable::thaw $av)->{objs} };
813 } 1043 }
814 1044
815 warn sprintf "loading %s (%d)\n", 1045 warn sprintf "loading %s (%d)\n",
816 $filename, length $data, scalar @{$av || []};#d# 1046 $filename, length $data, scalar @{$av || []};
817 return ($data, $av); 1047 return ($data, $av);
818} 1048}
1049
1050=head2 COMMAND CALLBACKS
1051
1052=over 4
1053
1054=cut
819 1055
820############################################################################# 1056#############################################################################
821# command handling &c 1057# command handling &c
822 1058
823=item cf::register_command $name => \&callback($ob,$args); 1059=item cf::register_command $name => \&callback($ob,$args);
836 push @{ $COMMAND{$name} }, [$caller, $cb]; 1072 push @{ $COMMAND{$name} }, [$caller, $cb];
837} 1073}
838 1074
839=item cf::register_extcmd $name => \&callback($pl,$packet); 1075=item cf::register_extcmd $name => \&callback($pl,$packet);
840 1076
841Register 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.
842 1082
843If 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
844called. 1084called.
845 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
846=cut 1097=cut
847 1098
848sub register_extcmd { 1099sub register_extcmd {
849 my ($name, $cb) = @_; 1100 my ($name, $cb) = @_;
850 1101
851 $EXTCMD{$name} = $cb; 1102 $EXTCMD{$name} = $cb;
1103}
1104
1105sub register_exticmd {
1106 my ($name, $cb) = @_;
1107
1108 $EXTICMD{$name} = $cb;
852} 1109}
853 1110
854cf::player->attach ( 1111cf::player->attach (
855 on_command => sub { 1112 on_command => sub {
856 my ($pl, $name, $params) = @_; 1113 my ($pl, $name, $params) = @_;
865 cf::override; 1122 cf::override;
866 }, 1123 },
867 on_extcmd => sub { 1124 on_extcmd => sub {
868 my ($pl, $buf) = @_; 1125 my ($pl, $buf) = @_;
869 1126
870 my $msg = eval { from_json $buf }; 1127 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871 1128
872 if (ref $msg) { 1129 if (ref $msg) {
873 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1130 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
874 if (my %reply = $cb->($pl, $msg)) { 1131 if (my %reply = $cb->($pl, $msg)) {
875 $pl->ext_reply ($msg->{msgid}, %reply); 1132 $pl->ext_reply ($msg->{msgid}, %reply);
881 1138
882 cf::override; 1139 cf::override;
883 }, 1140 },
884); 1141);
885 1142
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 { 1143sub load_extensions {
1144 cf::sync_job {
1145 my %todo;
1146
921 for my $ext (<$LIBDIR/*.ext>) { 1147 for my $path (<$LIBDIR/*.ext>) {
922 next unless -r $ext; 1148 next unless -r $path;
923 eval { 1149
924 load_extension $ext; 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;
925 1 1207 }
926 } or warn "$ext not loaded: $@"; 1208
1209 skip:
1210 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1211 unless $progress;
1212 }
927 } 1213 };
928} 1214}
929 1215
930############################################################################# 1216#############################################################################
931 1217
1218=back
1219
932=head2 CORE EXTENSIONS 1220=head2 CORE EXTENSIONS
933 1221
934Functions and methods that extend core crossfire objects. 1222Functions and methods that extend core crossfire objects.
935 1223
936=cut 1224=cut
948Returns the given player object, loading it if necessary (might block). 1236Returns the given player object, loading it if necessary (might block).
949 1237
950=cut 1238=cut
951 1239
952sub playerdir($) { 1240sub playerdir($) {
953 cf::localdir 1241 "$PLAYERDIR/"
954 . "/"
955 . cf::playerdir
956 . "/"
957 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1242 . (ref $_[0] ? $_[0]->ob->name : $_[0])
958} 1243}
959 1244
960sub path($) { 1245sub path($) {
961 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1246 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962 1247
963 (playerdir $login) . "/$login.pl" 1248 (playerdir $login) . "/playerdata"
964} 1249}
965 1250
966sub find_active($) { 1251sub find_active($) {
967 $cf::PLAYER{$_[0]} 1252 $cf::PLAYER{$_[0]}
968 and $cf::PLAYER{$_[0]}->active 1253 and $cf::PLAYER{$_[0]}->active
981 my $login = $_[0]; 1266 my $login = $_[0];
982 1267
983 my $guard = cf::lock_acquire "user_find:$login"; 1268 my $guard = cf::lock_acquire "user_find:$login";
984 1269
985 $cf::PLAYER{$_[0]} || do { 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
986 my $pl = load_pl path $login 1278 my $pl = load_pl path $login
987 or return; 1279 or return;
988 $cf::PLAYER{$login} = $pl 1280 $cf::PLAYER{$login} = $pl
989 } 1281 }
990 } 1282 }
1027 1319
1028=cut 1320=cut
1029 1321
1030sub quit_character { 1322sub quit_character {
1031 my ($pl) = @_; 1323 my ($pl) = @_;
1324
1325 my $name = $pl->ob->name;
1032 1326
1033 $pl->{deny_save} = 1; 1327 $pl->{deny_save} = 1;
1034 $pl->password ("*"); # this should lock out the player until we nuked the dir 1328 $pl->password ("*"); # this should lock out the player until we nuked the dir
1035 1329
1036 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1330 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041 my $path = playerdir $pl; 1335 my $path = playerdir $pl;
1042 my $temp = "$path~$cf::RUNTIME~deleting~"; 1336 my $temp = "$path~$cf::RUNTIME~deleting~";
1043 aio_rename $path, $temp; 1337 aio_rename $path, $temp;
1044 delete $cf::PLAYER{$pl->ob->name}; 1338 delete $cf::PLAYER{$pl->ob->name};
1045 $pl->destroy; 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
1046 IO::AIO::aio_rmtree $temp; 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;
1047} 1361}
1048 1362
1049=item cf::player::list_logins 1363=item cf::player::list_logins
1050 1364
1051Returns am arrayref of all valid playernames in the system, can take a 1365Returns am arrayref of all valid playernames in the system, can take a
1052while and may block, so not sync_job-capable, ever. 1366while and may block, so not sync_job-capable, ever.
1053 1367
1054=cut 1368=cut
1055 1369
1056sub list_logins { 1370sub list_logins {
1057 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1371 my $dirs = aio_readdir $PLAYERDIR
1058 or return []; 1372 or return [];
1059 1373
1060 my @logins; 1374 my @logins;
1061 1375
1062 for my $login (@$dirs) { 1376 for my $login (@$dirs) {
1097 } 1411 }
1098 1412
1099 \@paths 1413 \@paths
1100} 1414}
1101 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
1102=item $player->ext_reply ($msgid, $msgtype, %msg) 1466=item $player->ext_reply ($msgid, %msg)
1103 1467
1104Sends an ext reply to the player. 1468Sends an ext reply to the player.
1105 1469
1106=cut 1470=cut
1107 1471
1108sub ext_reply($$$%) { 1472sub ext_reply($$%) {
1109 my ($self, $id, %msg) = @_; 1473 my ($self, $id, %msg) = @_;
1110 1474
1111 $msg{msgid} = $id; 1475 $msg{msgid} = $id;
1112 1476 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1113 $self->send ("ext " . cf::to_json \%msg);
1114} 1477}
1115 1478
1116package cf; 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}
1117 1519
1118=back 1520=back
1119
1120 1521
1121=head3 cf::map 1522=head3 cf::map
1122 1523
1123=over 4 1524=over 4
1124 1525
1179 my ($self, $merge) = @_; 1580 my ($self, $merge) = @_;
1180 1581
1181 # we have to keep some variables in memory intact 1582 # we have to keep some variables in memory intact
1182 local $self->{path}; 1583 local $self->{path};
1183 local $self->{load_path}; 1584 local $self->{load_path};
1184 local $self->{deny_save};
1185 local $self->{deny_reset};
1186 1585
1187 $self->SUPER::thawer_merge ($merge); 1586 $self->SUPER::thawer_merge ($merge);
1188} 1587}
1189 1588
1190sub normalise { 1589sub normalise {
1237 $self->init; # pass $1 etc. 1636 $self->init; # pass $1 etc.
1238 return $self; 1637 return $self;
1239 } 1638 }
1240 } 1639 }
1241 1640
1242 Carp::carp "unable to resolve path '$path' (base '$base')."; 1641 Carp::cluck "unable to resolve path '$path' (base '$base').";
1243 () 1642 ()
1244} 1643}
1245 1644
1246sub init { 1645sub init {
1247 my ($self) = @_; 1646 my ($self) = @_;
1262 1661
1263# the original (read-only) location 1662# the original (read-only) location
1264sub load_path { 1663sub load_path {
1265 my ($self) = @_; 1664 my ($self) = @_;
1266 1665
1267 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1666 "$MAPDIR/$self->{path}.map"
1268} 1667}
1269 1668
1270# the temporary/swap location 1669# the temporary/swap location
1271sub save_path { 1670sub save_path {
1272 my ($self) = @_; 1671 my ($self) = @_;
1273 1672
1274 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1673 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1275 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1674 "$TMPDIR/$path.map"
1276} 1675}
1277 1676
1278# the unique path, undef == no special unique path 1677# the unique path, undef == no special unique path
1279sub uniq_path { 1678sub uniq_path {
1280 my ($self) = @_; 1679 my ($self) = @_;
1281 1680
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1681 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1682 "$UNIQUEDIR/$path"
1284} 1683}
1285 1684
1286# and all this just because we cannot iterate over 1685# and all this just because we cannot iterate over
1287# all maps in C++... 1686# all maps in C++...
1288sub change_all_map_light { 1687sub change_all_map_light {
1289 my ($change) = @_; 1688 my ($change) = @_;
1290 1689
1291 $_->change_map_light ($change) 1690 $_->change_map_light ($change)
1292 for grep $_->outdoor, values %cf::MAP; 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;
1293} 1700}
1294 1701
1295sub unlink_save { 1702sub unlink_save {
1296 my ($self) = @_; 1703 my ($self) = @_;
1297 1704
1355 $self->load_header_orig 1762 $self->load_header_orig
1356 or return; 1763 or return;
1357 $self->prepare_orig; 1764 $self->prepare_orig;
1358 } 1765 }
1359 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
1360 1 1773 1
1361} 1774}
1362 1775
1363sub find; 1776sub find;
1364sub find { 1777sub find {
1376 $map->{last_save} = $cf::RUNTIME; 1789 $map->{last_save} = $cf::RUNTIME;
1377 1790
1378 $map->load_header 1791 $map->load_header
1379 or return; 1792 or return;
1380 1793
1381 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1794 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1382 # doing this can freeze the server in a sync job, obviously 1795 # doing this can freeze the server in a sync job, obviously
1383 #$cf::WAIT_FOR_TICK->wait; 1796 #$cf::WAIT_FOR_TICK->wait;
1384 $map->reset; 1797 $map->reset;
1385 undef $guard; 1798 undef $guard;
1386 return find $path; 1799 return find $path;
1397 my ($self) = @_; 1810 my ($self) = @_;
1398 1811
1399 local $self->{deny_reset} = 1; # loading can take a long time 1812 local $self->{deny_reset} = 1; # loading can take a long time
1400 1813
1401 my $path = $self->{path}; 1814 my $path = $self->{path};
1815
1816 {
1402 my $guard = cf::lock_acquire "map_load:$path"; 1817 my $guard = cf::lock_acquire "map_load:$path";
1403 1818
1404 return if $self->in_memory != cf::MAP_SWAPPED; 1819 return if $self->in_memory != cf::MAP_SWAPPED;
1405 1820
1406 $self->in_memory (cf::MAP_LOADING); 1821 $self->in_memory (cf::MAP_LOADING);
1407 1822
1408 $self->alloc; 1823 $self->alloc;
1409 1824
1410 $self->pre_load; 1825 $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; 1826 Coro::cede;
1436 $self->set_darkness_map; 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);
1839 }
1840 }
1841
1842 Coro::cede;
1843 # now do the right thing for maps
1844 $self->link_multipart_objects;
1437 $self->difficulty ($self->estimate_difficulty) 1845 $self->difficulty ($self->estimate_difficulty)
1438 unless $self->difficulty; 1846 unless $self->difficulty;
1439 Coro::cede; 1847 Coro::cede;
1848
1849 unless ($self->{deny_activate}) {
1850 $self->decay_objects;
1851 $self->fix_auto_apply;
1852 $self->update_buttons;
1853 Coro::cede;
1854 $self->set_darkness_map;
1855 Coro::cede;
1440 $self->activate; 1856 $self->activate;
1857 }
1858
1859 $self->in_memory (cf::MAP_IN_MEMORY);
1441 } 1860 }
1442 1861
1443 $self->post_load; 1862 $self->post_load;
1444
1445 $self->in_memory (cf::MAP_IN_MEMORY);
1446} 1863}
1447 1864
1448sub customise_for { 1865sub customise_for {
1449 my ($self, $ob) = @_; 1866 my ($self, $ob) = @_;
1450 1867
1451 return find "~" . $ob->name . "/" . $self->{path} 1868 return find "~" . $ob->name . "/" . $self->{path}
1452 if $self->per_player; 1869 if $self->per_player;
1870
1871# return find "?party/" . $ob->name . "/" . $self->{path}
1872# if $self->per_party;
1453 1873
1454 $self 1874 $self
1455} 1875}
1456 1876
1457# find and load all maps in the 3x3 area around a map 1877# find and load all maps in the 3x3 area around a map
1504 1924
1505 undef $MAP_PREFETCH{$path}; 1925 undef $MAP_PREFETCH{$path};
1506 $MAP_PREFETCHER ||= cf::async { 1926 $MAP_PREFETCHER ||= cf::async {
1507 while (%MAP_PREFETCH) { 1927 while (%MAP_PREFETCH) {
1508 for my $path (keys %MAP_PREFETCH) { 1928 for my $path (keys %MAP_PREFETCH) {
1509 my $map = find $path 1929 if (my $map = find $path) {
1510 or next;
1511 $map->load; 1930 $map->load;
1931 }
1512 1932
1513 delete $MAP_PREFETCH{$path}; 1933 delete $MAP_PREFETCH{$path};
1514 } 1934 }
1515 } 1935 }
1516 undef $MAP_PREFETCHER; 1936 undef $MAP_PREFETCHER;
1568 1988
1569sub reset_at { 1989sub reset_at {
1570 my ($self) = @_; 1990 my ($self) = @_;
1571 1991
1572 # TODO: safety, remove and allow resettable per-player maps 1992 # 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}; 1993 return 1e99 if $self->{deny_reset};
1575 1994
1576 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1995 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1577 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1996 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1578 1997
1589 my ($self) = @_; 2008 my ($self) = @_;
1590 2009
1591 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2010 my $lock = cf::lock_acquire "map_data:$self->{path}";
1592 2011
1593 return if $self->players; 2012 return if $self->players;
1594 return if $self->isa ("ext::map_per_player");#d#
1595 2013
1596 warn "resetting map ", $self->path;#d# 2014 warn "resetting map ", $self->path;
1597 2015
1598 $self->in_memory (cf::MAP_SWAPPED); 2016 $self->in_memory (cf::MAP_SWAPPED);
1599 2017
1600 # need to save uniques path 2018 # need to save uniques path
1601 unless ($self->{deny_save}) { 2019 unless ($self->{deny_save}) {
1633 $cf::MAP{$self->path} = $self; 2051 $cf::MAP{$self->path} = $self;
1634 2052
1635 $self->reset; # polite request, might not happen 2053 $self->reset; # polite request, might not happen
1636} 2054}
1637 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
1638=item cf::map::unique_maps 2092=item cf::map::unique_maps
1639 2093
1640Returns an arrayref of paths of all shared maps that have 2094Returns an arrayref of paths of all shared maps that have
1641instantiated unique items. May block. 2095instantiated unique items. May block.
1642 2096
1643=cut 2097=cut
1644 2098
1645sub unique_maps() { 2099sub unique_maps() {
1646 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2100 [
1647 or return; 2101 map {
1648
1649 my @paths;
1650
1651 for (@$files) {
1652 utf8::decode $_; 2102 utf8::decode $_;
1653 next if /\.pst$/; 2103 /\.map$/
1654 next unless /^$PATH_SEP/o; 2104 ? normalise $_
1655 2105 : ()
1656 push @paths, cf::map::normalise $_; 2106 } @{ aio_readdir $UNIQUEDIR or [] }
1657 } 2107 ]
1658
1659 \@paths
1660} 2108}
1661 2109
1662package cf; 2110package cf;
1663 2111
1664=back 2112=back
1710 2158
1711 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2159 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1712 2160
1713 if ($self->{record_replies}) { 2161 if ($self->{record_replies}) {
1714 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2162 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2163
1715 } 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 {
1716 $msg = $npc->name . " says: $msg" if $npc; 2177 $msg = $npc->name . " says: $msg" if $npc;
1717 $self->message ($msg, $flags); 2178 $self->message ($msg, $flags);
2179 }
1718 } 2180 }
1719} 2181}
1720 2182
1721=item $player_object->may ("access") 2183=item $player_object->may ("access")
1722 2184
1770 $self->deactivate_recursive; 2232 $self->deactivate_recursive;
1771 2233
1772 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2234 return if UNIVERSAL::isa $self->map, "ext::map_link";
1773 2235
1774 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2236 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1775 if $self->map; 2237 if $self->map && $self->map->{path} ne "{link}";
1776 2238
1777 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2239 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1778} 2240}
1779 2241
1780sub cf::object::player::leave_link { 2242sub cf::object::player::leave_link {
1781 my ($self, $map, $x, $y) = @_; 2243 my ($self, $map, $x, $y) = @_;
2244
2245 return unless $self->contr->active;
1782 2246
1783 my $link_pos = delete $self->{_link_pos}; 2247 my $link_pos = delete $self->{_link_pos};
1784 2248
1785 unless ($map) { 2249 unless ($map) {
1786 # restore original map position 2250 # restore original map position
1809 2273
1810 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2274 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1811 $self->enter_map ($map, $x, $y); 2275 $self->enter_map ($map, $x, $y);
1812} 2276}
1813 2277
1814cf::player->attach ( 2278=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1815 on_logout => sub {
1816 my ($pl) = @_;
1817 2279
1818 # abort map switching before logout 2280Moves the player to the given map-path and coordinates by first freezing
1819 if ($pl->ob->{_link_pos}) { 2281her, loading and preparing them map, calling the provided $check callback
1820 cf::sync_job { 2282that has to return the map if sucecssful, and then unfreezes the player on
1821 $pl->ob->leave_link 2283the new (success) or old (failed) map position. In either case, $done will
1822 }; 2284be called at the end of this process.
1823 }
1824 },
1825 on_login => sub {
1826 my ($pl) = @_;
1827 2285
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 2286=cut
2287
2288our $GOTOGEN;
1849 2289
1850sub cf::object::player::goto { 2290sub cf::object::player::goto {
1851 my ($self, $path, $x, $y) = @_; 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;
1852 2295
1853 $self->enter_link; 2296 $self->enter_link;
1854 2297
1855 (async { 2298 (async {
1856 my $map = eval { 2299 my $map = eval {
1857 my $map = cf::map::find $path; 2300 my $map = cf::map::find $path;
2301
2302 if ($map) {
1858 $map = $map->customise_for ($self) 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
1859 $map 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 $@;
1860 } or 2315 }
1861 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1862 2316
2317 if ($gen == $self->{_goto_generation}) {
2318 delete $self->{_goto_generation};
1863 $self->leave_link ($map, $x, $y); 2319 $self->leave_link ($map, $x, $y);
2320 }
2321
2322 $done->() if $done;
1864 })->prio (1); 2323 })->prio (1);
1865} 2324}
1866 2325
1867=item $player_object->enter_exit ($exit_object) 2326=item $player_object->enter_exit ($exit_object)
1868 2327
1907 2366
1908 $rmp->{random_seed} ||= $exit->random_seed; 2367 $rmp->{random_seed} ||= $exit->random_seed;
1909 2368
1910 my $data = cf::to_json $rmp; 2369 my $data = cf::to_json $rmp;
1911 my $md5 = Digest::MD5::md5_hex $data; 2370 my $md5 = Digest::MD5::md5_hex $data;
1912 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2371 my $meta = "$RANDOMDIR/$md5.meta";
1913 2372
1914 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2373 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1915 aio_write $fh, 0, (length $data), $data, 0; 2374 aio_write $fh, 0, (length $data), $data, 0;
1916 undef $fh; 2375 undef $fh;
1917 aio_rename "$meta~", $meta; 2376 aio_rename "$meta~", $meta;
1926 2385
1927 return unless $self->type == cf::PLAYER; 2386 return unless $self->type == cf::PLAYER;
1928 2387
1929 if ($exit->slaying eq "/!") { 2388 if ($exit->slaying eq "/!") {
1930 #TODO: this should de-fi-ni-te-ly not be a sync-job 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
1931 cf::sync_job { prepare_random_map $exit }; 2392 cf::sync_job { prepare_random_map $exit };
1932 } 2393 }
1933 2394
1934 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2395 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1935 my $hp = $exit->stats->hp; 2396 my $hp = $exit->stats->hp;
1936 my $sp = $exit->stats->sp; 2397 my $sp = $exit->stats->sp;
1937 2398
1938 $self->enter_link; 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);
1939 2404
1940 (async { 2405 (async {
1941 $self->deactivate_recursive; # just to be sure 2406 $self->deactivate_recursive; # just to be sure
1942 unless (eval { 2407 unless (eval {
1943 $self->goto ($slaying, $hp, $sp); 2408 $self->goto ($slaying, $hp, $sp);
1944 2409
1945 1; 2410 1;
1946 }) { 2411 }) {
1947 $self->message ("Something went wrong deep within the crossfire server. " 2412 $self->message ("Something went wrong deep within the crossfire server. "
1948 . "I'll try to bring you back to the map you were before. " 2413 . "I'll try to bring you back to the map you were before. "
1949 . "Please report this to the dungeon master!", 2414 . "Please report this to the dungeon master!",
1950 cf::NDI_UNIQUE | cf::NDI_RED); 2415 cf::NDI_UNIQUE | cf::NDI_RED);
1951 2416
1952 warn "ERROR in enter_exit: $@"; 2417 warn "ERROR in enter_exit: $@";
1953 $self->leave_link; 2418 $self->leave_link;
1954 } 2419 }
1955 })->prio (1); 2420 })->prio (1);
1968 2433
1969sub cf::client::send_drawinfo { 2434sub cf::client::send_drawinfo {
1970 my ($self, $text, $flags) = @_; 2435 my ($self, $text, $flags) = @_;
1971 2436
1972 utf8::encode $text; 2437 utf8::encode $text;
1973 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2438 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1974} 2439}
1975 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}
1976 2507
1977=item $success = $client->query ($flags, "text", \&cb) 2508=item $success = $client->query ($flags, "text", \&cb)
1978 2509
1979Queues a query to the client, calling the given callback with 2510Queues a query to the client, calling the given callback with
1980the 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>,
1981C<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>.
1982 2513
1983Queries 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
1984reliable at some point in the future. 2515become reliable at some point in the future.
1985 2516
1986=cut 2517=cut
1987 2518
1988sub cf::client::query { 2519sub cf::client::query {
1989 my ($self, $flags, $text, $cb) = @_; 2520 my ($self, $flags, $text, $cb) = @_;
1997 utf8::encode $text; 2528 utf8::encode $text;
1998 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2529 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1999 2530
2000 $self->send_packet ($self->{query_queue}[0][0]) 2531 $self->send_packet ($self->{query_queue}[0][0])
2001 if @{ $self->{query_queue} } == 1; 2532 if @{ $self->{query_queue} } == 1;
2533
2534 1
2002} 2535}
2003 2536
2004cf::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 },
2005 on_reply => sub { 2543 on_reply => sub {
2006 my ($ns, $msg) = @_; 2544 my ($ns, $msg) = @_;
2007 2545
2008 # this weird shuffling is so that direct followup queries 2546 # this weird shuffling is so that direct followup queries
2009 # get handled first 2547 # get handled first
2021 } else { 2559 } else {
2022 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2560 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2023 } 2561 }
2024 } 2562 }
2025 }, 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 },
2026); 2582);
2027 2583
2028=item $client->async (\&cb) 2584=item $client->async (\&cb)
2029 2585
2030Create a new coroutine, running the specified callback. The coroutine will 2586Create a new coroutine, running the specified callback. The coroutine will
2077 2633
2078# here we export the classes and methods available to script code 2634# here we export the classes and methods available to script code
2079 2635
2080=pod 2636=pod
2081 2637
2082The following fucntions and emthods are available within a safe environment: 2638The following functions and methods are available within a safe environment:
2083 2639
2084 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
2085 cf::object::player player 2644 cf::object::player
2086 cf::player peaceful 2645 player
2087 cf::map trigger 2646
2647 cf::player
2648 peaceful
2649
2650 cf::map
2651 trigger
2088 2652
2089=cut 2653=cut
2090 2654
2091for ( 2655for (
2092 ["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)],
2093 ["cf::object::player" => qw(player)], 2658 ["cf::object::player" => qw(player)],
2094 ["cf::player" => qw(peaceful)], 2659 ["cf::player" => qw(peaceful)],
2095 ["cf::map" => qw(trigger)], 2660 ["cf::map" => qw(trigger)],
2096) { 2661) {
2097 no strict 'refs'; 2662 no strict 'refs';
2168=back 2733=back
2169 2734
2170=cut 2735=cut
2171 2736
2172############################################################################# 2737#############################################################################
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 2738# the server's init and main functions
2246 2739
2247sub init_resources { 2740sub load_facedata($) {
2248 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2741 my ($path) = @_;
2742
2743 warn "loading facedata from $path\n";
2744
2745 my $facedata;
2746 0 < aio_load $path, $facedata
2747 or die "$path: $!";
2748
2749 $facedata = Coro::Storable::thaw $facedata;
2750
2751 $facedata->{version} == 2
2752 or cf::cleanup "$path: version mismatch, cannot proceed.";
2753
2754 {
2755 my $faces = $facedata->{faceinfo};
2756
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};
2763
2764 cf::cede_to_tick;
2765 }
2766
2767 while (my ($face, $info) = each %$faces) {
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"
2249 or die "unable to load regions file\n";#d# 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;
2250} 2870}
2251 2871
2252sub cfg_load { 2872sub cfg_load {
2253 open my $fh, "<:utf8", cf::confdir . "/config" 2873 open my $fh, "<:utf8", "$CONFDIR/config"
2254 or return; 2874 or return;
2255 2875
2256 local $/; 2876 local $/;
2257 *CFG = YAML::Syck::Load <$fh>; 2877 *CFG = YAML::Syck::Load <$fh>;
2258 2878
2266 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2886 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2267 and die "WARNING: m(un)lockall failed: $!\n"; 2887 and die "WARNING: m(un)lockall failed: $!\n";
2268 }; 2888 };
2269 warn $@ if $@; 2889 warn $@ if $@;
2270 } 2890 }
2271}
2272
2273sub init {
2274 init_resources;
2275} 2891}
2276 2892
2277sub main { 2893sub main {
2278 # we must not ever block the main coroutine 2894 # we must not ever block the main coroutine
2279 local $Coro::idle = sub { 2895 local $Coro::idle = sub {
2307 }, 2923 },
2308 ); 2924 );
2309 } 2925 }
2310} 2926}
2311 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
2312sub emergency_save() { 2966sub emergency_save() {
2313 my $freeze_guard = cf::freeze_mainloop; 2967 my $freeze_guard = cf::freeze_mainloop;
2314 2968
2315 warn "enter emergency perl save\n"; 2969 warn "enter emergency perl save\n";
2316 2970
2347 3001
2348 warn Carp::longmess "post_cleanup backtrace" 3002 warn Carp::longmess "post_cleanup backtrace"
2349 if $make_core; 3003 if $make_core;
2350} 3004}
2351 3005
2352sub reload() { 3006sub do_reload_perl() {
2353 # can/must only be called in main 3007 # can/must only be called in main
2354 if ($Coro::current != $Coro::main) { 3008 if ($Coro::current != $Coro::main) {
2355 warn "can only reload from main coroutine"; 3009 warn "can only reload from main coroutine";
2356 return; 3010 return;
2357 } 3011 }
2382 Coro::cede; 3036 Coro::cede;
2383 last unless IO::AIO::nreqs || BDB::nreqs; 3037 last unless IO::AIO::nreqs || BDB::nreqs;
2384 warn "iterate..."; 3038 warn "iterate...";
2385 } 3039 }
2386 3040
3041 ++$RELOAD;
3042
2387 warn "cancelling all extension coros"; 3043 warn "cancelling all extension coros";
2388 $_->cancel for values %EXT_CORO; 3044 $_->cancel for values %EXT_CORO;
2389 %EXT_CORO = (); 3045 %EXT_CORO = ();
2390 3046
2391 warn "removing commands"; 3047 warn "removing commands";
2392 %COMMAND = (); 3048 %COMMAND = ();
2393 3049
2394 warn "removing ext commands"; 3050 warn "removing ext/exti commands";
2395 %EXTCMD = (); 3051 %EXTCMD = ();
3052 %EXTICMD = ();
2396 3053
2397 warn "unloading/nuking all extensions"; 3054 warn "unloading/nuking all extensions";
2398 for my $pkg (@EXTS) { 3055 for my $pkg (@EXTS) {
2399 warn "... unloading $pkg"; 3056 warn "... unloading $pkg";
2400 3057
2430 Symbol::delete_package "safe::$_" 3087 Symbol::delete_package "safe::$_"
2431 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);
2432 3089
2433 warn "unloading cf.pm \"a bit\""; 3090 warn "unloading cf.pm \"a bit\"";
2434 delete $INC{"cf.pm"}; 3091 delete $INC{"cf.pm"};
3092 delete $INC{"cf/pod.pm"};
2435 3093
2436 # don't, removes xs symbols, too, 3094 # don't, removes xs symbols, too,
2437 # and global variables created in xs 3095 # and global variables created in xs
2438 #Symbol::delete_package __PACKAGE__; 3096 #Symbol::delete_package __PACKAGE__;
2439 3097
2448 3106
2449 warn "loading extensions"; 3107 warn "loading extensions";
2450 cf::load_extensions; 3108 cf::load_extensions;
2451 3109
2452 warn "reattaching attachments to objects/players"; 3110 warn "reattaching attachments to objects/players";
2453 _global_reattach; 3111 _global_reattach; # objects, sockets
2454 warn "reattaching attachments to maps"; 3112 warn "reattaching attachments to maps";
2455 reattach $_ for values %MAP; 3113 reattach $_ for values %MAP;
2456 3114 warn "reattaching attachments to players";
2457 warn "loading reloadable resources"; 3115 reattach $_ for values %PLAYER;
2458 init_resources;
2459 3116
2460 warn "leaving sync_job"; 3117 warn "leaving sync_job";
2461 3118
2462 1 3119 1
2463 } or do { 3120 } or do {
2469 warn "reloaded"; 3126 warn "reloaded";
2470}; 3127};
2471 3128
2472our $RELOAD_WATCHER; # used only during reload 3129our $RELOAD_WATCHER; # used only during reload
2473 3130
3131sub reload_perl() {
3132 # doing reload synchronously and two reloads happen back-to-back,
3133 # coro crashes during coro_state_free->destroy here.
3134
3135 $RELOAD_WATCHER ||= Event->timer (
3136 reentrant => 0,
3137 after => 0,
3138 data => WF_AUTOCANCEL,
3139 cb => sub {
3140 do_reload_perl;
3141 undef $RELOAD_WATCHER;
3142 },
3143 );
3144}
3145
2474register_command "reload" => sub { 3146register_command "reload" => sub {
2475 my ($who, $arg) = @_; 3147 my ($who, $arg) = @_;
2476 3148
2477 if ($who->flag (FLAG_WIZ)) { 3149 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("reloading server."); 3150 $who->message ("reloading server.");
2479 3151 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 } 3152 }
2493}; 3153};
2494 3154
2495unshift @INC, $LIBDIR; 3155unshift @INC, $LIBDIR;
2496 3156
2497my $bug_warning = 0; 3157my $bug_warning = 0;
2498 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;
2499$TICK_WATCHER = Event->timer ( 3182$TICK_WATCHER = Event->timer (
2500 reentrant => 0, 3183 reentrant => 0,
2501 parked => 1, 3184 parked => 1,
2502 prio => 0, 3185 prio => 0,
2503 at => $NEXT_TICK || $TICK, 3186 at => $NEXT_TICK || $TICK,
2507 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3190 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508 unless ++$bug_warning > 10; 3191 unless ++$bug_warning > 10;
2509 return; 3192 return;
2510 } 3193 }
2511 3194
2512 $NOW = Event::time; 3195 $NOW = $tick_start = Event::time;
2513 3196
2514 cf::server_tick; # one server iteration 3197 cf::server_tick; # one server iteration
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
3220 };
3221
2515 $RUNTIME += $TICK; 3222 $RUNTIME += $TICK;
2516 $NEXT_TICK += $TICK; 3223 $NEXT_TICK += $TICK;
2517 3224
2518 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3225 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519 $NEXT_RUNTIME_WRITE = $NOW + 10; 3226 $NEXT_RUNTIME_WRITE = $NOW + 10;
2521 write_runtime 3228 write_runtime
2522 or warn "ERROR: unable to write runtime file: $!"; 3229 or warn "ERROR: unable to write runtime file: $!";
2523 }; 3230 };
2524 } 3231 }
2525 3232
2526
2527 $WAIT_FOR_TICK->broadcast;
2528 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2529
2530# my $AFTER = Event::time; 3233# my $AFTER = Event::time;
2531# warn $AFTER - $NOW;#d# 3234# warn $AFTER - $NOW;#d#
2532 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
2533 # 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
2534 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3246 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2535 3247
2536 $TICK_WATCHER->at ($NEXT_TICK); 3248 $TICK_WATCHER->at ($NEXT_TICK);
2537 $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
2538 }, 3257 },
2539); 3258);
2540 3259
2541{ 3260{
2542 BDB::max_poll_time $TICK * 0.1; 3261 BDB::max_poll_time $TICK * 0.1;
2570 3289
2571 cf::sync_job { 3290 cf::sync_job {
2572 eval { 3291 eval {
2573 BDB::db_env_open 3292 BDB::db_env_open
2574 $DB_ENV, 3293 $DB_ENV,
2575 $BDB_ENV_DIR, 3294 $BDBDIR,
2576 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3295 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2577 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3296 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2578 0666; 3297 0666;
2579 3298
2580 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3299 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2581 3300
2582 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3301 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2583 $DB_ENV->set_lk_detect; 3302 $DB_ENV->set_lk_detect;
2584 }; 3303 };
2585 3304
2601 prio => 6, 3320 prio => 6,
2602 cb => \&IO::AIO::poll_cb, 3321 cb => \&IO::AIO::poll_cb,
2603 ); 3322 );
2604} 3323}
2605 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
2606END { cf::emergency_save } 3366END { cf::emergency_save }
2607 3367
26081 33681
2609 3369

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines