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.219 by root, Sat Feb 17 03:19:44 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 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 $guard = cf::lock_acquire "write_runtime";
360 413
361 my $runtime = cf::localdir . "/runtime"; 414Executes the given code block with the given arguments in a seperate
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.
362 418
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 419=cut
364 or return;
365 420
366 my $value = $cf::RUNTIME + 90 + 10; 421sub _store_scalar {
367 # 10 is the runtime save interval, for a monotonic clock 422 open my $fh, ">", \my $buf
368 # 60 allows for the watchdog to kill the server. 423 or die "fork_call: cannot open fh-to-buf in child : $!";
369 424 Storable::store_fd $_[0], $fh;
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0
371 and return;
372
373 # always fsync - this file is important
374 aio_fsync $fh
375 and return;
376
377 close $fh 425 close $fh;
378 or return;
379 426
380 aio_rename "$runtime~", $runtime 427 $buf
381 and return; 428}
382 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;
383 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 });
384} 599}
385 600
386=back 601=back
387 602
388=cut 603=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 610attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
397 612
398In 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>
399C<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
400crossfire+). 615Crossfire TRT).
401 616
402=over 4 617=over 4
403 618
404=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
405 620
568 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
569 784
570 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 789
575 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 791 my $pkg = shift @arg;
577 792
578 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
608 } 823 }
609 824
610 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
611 } else { 826 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 828 }
614 829
615 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
616} 831}
617 832
619 if (ref $_[0]) { 834 if (ref $_[0]) {
620 _object_attach @_; 835 _object_attach @_;
621 } else { 836 } else {
622 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
623 } 838 }
839 _recalc_want;
624}; 840};
625 841
626# all those should be optimised 842# all those should be optimised
627sub cf::attachable::detach { 843sub cf::attachable::detach {
628 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
632 reattach ($obj); 848 reattach ($obj);
633 } else { 849 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
635 } 851 }
852 _recalc_want;
636}; 853};
637 854
638sub cf::attachable::attached { 855sub cf::attachable::attached {
639 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
640 857
655 "; 872 ";
656 die if $@; 873 die if $@;
657} 874}
658 875
659our $override; 876our $override;
660our @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?
661 878
662sub override { 879sub override {
663 $override = 1; 880 $override = 1;
664 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
665} 882}
666 883
667sub do_invoke { 884sub do_invoke {
668 my $event = shift; 885 my $event = shift;
669 my $callbacks = shift; 886 my $callbacks = shift;
670 887
671 @invoke_results = (); 888 @INVOKE_RESULTS = ();
672 889
673 local $override; 890 local $override;
674 891
675 for (@$callbacks) { 892 for (@$callbacks) {
676 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
693 910
694Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
695 912
696This 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
697removed 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
698results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 916
700=back 917=back
701 918
702=cut 919=cut
703 920
813 or return; 1030 or return;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1032 }
816 1033
817 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
819 return ($data, $av); 1036 return ($data, $av);
820} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
821 1044
822############################################################################# 1045#############################################################################
823# command handling &c 1046# command handling &c
824 1047
825=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1062}
840 1063
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1065
843Register 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.
844 1071
845If 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
846called. 1073called.
847 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
848=cut 1086=cut
849 1087
850sub register_extcmd { 1088sub register_extcmd {
851 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
852 1090
853 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
854} 1098}
855 1099
856cf::player->attach ( 1100cf::player->attach (
857 on_command => sub { 1101 on_command => sub {
858 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
867 cf::override; 1111 cf::override;
868 }, 1112 },
869 on_extcmd => sub { 1113 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
871 1115
872 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1117
874 if (ref $msg) { 1118 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
883 1127
884 cf::override; 1128 cf::override;
885 }, 1129 },
886); 1130);
887 1131
888sub load_extension {
889 my ($path) = @_;
890
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
892 my $base = $1;
893 my $pkg = $1;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
918
919 push @EXTS, $pkg;
920}
921
922sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
923 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1137 next unless -r $path;
925 eval { 1138
926 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;
927 1 1196 }
928 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
929 } 1202 };
930} 1203}
931 1204
932############################################################################# 1205#############################################################################
933 1206
1207=back
1208
934=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
935 1210
936Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
937 1212
938=cut 1213=cut
950Returns the given player object, loading it if necessary (might block). 1225Returns the given player object, loading it if necessary (might block).
951 1226
952=cut 1227=cut
953 1228
954sub playerdir($) { 1229sub playerdir($) {
955 cf::localdir 1230 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1231 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1232}
961 1233
962sub path($) { 1234sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1235 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1236
965 (playerdir $login) . "/$login.pl" 1237 (playerdir $login) . "/playerdata"
966} 1238}
967 1239
968sub find_active($) { 1240sub find_active($) {
969 $cf::PLAYER{$_[0]} 1241 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1242 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1255 my $login = $_[0];
984 1256
985 my $guard = cf::lock_acquire "user_find:$login"; 1257 my $guard = cf::lock_acquire "user_find:$login";
986 1258
987 $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
988 my $pl = load_pl path $login 1267 my $pl = load_pl path $login
989 or return; 1268 or return;
990 $cf::PLAYER{$login} = $pl 1269 $cf::PLAYER{$login} = $pl
991 } 1270 }
992 } 1271 }
1029 1308
1030=cut 1309=cut
1031 1310
1032sub quit_character { 1311sub quit_character {
1033 my ($pl) = @_; 1312 my ($pl) = @_;
1313
1314 my $name = $pl->ob->name;
1034 1315
1035 $pl->{deny_save} = 1; 1316 $pl->{deny_save} = 1;
1036 $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
1037 1318
1038 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1319 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1043 my $path = playerdir $pl; 1324 my $path = playerdir $pl;
1044 my $temp = "$path~$cf::RUNTIME~deleting~"; 1325 my $temp = "$path~$cf::RUNTIME~deleting~";
1045 aio_rename $path, $temp; 1326 aio_rename $path, $temp;
1046 delete $cf::PLAYER{$pl->ob->name}; 1327 delete $cf::PLAYER{$pl->ob->name};
1047 $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
1048 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;
1049} 1350}
1050 1351
1051=item cf::player::list_logins 1352=item cf::player::list_logins
1052 1353
1053Returns 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
1054while and may block, so not sync_job-capable, ever. 1355while and may block, so not sync_job-capable, ever.
1055 1356
1056=cut 1357=cut
1057 1358
1058sub list_logins { 1359sub list_logins {
1059 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1360 my $dirs = aio_readdir $PLAYERDIR
1060 or return []; 1361 or return [];
1061 1362
1062 my @logins; 1363 my @logins;
1063 1364
1064 for my $login (@$dirs) { 1365 for my $login (@$dirs) {
1099 } 1400 }
1100 1401
1101 \@paths 1402 \@paths
1102} 1403}
1103 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
1104=item $player->ext_reply ($msgid, $msgtype, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1105 1456
1106Sends an ext reply to the player. 1457Sends an ext reply to the player.
1107 1458
1108=cut 1459=cut
1109 1460
1110sub ext_reply($$$%) { 1461sub ext_reply($$%) {
1111 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1112 1463
1113 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1114 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1115 $self->send ("ext " . cf::to_json \%msg);
1116} 1466}
1117 1467
1118package 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}
1119 1508
1120=back 1509=back
1121
1122 1510
1123=head3 cf::map 1511=head3 cf::map
1124 1512
1125=over 4 1513=over 4
1126 1514
1181 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1182 1570
1183 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1184 local $self->{path}; 1572 local $self->{path};
1185 local $self->{load_path}; 1573 local $self->{load_path};
1186 local $self->{deny_save};
1187 local $self->{deny_reset};
1188 1574
1189 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1190} 1576}
1191 1577
1192sub normalise { 1578sub normalise {
1239 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1240 return $self; 1626 return $self;
1241 } 1627 }
1242 } 1628 }
1243 1629
1244 Carp::carp "unable to resolve path '$path' (base '$base')."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1245 () 1631 ()
1246} 1632}
1247 1633
1248sub init { 1634sub init {
1249 my ($self) = @_; 1635 my ($self) = @_;
1264 1650
1265# the original (read-only) location 1651# the original (read-only) location
1266sub load_path { 1652sub load_path {
1267 my ($self) = @_; 1653 my ($self) = @_;
1268 1654
1269 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1655 "$MAPDIR/$self->{path}.map"
1270} 1656}
1271 1657
1272# the temporary/swap location 1658# the temporary/swap location
1273sub save_path { 1659sub save_path {
1274 my ($self) = @_; 1660 my ($self) = @_;
1275 1661
1276 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1662 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1663 "$TMPDIR/$path.map"
1278} 1664}
1279 1665
1280# the unique path, undef == no special unique path 1666# the unique path, undef == no special unique path
1281sub uniq_path { 1667sub uniq_path {
1282 my ($self) = @_; 1668 my ($self) = @_;
1283 1669
1284 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1670 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1671 "$UNIQUEDIR/$path"
1286} 1672}
1287 1673
1288# and all this just because we cannot iterate over 1674# and all this just because we cannot iterate over
1289# all maps in C++... 1675# all maps in C++...
1290sub change_all_map_light { 1676sub change_all_map_light {
1291 my ($change) = @_; 1677 my ($change) = @_;
1292 1678
1293 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1294 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;
1295} 1689}
1296 1690
1297sub unlink_save { 1691sub unlink_save {
1298 my ($self) = @_; 1692 my ($self) = @_;
1299 1693
1357 $self->load_header_orig 1751 $self->load_header_orig
1358 or return; 1752 or return;
1359 $self->prepare_orig; 1753 $self->prepare_orig;
1360 } 1754 }
1361 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
1362 1 1762 1
1363} 1763}
1364 1764
1365sub find; 1765sub find;
1366sub find { 1766sub find {
1378 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1379 1779
1380 $map->load_header 1780 $map->load_header
1381 or return; 1781 or return;
1382 1782
1383 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1384 # doing this can freeze the server in a sync job, obviously 1784 # doing this can freeze the server in a sync job, obviously
1385 #$cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1386 $map->reset; 1786 $map->reset;
1387 undef $guard; 1787 undef $guard;
1388 return find $path; 1788 return find $path;
1399 my ($self) = @_; 1799 my ($self) = @_;
1400 1800
1401 local $self->{deny_reset} = 1; # loading can take a long time 1801 local $self->{deny_reset} = 1; # loading can take a long time
1402 1802
1403 my $path = $self->{path}; 1803 my $path = $self->{path};
1804
1805 {
1404 my $guard = cf::lock_acquire "map_load:$path"; 1806 my $guard = cf::lock_acquire "map_load:$path";
1405 1807
1406 return if $self->in_memory != cf::MAP_SWAPPED; 1808 return if $self->in_memory != cf::MAP_SWAPPED;
1407 1809
1408 $self->in_memory (cf::MAP_LOADING); 1810 $self->in_memory (cf::MAP_LOADING);
1409 1811
1410 $self->alloc; 1812 $self->alloc;
1411 1813
1412 $self->pre_load; 1814 $self->pre_load;
1413
1414 $self->_load_objects ($self->{load_path}, 1)
1415 or return;
1416
1417 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1418 if delete $self->{load_original};
1419
1420 if (my $uniq = $self->uniq_path) {
1421 utf8::encode $uniq;
1422 if (aio_open $uniq, O_RDONLY, 0) {
1423 $self->clear_unique_items;
1424 $self->_load_objects ($uniq, 0);
1425 }
1426 }
1427
1428 Coro::cede;
1429
1430 # now do the right thing for maps
1431 $self->link_multipart_objects;
1432
1433 unless ($self->{deny_activate}) {
1434 $self->decay_objects;
1435 $self->fix_auto_apply;
1436 $self->update_buttons;
1437 Coro::cede; 1815 Coro::cede;
1438 $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;
1439 $self->difficulty ($self->estimate_difficulty) 1834 $self->difficulty ($self->estimate_difficulty)
1440 unless $self->difficulty; 1835 unless $self->difficulty;
1441 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;
1442 $self->activate; 1845 $self->activate;
1846 }
1847
1848 $self->in_memory (cf::MAP_IN_MEMORY);
1443 } 1849 }
1444 1850
1445 $self->post_load; 1851 $self->post_load;
1446
1447 $self->in_memory (cf::MAP_IN_MEMORY);
1448} 1852}
1449 1853
1450sub customise_for { 1854sub customise_for {
1451 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1452 1856
1453 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1454 if $self->per_player; 1858 if $self->per_player;
1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1455 1862
1456 $self 1863 $self
1457} 1864}
1458 1865
1459# 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
1506 1913
1507 undef $MAP_PREFETCH{$path}; 1914 undef $MAP_PREFETCH{$path};
1508 $MAP_PREFETCHER ||= cf::async { 1915 $MAP_PREFETCHER ||= cf::async {
1509 while (%MAP_PREFETCH) { 1916 while (%MAP_PREFETCH) {
1510 for my $path (keys %MAP_PREFETCH) { 1917 for my $path (keys %MAP_PREFETCH) {
1511 my $map = find $path 1918 if (my $map = find $path) {
1512 or next;
1513 $map->load; 1919 $map->load;
1920 }
1514 1921
1515 delete $MAP_PREFETCH{$path}; 1922 delete $MAP_PREFETCH{$path};
1516 } 1923 }
1517 } 1924 }
1518 undef $MAP_PREFETCHER; 1925 undef $MAP_PREFETCHER;
1570 1977
1571sub reset_at { 1978sub reset_at {
1572 my ($self) = @_; 1979 my ($self) = @_;
1573 1980
1574 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1575 return 1e99 if $self->isa ("ext::map_per_player");#d#
1576 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1577 1983
1578 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1579 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;
1580 1986
1591 my ($self) = @_; 1997 my ($self) = @_;
1592 1998
1593 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1594 2000
1595 return if $self->players; 2001 return if $self->players;
1596 return if $self->isa ("ext::map_per_player");#d#
1597 2002
1598 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
1599 2004
1600 $self->in_memory (cf::MAP_SWAPPED); 2005 $self->in_memory (cf::MAP_SWAPPED);
1601 2006
1602 # need to save uniques path 2007 # need to save uniques path
1603 unless ($self->{deny_save}) { 2008 unless ($self->{deny_save}) {
1635 $cf::MAP{$self->path} = $self; 2040 $cf::MAP{$self->path} = $self;
1636 2041
1637 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
1638} 2043}
1639 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
1640=item cf::map::unique_maps 2081=item cf::map::unique_maps
1641 2082
1642Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1643instantiated unique items. May block. 2084instantiated unique items. May block.
1644 2085
1645=cut 2086=cut
1646 2087
1647sub unique_maps() { 2088sub unique_maps() {
1648 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2089 [
1649 or return; 2090 map {
1650
1651 my @paths;
1652
1653 for (@$files) {
1654 utf8::decode $_; 2091 utf8::decode $_;
1655 next if /\.pst$/; 2092 /\.map$/
1656 next unless /^$PATH_SEP/o; 2093 ? normalise $_
1657 2094 : ()
1658 push @paths, cf::map::normalise $_; 2095 } @{ aio_readdir $UNIQUEDIR or [] }
1659 } 2096 ]
1660
1661 \@paths
1662} 2097}
1663 2098
1664package cf; 2099package cf;
1665 2100
1666=back 2101=back
1712 2147
1713 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1714 2149
1715 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1716 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1717 } 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 {
1718 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1719 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1720 } 2169 }
1721} 2170}
1722 2171
1723=item $player_object->may ("access") 2172=item $player_object->may ("access")
1724 2173
1772 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1773 2222
1774 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1775 2224
1776 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1777 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1778 2227
1779 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1780} 2229}
1781 2230
1782sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1783 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1784 2235
1785 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1786 2237
1787 unless ($map) { 2238 unless ($map) {
1788 # restore original map position 2239 # restore original map position
1811 2262
1812 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1814} 2265}
1815 2266
1816cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2268
1820 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1824 }; 2273be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2274
1830 # try to abort aborted map switching on player login :)
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 $pl->ob->reply (undef,
1836 "There was an internal problem at your last logout, "
1837 . "the server will try to bring you to your intended destination in a second.",
1838 cf::NDI_RED);
1839 # we need this sleep as the login has a concurrent enter_exit running
1840 # and this sleep increases chances of the player not ending up in scorn
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut 2275=cut
2276
2277our $GOTOGEN;
1851 2278
1852sub cf::object::player::goto { 2279sub cf::object::player::goto {
1853 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;
1854 2284
1855 $self->enter_link; 2285 $self->enter_link;
1856 2286
1857 (async { 2287 (async {
1858 my $map = eval { 2288 my $map = eval {
1859 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1860 $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
1861 $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 $@;
1862 } or 2304 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1866 })->prio (1); 2312 })->prio (1);
1867} 2313}
1868 2314
1869=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1870 2316
1909 2355
1910 $rmp->{random_seed} ||= $exit->random_seed; 2356 $rmp->{random_seed} ||= $exit->random_seed;
1911 2357
1912 my $data = cf::to_json $rmp; 2358 my $data = cf::to_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data; 2359 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2360 my $meta = "$RANDOMDIR/$md5.meta";
1915 2361
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2362 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2363 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2364 undef $fh;
1919 aio_rename "$meta~", $meta; 2365 aio_rename "$meta~", $meta;
1928 2374
1929 return unless $self->type == cf::PLAYER; 2375 return unless $self->type == cf::PLAYER;
1930 2376
1931 if ($exit->slaying eq "/!") { 2377 if ($exit->slaying eq "/!") {
1932 #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
1933 cf::sync_job { prepare_random_map $exit }; 2381 cf::sync_job { prepare_random_map $exit };
1934 } 2382 }
1935 2383
1936 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;
1937 my $hp = $exit->stats->hp; 2385 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp; 2386 my $sp = $exit->stats->sp;
1939 2387
1940 $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);
1941 2393
1942 (async { 2394 (async {
1943 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
1944 unless (eval { 2396 unless (eval {
1945 $self->goto ($slaying, $hp, $sp); 2397 $self->goto ($slaying, $hp, $sp);
1946 2398
1947 1; 2399 1;
1948 }) { 2400 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2401 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "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. "
1951 . "Please report this to the dungeon master!", 2403 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2404 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2405
1954 warn "ERROR in enter_exit: $@"; 2406 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2407 $self->leave_link;
1956 } 2408 }
1957 })->prio (1); 2409 })->prio (1);
1970 2422
1971sub cf::client::send_drawinfo { 2423sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2424 my ($self, $text, $flags) = @_;
1973 2425
1974 utf8::encode $text; 2426 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2428}
1977 2429
2430=item $client->send_msg ($color, $type, $msg, [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, $color, $type, $msg, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 if ($self->can_msg) {
2447 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2448 } else {
2449 # replace some tags by gcfclient-compatible ones
2450 for ($msg) {
2451 1 while
2452 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2453 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2454 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2455 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2456 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2457 }
2458
2459 if ($color >= 0) {
2460 if (0 && $msg =~ /\[/) {
2461 $self->send_packet ("drawextinfo $color 4 0 $msg")
2462 } else {
2463 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2464 $self->send_packet ("drawinfo $color $msg")
2465 }
2466 }
2467 }
2468}
2469
2470=item $client->ext_event ($type, %msg)
2471
2472Sends an ext event to the client.
2473
2474=cut
2475
2476sub cf::client::ext_event($$%) {
2477 my ($self, $type, %msg) = @_;
2478
2479 return unless $self->extcmd;
2480
2481 $msg{msgtype} = "event_$type";
2482 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2483}
1978 2484
1979=item $success = $client->query ($flags, "text", \&cb) 2485=item $success = $client->query ($flags, "text", \&cb)
1980 2486
1981Queues a query to the client, calling the given callback with 2487Queues a query to the client, calling the given callback with
1982the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2488the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2489C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984 2490
1985Queries can fail, so check the return code. Or don't, as queries will become 2491Queries can fail, so check the return code. Or don't, as queries will
1986reliable at some point in the future. 2492become reliable at some point in the future.
1987 2493
1988=cut 2494=cut
1989 2495
1990sub cf::client::query { 2496sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2497 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2505 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2506 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2507
2002 $self->send_packet ($self->{query_queue}[0][0]) 2508 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2509 if @{ $self->{query_queue} } == 1;
2510
2511 1
2004} 2512}
2005 2513
2006cf::client->attach ( 2514cf::client->attach (
2515 on_connect => sub {
2516 my ($ns) = @_;
2517
2518 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2519 },
2007 on_reply => sub { 2520 on_reply => sub {
2008 my ($ns, $msg) = @_; 2521 my ($ns, $msg) = @_;
2009 2522
2010 # this weird shuffling is so that direct followup queries 2523 # this weird shuffling is so that direct followup queries
2011 # get handled first 2524 # get handled first
2023 } else { 2536 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2537 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 2538 }
2026 } 2539 }
2027 }, 2540 },
2541 on_exticmd => sub {
2542 my ($ns, $buf) = @_;
2543
2544 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2545
2546 if (ref $msg) {
2547 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2548 if (my %reply = $cb->($ns, $msg)) {
2549 $reply{msgid} = $msg->{msgid};
2550 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2551 }
2552 }
2553 } else {
2554 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2555 }
2556
2557 cf::override;
2558 },
2028); 2559);
2029 2560
2030=item $client->async (\&cb) 2561=item $client->async (\&cb)
2031 2562
2032Create a new coroutine, running the specified callback. The coroutine will 2563Create a new coroutine, running the specified callback. The coroutine will
2079 2610
2080# here we export the classes and methods available to script code 2611# here we export the classes and methods available to script code
2081 2612
2082=pod 2613=pod
2083 2614
2084The following fucntions and emthods are available within a safe environment: 2615The following functions and methods are available within a safe environment:
2085 2616
2086 cf::object contr pay_amount pay_player map 2617 cf::object
2618 contr pay_amount pay_player map x y force_find force_add
2619 insert remove
2620
2087 cf::object::player player 2621 cf::object::player
2088 cf::player peaceful 2622 player
2089 cf::map trigger 2623
2624 cf::player
2625 peaceful
2626
2627 cf::map
2628 trigger
2090 2629
2091=cut 2630=cut
2092 2631
2093for ( 2632for (
2094 ["cf::object" => qw(contr pay_amount pay_player map)], 2633 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2634 insert remove)],
2095 ["cf::object::player" => qw(player)], 2635 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 2636 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 2637 ["cf::map" => qw(trigger)],
2098) { 2638) {
2099 no strict 'refs'; 2639 no strict 'refs';
2170=back 2710=back
2171 2711
2172=cut 2712=cut
2173 2713
2174############################################################################# 2714#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $value = cf::db_get $family => $key
2188
2189Returns a single value from the database.
2190
2191=item cf::db_put $family => $key => $value
2192
2193Stores the given C<$value> in the family.
2194
2195=cut
2196
2197our $DB;
2198
2199sub db_init {
2200 unless ($DB) {
2201 $DB = BDB::db_create $DB_ENV;
2202
2203 cf::sync_job {
2204 eval {
2205 $DB->set_flags (BDB::CHKSUM);
2206
2207 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2208 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2209 cf::cleanup "db_open(db): $!" if $!;
2210 };
2211 cf::cleanup "db_open(db): $@" if $@;
2212 };
2213
2214 my $path = cf::localdir . "/database.pst";
2215 if (stat $path) {
2216 cf::sync_job {
2217 my $pst = Storable::retrieve $path;
2218
2219 cf::db_put (board => data => $pst->{board});
2220 cf::db_put (guildrules => data => $pst->{guildrules});
2221 cf::db_put (rent => balance => $pst->{rent}{balance});
2222 BDB::db_env_txn_checkpoint $DB_ENV;
2223
2224 unlink $path;
2225 };
2226 }
2227 }
2228}
2229
2230sub db_get($$) {
2231 my $key = "$_[0]/$_[1]";
2232
2233 cf::sync_job {
2234 BDB::db_get $DB, undef, $key, my $data;
2235
2236 $! ? ()
2237 : Compress::LZF::sthaw $data
2238 }
2239}
2240
2241sub db_put($$$) {
2242 BDB::dbreq_pri 4;
2243 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2244}
2245
2246#############################################################################
2247# the server's init and main functions 2715# the server's init and main functions
2248 2716
2249sub init_resources { 2717sub load_facedata($) {
2250 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2718 my ($path) = @_;
2719
2720 warn "loading facedata from $path\n";
2721
2722 my $facedata;
2723 0 < aio_load $path, $facedata
2724 or die "$path: $!";
2725
2726 $facedata = Coro::Storable::thaw $facedata;
2727
2728 $facedata->{version} == 2
2729 or cf::cleanup "$path: version mismatch, cannot proceed.";
2730
2731 {
2732 my $faces = $facedata->{faceinfo};
2733
2734 while (my ($face, $info) = each %$faces) {
2735 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2736 cf::face::set_visibility $idx, $info->{visibility};
2737 cf::face::set_magicmap $idx, $info->{magicmap};
2738 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2739 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2740
2741 cf::cede_to_tick;
2742 }
2743
2744 while (my ($face, $info) = each %$faces) {
2745 next unless $info->{smooth};
2746 my $idx = cf::face::find $face
2747 or next;
2748 if (my $smooth = cf::face::find $info->{smooth}) {
2749 cf::face::set_smooth $idx, $smooth;
2750 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2751 } else {
2752 warn "smooth face '$info->{smooth}' not found for face '$face'";
2753 }
2754
2755 cf::cede_to_tick;
2756 }
2757 }
2758
2759 {
2760 my $anims = $facedata->{animinfo};
2761
2762 while (my ($anim, $info) = each %$anims) {
2763 cf::anim::set $anim, $info->{frames}, $info->{facings};
2764 cf::cede_to_tick;
2765 }
2766
2767 cf::anim::invalidate_all; # d'oh
2768 }
2769
2770 {
2771 # TODO: for gcfclient pleasure, we should give resources
2772 # that gcfclient doesn't grok a >10000 face index.
2773 my $res = $facedata->{resource};
2774 my $enc = JSON::XS->new->utf8->canonical;
2775
2776 while (my ($name, $info) = each %$res) {
2777 my $meta = $enc->encode ({
2778 name => $name,
2779 type => $info->{type},
2780 copyright => $info->{copyright}, #TODO#
2781 });
2782
2783 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2784
2785 if ($name =~ /\.jpg$/) {
2786 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2787 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2788 } else {
2789 my $data = pack "(w/a*)*", $meta, $info->{data};
2790 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2791
2792 cf::face::set_type $idx, 1;
2793 cf::face::set_data $idx, 0, $data, $chk;
2794 }
2795
2796 cf::cede_to_tick;
2797 }
2798 }
2799
2800 1
2801}
2802
2803sub reload_regions {
2804 load_resource_file "$MAPDIR/regions"
2251 or die "unable to load regions file\n";#d# 2805 or die "unable to load regions file\n";
2806
2807 for (cf::region::list) {
2808 $_->{match} = qr/$_->{match}/
2809 if exists $_->{match};
2810 }
2811}
2812
2813sub reload_facedata {
2814 load_facedata "$DATADIR/facedata"
2815 or die "unable to load facedata\n";
2816}
2817
2818sub reload_archetypes {
2819 load_resource_file "$DATADIR/archetypes"
2820 or die "unable to load archetypes\n";
2821 #d# NEED to laod twice to resolve forward references
2822 # this really needs to be done in an extra post-pass
2823 # (which needs to be synchronous, so solve it differently)
2824 load_resource_file "$DATADIR/archetypes"
2825 or die "unable to load archetypes\n";
2826}
2827
2828sub reload_treasures {
2829 load_resource_file "$DATADIR/treasures"
2830 or die "unable to load treasurelists\n";
2831}
2832
2833sub reload_resources {
2834 warn "reloading resource files...\n";
2835
2836 reload_regions;
2837 reload_facedata;
2838 #reload_archetypes;#d#
2839 reload_archetypes;
2840 reload_treasures;
2841
2842 warn "finished reloading resource files\n";
2843}
2844
2845sub init {
2846 reload_resources;
2252} 2847}
2253 2848
2254sub cfg_load { 2849sub cfg_load {
2255 open my $fh, "<:utf8", cf::confdir . "/config" 2850 open my $fh, "<:utf8", "$CONFDIR/config"
2256 or return; 2851 or return;
2257 2852
2258 local $/; 2853 local $/;
2259 *CFG = YAML::Syck::Load <$fh>; 2854 *CFG = YAML::Syck::Load <$fh>;
2260 2855
2268 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2863 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2269 and die "WARNING: m(un)lockall failed: $!\n"; 2864 and die "WARNING: m(un)lockall failed: $!\n";
2270 }; 2865 };
2271 warn $@ if $@; 2866 warn $@ if $@;
2272 } 2867 }
2273}
2274
2275sub init {
2276 init_resources;
2277} 2868}
2278 2869
2279sub main { 2870sub main {
2280 # we must not ever block the main coroutine 2871 # we must not ever block the main coroutine
2281 local $Coro::idle = sub { 2872 local $Coro::idle = sub {
2309 }, 2900 },
2310 ); 2901 );
2311 } 2902 }
2312} 2903}
2313 2904
2905sub write_runtime {
2906 my $runtime = "$LOCALDIR/runtime";
2907
2908 # first touch the runtime file to show we are still running:
2909 # the fsync below can take a very very long time.
2910
2911 IO::AIO::aio_utime $runtime, undef, undef;
2912
2913 my $guard = cf::lock_acquire "write_runtime";
2914
2915 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2916 or return;
2917
2918 my $value = $cf::RUNTIME + 90 + 10;
2919 # 10 is the runtime save interval, for a monotonic clock
2920 # 60 allows for the watchdog to kill the server.
2921
2922 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2923 and return;
2924
2925 # always fsync - this file is important
2926 aio_fsync $fh
2927 and return;
2928
2929 # touch it again to show we are up-to-date
2930 aio_utime $fh, undef, undef;
2931
2932 close $fh
2933 or return;
2934
2935 aio_rename "$runtime~", $runtime
2936 and return;
2937
2938 warn "runtime file written.\n";
2939
2940 1
2941}
2942
2314sub emergency_save() { 2943sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop; 2944 my $freeze_guard = cf::freeze_mainloop;
2316 2945
2317 warn "enter emergency perl save\n"; 2946 warn "enter emergency perl save\n";
2318 2947
2349 2978
2350 warn Carp::longmess "post_cleanup backtrace" 2979 warn Carp::longmess "post_cleanup backtrace"
2351 if $make_core; 2980 if $make_core;
2352} 2981}
2353 2982
2354sub reload() { 2983sub do_reload_perl() {
2355 # can/must only be called in main 2984 # can/must only be called in main
2356 if ($Coro::current != $Coro::main) { 2985 if ($Coro::current != $Coro::main) {
2357 warn "can only reload from main coroutine"; 2986 warn "can only reload from main coroutine";
2358 return; 2987 return;
2359 } 2988 }
2384 Coro::cede; 3013 Coro::cede;
2385 last unless IO::AIO::nreqs || BDB::nreqs; 3014 last unless IO::AIO::nreqs || BDB::nreqs;
2386 warn "iterate..."; 3015 warn "iterate...";
2387 } 3016 }
2388 3017
3018 ++$RELOAD;
3019
2389 warn "cancelling all extension coros"; 3020 warn "cancelling all extension coros";
2390 $_->cancel for values %EXT_CORO; 3021 $_->cancel for values %EXT_CORO;
2391 %EXT_CORO = (); 3022 %EXT_CORO = ();
2392 3023
2393 warn "removing commands"; 3024 warn "removing commands";
2394 %COMMAND = (); 3025 %COMMAND = ();
2395 3026
2396 warn "removing ext commands"; 3027 warn "removing ext/exti commands";
2397 %EXTCMD = (); 3028 %EXTCMD = ();
3029 %EXTICMD = ();
2398 3030
2399 warn "unloading/nuking all extensions"; 3031 warn "unloading/nuking all extensions";
2400 for my $pkg (@EXTS) { 3032 for my $pkg (@EXTS) {
2401 warn "... unloading $pkg"; 3033 warn "... unloading $pkg";
2402 3034
2432 Symbol::delete_package "safe::$_" 3064 Symbol::delete_package "safe::$_"
2433 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3065 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2434 3066
2435 warn "unloading cf.pm \"a bit\""; 3067 warn "unloading cf.pm \"a bit\"";
2436 delete $INC{"cf.pm"}; 3068 delete $INC{"cf.pm"};
3069 delete $INC{"cf/pod.pm"};
2437 3070
2438 # don't, removes xs symbols, too, 3071 # don't, removes xs symbols, too,
2439 # and global variables created in xs 3072 # and global variables created in xs
2440 #Symbol::delete_package __PACKAGE__; 3073 #Symbol::delete_package __PACKAGE__;
2441 3074
2450 3083
2451 warn "loading extensions"; 3084 warn "loading extensions";
2452 cf::load_extensions; 3085 cf::load_extensions;
2453 3086
2454 warn "reattaching attachments to objects/players"; 3087 warn "reattaching attachments to objects/players";
2455 _global_reattach; 3088 _global_reattach; # objects, sockets
2456 warn "reattaching attachments to maps"; 3089 warn "reattaching attachments to maps";
2457 reattach $_ for values %MAP; 3090 reattach $_ for values %MAP;
2458 3091 warn "reattaching attachments to players";
2459 warn "loading reloadable resources"; 3092 reattach $_ for values %PLAYER;
2460 init_resources;
2461 3093
2462 warn "leaving sync_job"; 3094 warn "leaving sync_job";
2463 3095
2464 1 3096 1
2465 } or do { 3097 } or do {
2471 warn "reloaded"; 3103 warn "reloaded";
2472}; 3104};
2473 3105
2474our $RELOAD_WATCHER; # used only during reload 3106our $RELOAD_WATCHER; # used only during reload
2475 3107
3108sub reload_perl() {
3109 # doing reload synchronously and two reloads happen back-to-back,
3110 # coro crashes during coro_state_free->destroy here.
3111
3112 $RELOAD_WATCHER ||= Event->timer (
3113 reentrant => 0,
3114 after => 0,
3115 data => WF_AUTOCANCEL,
3116 cb => sub {
3117 do_reload_perl;
3118 undef $RELOAD_WATCHER;
3119 },
3120 );
3121}
3122
2476register_command "reload" => sub { 3123register_command "reload" => sub {
2477 my ($who, $arg) = @_; 3124 my ($who, $arg) = @_;
2478 3125
2479 if ($who->flag (FLAG_WIZ)) { 3126 if ($who->flag (FLAG_WIZ)) {
2480 $who->message ("reloading server."); 3127 $who->message ("reloading server.");
2481 3128 async { reload_perl };
2482 # doing reload synchronously and two reloads happen back-to-back,
2483 # coro crashes during coro_state_free->destroy here.
2484
2485 $RELOAD_WATCHER ||= Event->timer (
2486 reentrant => 0,
2487 after => 0,
2488 data => WF_AUTOCANCEL,
2489 cb => sub {
2490 reload;
2491 undef $RELOAD_WATCHER;
2492 },
2493 );
2494 } 3129 }
2495}; 3130};
2496 3131
2497unshift @INC, $LIBDIR; 3132unshift @INC, $LIBDIR;
2498 3133
2499my $bug_warning = 0; 3134my $bug_warning = 0;
2500 3135
3136our @WAIT_FOR_TICK;
3137our @WAIT_FOR_TICK_BEGIN;
3138
3139sub wait_for_tick {
3140 return unless $TICK_WATCHER->is_active;
3141 return if $Coro::current == $Coro::main;
3142
3143 my $signal = new Coro::Signal;
3144 push @WAIT_FOR_TICK, $signal;
3145 $signal->wait;
3146}
3147
3148sub wait_for_tick_begin {
3149 return unless $TICK_WATCHER->is_active;
3150 return if $Coro::current == $Coro::main;
3151
3152 my $signal = new Coro::Signal;
3153 push @WAIT_FOR_TICK_BEGIN, $signal;
3154 $signal->wait;
3155}
3156
3157 my $min = 1e6;#d#
3158 my $avg = 10;
2501$TICK_WATCHER = Event->timer ( 3159$TICK_WATCHER = Event->timer (
2502 reentrant => 0, 3160 reentrant => 0,
2503 parked => 1, 3161 parked => 1,
2504 prio => 0, 3162 prio => 0,
2505 at => $NEXT_TICK || $TICK, 3163 at => $NEXT_TICK || $TICK,
2509 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3167 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2510 unless ++$bug_warning > 10; 3168 unless ++$bug_warning > 10;
2511 return; 3169 return;
2512 } 3170 }
2513 3171
2514 $NOW = Event::time; 3172 $NOW = $tick_start = Event::time;
2515 3173
2516 cf::server_tick; # one server iteration 3174 cf::server_tick; # one server iteration
3175
3176 0 && sync_job {#d#
3177 for(1..10) {
3178 my $t = Event::time;
3179 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3180 or die;
3181
3182 $map->width (50);
3183 $map->height (50);
3184 $map->alloc;
3185 $map->_load_objects ("/tmp/x.map", 1);
3186 my $t = Event::time - $t;
3187
3188 #next unless $t < 0.0013;#d#
3189 if ($t < $min) {
3190 $min = $t;
3191 }
3192 $avg = $avg * 0.99 + $t * 0.01;
3193 }
3194 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3195 exit 0;
3196 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3197 };
3198
2517 $RUNTIME += $TICK; 3199 $RUNTIME += $TICK;
2518 $NEXT_TICK += $TICK; 3200 $NEXT_TICK += $TICK;
2519 3201
2520 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3202 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2521 $NEXT_RUNTIME_WRITE = $NOW + 10; 3203 $NEXT_RUNTIME_WRITE = $NOW + 10;
2523 write_runtime 3205 write_runtime
2524 or warn "ERROR: unable to write runtime file: $!"; 3206 or warn "ERROR: unable to write runtime file: $!";
2525 }; 3207 };
2526 } 3208 }
2527 3209
2528 $WAIT_FOR_TICK->broadcast;
2529 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2530
2531# my $AFTER = Event::time; 3210# my $AFTER = Event::time;
2532# warn $AFTER - $NOW;#d# 3211# warn $AFTER - $NOW;#d#
2533 3212
3213 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3214 $sig->send;
3215 }
3216 while (my $sig = shift @WAIT_FOR_TICK) {
3217 $sig->send;
3218 }
3219
3220 $NOW = Event::time;
3221
2534 # if we are delayed by four ticks or more, skip them all 3222 # if we are delayed by four ticks or more, skip them all
2535 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3223 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2536 3224
2537 $TICK_WATCHER->at ($NEXT_TICK); 3225 $TICK_WATCHER->at ($NEXT_TICK);
2538 $TICK_WATCHER->start; 3226 $TICK_WATCHER->start;
3227
3228 $LOAD = ($NOW - $tick_start) / $TICK;
3229 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3230
3231 _post_tick;
3232
3233
2539 }, 3234 },
2540); 3235);
2541 3236
2542{ 3237{
2543 BDB::max_poll_time $TICK * 0.1; 3238 BDB::max_poll_time $TICK * 0.1;
2571 3266
2572 cf::sync_job { 3267 cf::sync_job {
2573 eval { 3268 eval {
2574 BDB::db_env_open 3269 BDB::db_env_open
2575 $DB_ENV, 3270 $DB_ENV,
2576 $BDB_ENV_DIR, 3271 $BDBDIR,
2577 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3272 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2578 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3273 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2579 0666; 3274 0666;
2580 3275
2581 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3276 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2582 3277
2583 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3278 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2584 $DB_ENV->set_lk_detect; 3279 $DB_ENV->set_lk_detect;
2585 }; 3280 };
2586 3281
2602 prio => 6, 3297 prio => 6,
2603 cb => \&IO::AIO::poll_cb, 3298 cb => \&IO::AIO::poll_cb,
2604 ); 3299 );
2605} 3300}
2606 3301
3302my $_log_backtrace;
3303
3304sub _log_backtrace {
3305 my ($msg, @addr) = @_;
3306
3307 $msg =~ s/\n//;
3308
3309 # limit the # of concurrent backtraces
3310 if ($_log_backtrace < 2) {
3311 ++$_log_backtrace;
3312 async {
3313 my @bt = fork_call {
3314 @addr = map { sprintf "%x", $_ } @addr;
3315 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3316 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3317 or die "addr2line: $!";
3318
3319 my @funcs;
3320 my @res = <$fh>;
3321 chomp for @res;
3322 while (@res) {
3323 my ($func, $line) = splice @res, 0, 2, ();
3324 push @funcs, "[$func] $line";
3325 }
3326
3327 @funcs
3328 };
3329
3330 LOG llevInfo, "[ABT] $msg\n";
3331 LOG llevInfo, "[ABT] $_\n" for @bt;
3332 --$_log_backtrace;
3333 };
3334 } else {
3335 LOG llevInfo, "[ABT] $msg\n";
3336 LOG llevInfo, "[ABT] [suppressed]\n";
3337 }
3338}
3339
3340# load additional modules
3341use cf::pod;
3342
2607END { cf::emergency_save } 3343END { cf::emergency_save }
2608 3344
26091 33451
2610 3346

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines