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.235 by root, Tue Apr 10 09:35:23 2007 UTC vs.
Revision 1.332 by root, Sat Aug 18 17:33:53 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;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.64 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
24use Coro::Util ();
21 25
26use JSON::XS 1.4 ();
22use BDB (); 27use BDB ();
23use Data::Dumper; 28use Data::Dumper;
24use Digest::MD5; 29use Digest::MD5;
25use Fcntl; 30use Fcntl;
26use YAML::Syck (); 31use YAML::Syck ();
27use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
28use Time::HiRes; 33use Time::HiRes;
29use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
30 36
31# configure various modules to our taste 37# configure various modules to our taste
32# 38#
39$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 42
36$Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
37 44
45our %COMMAND = (); 52our %COMMAND = ();
46our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
47 54
48our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
49our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
50our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
52 60
53our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
54our @EVENT; 62our @EVENT;
55our $LIBDIR = datadir . "/ext";
56 63
57our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
58our $TICK_WATCHER; 77our $TICK_WATCHER;
59our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 80our $NEXT_TICK;
62our $NOW; 81our $NOW;
71our $RUNTIME; 90our $RUNTIME;
72 91
73our %PLAYER; # all users 92our %PLAYER; # all users
74our %MAP; # all maps 93our %MAP; # all maps
75our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 95
82# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
85binmode STDOUT; 103binmode STDOUT;
86binmode STDERR; 104binmode STDERR;
87 105
88# read virtual server time, if available 106# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
91 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
92 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
93} 111}
94 112
95mkdir cf::localdir; 113mkdir $_
96mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97mkdir cf::localdir . "/" . cf::tmpdir;
98mkdir cf::localdir . "/" . cf::uniquedir;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 115
102our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
103 117
104sub cf::map::normalise; 118sub cf::map::normalise;
105 119
116=item $cf::RUNTIME 130=item $cf::RUNTIME
117 131
118The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
119every server tick. 133every server tick.
120 134
121=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
122 138
123The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
124be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
125 143
126=item $cf::NOW 144=item $cf::NOW
127 145
128The time of the last (current) server tick. 146The time of the last (current) server tick.
129 147
130=item $cf::TICK 148=item $cf::TICK
131 149
132The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
133 161
134=item %cf::CFG 162=item %cf::CFG
135 163
136Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
137from wherever your confdir points to. 165from wherever your confdir points to.
138 166
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
140 168
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 170returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick. 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
145 178
146=back 179=back
147 180
148=cut 181=cut
149 182
150BEGIN { 183BEGIN {
151 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
152 my $msg = join "", @_; 185 my $msg = join "", @_;
153 utf8::encode $msg;
154 186
155 $msg .= "\n" 187 $msg .= "\n"
156 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
157 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
158 LOG llevError, $msg; 193 LOG llevError, $msg;
159 }; 194 };
160} 195}
161 196
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168 204
169# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
170# within the Safe compartment. 206# within the Safe compartment.
171for my $pkg (qw( 207for my $pkg (qw(
172 cf::global cf::attachable 208 cf::global cf::attachable
180} 216}
181 217
182$Event::DIED = sub { 218$Event::DIED = sub {
183 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
184}; 220};
221
222#############################################################################
185 223
186=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
187 225
188=over 4 226=over 4
189 227
208 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
209 $d 247 $d
210 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
211} 249}
212 250
213use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
214
215=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
216 252
217Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
218 254
219=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
220 256
221Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
222 265
223=item cf::lock_wait $string 266=item cf::lock_wait $string
224 267
225Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
226 269
232returned. 275returned.
233 276
234Lock names should begin with a unique identifier (for example, cf::map::find 277Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 278uses map_find and cf::map::load uses map_load).
236 279
280=item $locked = cf::lock_active $string
281
282Return true if the lock is currently active, i.e. somebody has locked it.
283
237=cut 284=cut
238 285
239our %LOCK; 286our %LOCK;
240 287
241sub lock_wait($) { 288sub lock_wait($) {
258 305
259 Coro::guard { 306 Coro::guard {
260 # wake up all waiters, to be on the safe side 307 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} }; 308 $_->ready for @{ delete $LOCK{$key} };
262 } 309 }
310}
311
312sub lock_active($) {
313 my ($key) = @_;
314
315 ! ! $LOCK{$key}
263} 316}
264 317
265sub freeze_mainloop { 318sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 319 return unless $TICK_WATCHER->is_active;
267 320
270 }; 323 };
271 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
272 $guard 325 $guard
273} 326}
274 327
328=item cf::get_slot $time[, $priority[, $name]]
329
330Allocate $time seconds of blocking CPU time at priority C<$priority>:
331This call blocks and returns only when you have at least C<$time> seconds
332of cpu time till the next tick. The slot is only valid till the next cede.
333
334The optional C<$name> can be used to identify the job to run. It might be
335used for statistical purposes and should identify the same time-class.
336
337Useful for short background jobs.
338
339=cut
340
341our @SLOT_QUEUE;
342our $SLOT_QUEUE;
343
344$SLOT_QUEUE->cancel if $SLOT_QUEUE;
345$SLOT_QUEUE = Coro::async {
346 my $signal = new Coro::Signal;
347
348 while () {
349 next_job:
350 my $avail = cf::till_tick;
351 if ($avail > 0.01) {
352 for (0 .. $#SLOT_QUEUE) {
353 if ($SLOT_QUEUE[$_][0] < $avail) {
354 my $job = splice @SLOT_QUEUE, $_, 1, ();
355 $job->[2]->send;
356 Coro::cede;
357 goto next_job;
358 }
359 }
360 }
361
362 if (@SLOT_QUEUE) {
363 # we do not use wait_For_tick() as it returns immediately when tick is inactive
364 push @cf::WAIT_FOR_TICK, $signal;
365 $signal->wait;
366 } else {
367 Coro::schedule;
368 }
369 }
370};
371
372sub get_slot($;$$) {
373 my ($time, $pri, $name) = @_;
374
375 $time = $TICK * .6 if $time > $TICK * .6;
376 my $sig = new Coro::Signal;
377
378 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
379 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
380 $SLOT_QUEUE->ready;
381 $sig->wait;
382}
383
275=item cf::async { BLOCK } 384=item cf::async { BLOCK }
276 385
277Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
278C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 387C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
279thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
282 391
283BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
284 393
285=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
286 395
287The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 398partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
399acceptable.
290 400
291If it must be done, put the blocking parts into C<sync_job>. This will run 401If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 403server will be frozen during this time, so the block should either finish
294fast or be very important. 404fast or be very important.
297 407
298sub sync_job(&) { 408sub sync_job(&) {
299 my ($job) = @_; 409 my ($job) = @_;
300 410
301 if ($Coro::current == $Coro::main) { 411 if ($Coro::current == $Coro::main) {
412 my $time = Event::time;
413
302 # this is the main coro, too bad, we have to block 414 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 415 # till the operation succeeds, freezing the server :/
304 416
305 # TODO: use suspend/resume instead 417 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 418 # (but this is cancel-safe)
317 429
318 while ($busy) { 430 while ($busy) {
319 Coro::cede or Event::one_event; 431 Coro::cede or Event::one_event;
320 } 432 }
321 433
434 $time = Event::time - $time;
435
436 LOG llevError | logBacktrace, Carp::longmess "long sync job"
437 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
438
439 $tick_start += $time; # do not account sync jobs to server load
440
322 wantarray ? @res : $res[0] 441 wantarray ? @res : $res[0]
323 } else { 442 } else {
324 # we are in another coroutine, how wonderful, everything just works 443 # we are in another coroutine, how wonderful, everything just works
325 444
326 $job->() 445 $job->()
345 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
346 465
347 $coro 466 $coro
348} 467}
349 468
350sub write_runtime { 469=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 470
353 my $runtime = cf::localdir . "/runtime"; 471Executes the given code block with the given arguments in a seperate
472process, returning the results. Everything must be serialisable with
473Coro::Storable. May, of course, block. Note that the executed sub may
474never block itself or use any form of Event handling.
354 475
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 476=cut
356 or return;
357 477
358 my $value = $cf::RUNTIME + 90 + 10; 478sub fork_call(&@) {
359 # 10 is the runtime save interval, for a monotonic clock 479 my ($cb, @args) = @_;
360 # 60 allows for the watchdog to kill the server.
361 480
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481 # we seemingly have to make a local copy of the whole thing,
363 and return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
364 484
365 # always fsync - this file is important 485 my @res = Coro::Util::fork_eval {
366 aio_fsync $fh 486 reset_signals;
367 and return; 487 &$cb
488 }, @args;
368 489
369 close $fh 490 wantarray ? @res : $res[-1]
370 or return; 491}
371 492
372 aio_rename "$runtime~", $runtime 493=item $value = cf::db_get $family => $key
373 and return;
374 494
495Returns a single value from the environment database.
496
497=item cf::db_put $family => $key => $value
498
499Stores the given C<$value> in the family. It can currently store binary
500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
501
502=cut
503
504our $DB;
505
506sub db_init {
507 unless ($DB) {
508 $DB = BDB::db_create $DB_ENV;
509
510 cf::sync_job {
511 eval {
512 $DB->set_flags (BDB::CHKSUM);
513
514 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
515 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
516 cf::cleanup "db_open(db): $!" if $!;
517 };
518 cf::cleanup "db_open(db): $@" if $@;
519 };
375 1 520 }
521}
522
523sub db_get($$) {
524 my $key = "$_[0]/$_[1]";
525
526 cf::sync_job {
527 BDB::db_get $DB, undef, $key, my $data;
528
529 $! ? ()
530 : $data
531 }
532}
533
534sub db_put($$$) {
535 BDB::dbreq_pri 4;
536 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
537}
538
539=item cf::cache $id => [$paths...], $processversion => $process
540
541Generic caching function that returns the value of the resource $id,
542caching and regenerating as required.
543
544This function can block.
545
546=cut
547
548sub cache {
549 my ($id, $src, $processversion, $process) = @_;
550
551 my $meta =
552 join "\x00",
553 $processversion,
554 map {
555 aio_stat $_
556 and Carp::croak "$_: $!";
557
558 ($_, (stat _)[7,9])
559 } @$src;
560
561 my $dbmeta = db_get cache => "$id/meta";
562 if ($dbmeta ne $meta) {
563 # changed, we may need to process
564
565 my @data;
566 my $md5;
567
568 for (0 .. $#$src) {
569 0 <= aio_load $src->[$_], $data[$_]
570 or Carp::croak "$src->[$_]: $!";
571 }
572
573 # if processing is expensive, check
574 # checksum first
575 if (1) {
576 $md5 =
577 join "\x00",
578 $processversion,
579 map {
580 Coro::cede;
581 ($src->[$_], Digest::MD5::md5_hex $data[$_])
582 } 0.. $#$src;
583
584
585 my $dbmd5 = db_get cache => "$id/md5";
586 if ($dbmd5 eq $md5) {
587 db_put cache => "$id/meta", $meta;
588
589 return db_get cache => "$id/data";
590 }
591 }
592
593 my $t1 = Time::HiRes::time;
594 my $data = $process->(\@data);
595 my $t2 = Time::HiRes::time;
596
597 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
598
599 db_put cache => "$id/data", $data;
600 db_put cache => "$id/md5" , $md5;
601 db_put cache => "$id/meta", $meta;
602
603 return $data;
604 }
605
606 db_get cache => "$id/data"
376} 607}
377 608
378=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
379 610
380Log a datalog packet of the given type with the given key-value pairs. 611Log a datalog packet of the given type with the given key-value pairs.
398attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
400 631
401In the following description, CLASS can be any of C<global>, C<object> 632In the following description, CLASS can be any of C<global>, C<object>
402C<player>, C<client> or C<map> (i.e. the attachable objects in 633C<player>, C<client> or C<map> (i.e. the attachable objects in
403crossfire+). 634Crossfire TRT).
404 635
405=over 4 636=over 4
406 637
407=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
408 639
571 $registry = $CB_TYPE[$object_type] ||= []; 802 $registry = $CB_TYPE[$object_type] ||= [];
572 803
573 } elsif ($type eq "subtype") { 804 } elsif ($type eq "subtype") {
574 defined $object_type or Carp::croak "subtype specified without type"; 805 defined $object_type or Carp::croak "subtype specified without type";
575 my $object_subtype = shift @arg; 806 my $object_subtype = shift @arg;
576 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 807 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577 808
578 } elsif ($type eq "package") { 809 } elsif ($type eq "package") {
579 my $pkg = shift @arg; 810 my $pkg = shift @arg;
580 811
581 while (my ($name, $id) = each %cb_id) { 812 while (my ($name, $id) = each %cb_id) {
610 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
611 } 842 }
612 843
613 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
614 } else { 845 } else {
615 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
616 } 847 }
617 848
618 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
619} 850}
620 851
622 if (ref $_[0]) { 853 if (ref $_[0]) {
623 _object_attach @_; 854 _object_attach @_;
624 } else { 855 } else {
625 _attach shift->_attach_registry, @_; 856 _attach shift->_attach_registry, @_;
626 } 857 }
858 _recalc_want;
627}; 859};
628 860
629# all those should be optimised 861# all those should be optimised
630sub cf::attachable::detach { 862sub cf::attachable::detach {
631 my ($obj, $name) = @_; 863 my ($obj, $name) = @_;
634 delete $obj->{_attachment}{$name}; 866 delete $obj->{_attachment}{$name};
635 reattach ($obj); 867 reattach ($obj);
636 } else { 868 } else {
637 Carp::croak "cannot, currently, detach class attachments"; 869 Carp::croak "cannot, currently, detach class attachments";
638 } 870 }
871 _recalc_want;
639}; 872};
640 873
641sub cf::attachable::attached { 874sub cf::attachable::attached {
642 my ($obj, $name) = @_; 875 my ($obj, $name) = @_;
643 876
658 "; 891 ";
659 die if $@; 892 die if $@;
660} 893}
661 894
662our $override; 895our $override;
663our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 896our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
664 897
665sub override { 898sub override {
666 $override = 1; 899 $override = 1;
667 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
668} 901}
669 902
670sub do_invoke { 903sub do_invoke {
671 my $event = shift; 904 my $event = shift;
672 my $callbacks = shift; 905 my $callbacks = shift;
673 906
674 @invoke_results = (); 907 @INVOKE_RESULTS = ();
675 908
676 local $override; 909 local $override;
677 910
678 for (@$callbacks) { 911 for (@$callbacks) {
679 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
696 929
697Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
698 931
699This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 932This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
700removed in future versions), and there is no public API to access override 933removed in future versions), and there is no public API to access override
701results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
702 935
703=back 936=back
704 937
705=cut 938=cut
706 939
707############################################################################# 940#############################################################################
708# object support 941# object support
942#
943
944sub _can_merge {
945 my ($ob1, $ob2) = @_;
946
947 local $Storable::canonical = 1;
948 my $fob1 = Storable::freeze $ob1;
949 my $fob2 = Storable::freeze $ob2;
950
951 $fob1 eq $fob2
952}
709 953
710sub reattach { 954sub reattach {
711 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
712 my ($obj) = @_; 956 my ($obj) = @_;
713 957
816 or return; 1060 or return;
817 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
818 } 1062 }
819 1063
820 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
821 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
822 return ($data, $av); 1066 return ($data, $av);
823} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
824 1074
825############################################################################# 1075#############################################################################
826# command handling &c 1076# command handling &c
827 1077
828=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
841 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
842} 1092}
843 1093
844=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
845 1095
846Register a callbackf ro execution when the client sends an extcmd packet. 1096Register a callback for execution when the client sends an (synchronous)
1097extcmd packet. Ext commands will be processed in the order they are
1098received by the server, like other user commands. The first argument is
1099the logged-in player. Ext commands can only be processed after a player
1100has logged in successfully.
847 1101
848If the callback returns something, it is sent back as if reply was being 1102If the callback returns something, it is sent back as if reply was being
849called. 1103called.
850 1104
1105=item cf::register_exticmd $name => \&callback($ns,$packet);
1106
1107Register a callback for execution when the client sends an (asynchronous)
1108exticmd packet. Exti commands are processed by the server as soon as they
1109are received, i.e. out of order w.r.t. other commands. The first argument
1110is a client socket. Exti commands can be received anytime, even before
1111log-in.
1112
1113If the callback returns something, it is sent back as if reply was being
1114called.
1115
851=cut 1116=cut
852 1117
853sub register_extcmd { 1118sub register_extcmd {
854 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
855 1120
856 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
857} 1128}
858 1129
859cf::player->attach ( 1130cf::player->attach (
860 on_command => sub { 1131 on_command => sub {
861 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
870 cf::override; 1141 cf::override;
871 }, 1142 },
872 on_extcmd => sub { 1143 on_extcmd => sub {
873 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
874 1145
875 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
876 1147
877 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
878 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1154 if (my $cb = $EXTCMD{$type}) {
879 if (my %reply = $cb->($pl, $msg)) { 1155 my @reply = $cb->($pl, @payload);
1156
880 $pl->ext_reply ($msg->{msgid}, %reply); 1157 $pl->ext_reply ($reply, @reply)
881 } 1158 if $reply;
882 } 1159 }
883 } else { 1160 } else {
884 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1161 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
885 } 1162 }
886 1163
887 cf::override; 1164 cf::override;
888 }, 1165 },
889); 1166);
890 1167
891sub load_extension {
892 my ($path) = @_;
893
894 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
895 my $base = $1;
896 my $pkg = $1;
897 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "ext::$pkg";
899
900 warn "... loading '$path' into '$pkg'\n";
901
902 open my $fh, "<:utf8", $path
903 or die "$path: $!";
904
905 my $source =
906 "package $pkg; use strict; use utf8;\n"
907 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> })
909 . "\n};\n1";
910
911 unless (eval $source) {
912 my $msg = $@ ? "$path: $@\n"
913 : "extension disabled.\n";
914 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
915 warn $@;
916 warn "mandatory extension failed to load, exiting.\n";
917 exit 1;
918 }
919 die $@;
920 }
921
922 push @EXTS, $pkg;
923}
924
925sub load_extensions { 1168sub load_extensions {
1169 cf::sync_job {
1170 my %todo;
1171
926 for my $ext (<$LIBDIR/*.ext>) { 1172 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1173 next unless -r $path;
928 eval { 1174
929 load_extension $ext; 1175 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1176 my $base = $1;
1177 my $pkg = $1;
1178 $pkg =~ s/[^[:word:]]/_/g;
1179 $pkg = "ext::$pkg";
1180
1181 open my $fh, "<:utf8", $path
1182 or die "$path: $!";
1183
1184 my $source = do { local $/; <$fh> };
1185
1186 my %ext = (
1187 path => $path,
1188 base => $base,
1189 pkg => $pkg,
1190 );
1191
1192 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1193 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1194
1195 $ext{source} =
1196 "package $pkg; use strict; use utf8;\n"
1197 . "#line 1 \"$path\"\n{\n"
1198 . $source
1199 . "\n};\n1";
1200
1201 $todo{$base} = \%ext;
1202 }
1203
1204 my %done;
1205 while (%todo) {
1206 my $progress;
1207
1208 while (my ($k, $v) = each %todo) {
1209 for (split /,\s*/, $v->{meta}{depends}) {
1210 goto skip
1211 unless exists $done{$_};
1212 }
1213
1214 warn "... loading '$k' into '$v->{pkg}'\n";
1215
1216 unless (eval $v->{source}) {
1217 my $msg = $@ ? "$v->{path}: $@\n"
1218 : "$v->{base}: extension inactive.\n";
1219
1220 if (exists $v->{meta}{mandatory}) {
1221 warn $msg;
1222 warn "mandatory extension failed to load, exiting.\n";
1223 exit 1;
1224 }
1225
1226 warn $msg;
1227 }
1228
1229 $done{$k} = delete $todo{$k};
1230 push @EXTS, $v->{pkg};
1231 $progress = 1;
930 1 1232 }
931 } or warn "$ext not loaded: $@"; 1233
1234 skip:
1235 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1236 unless $progress;
1237 }
932 } 1238 };
933} 1239}
934 1240
935############################################################################# 1241#############################################################################
936 1242
1243=back
1244
937=head2 CORE EXTENSIONS 1245=head2 CORE EXTENSIONS
938 1246
939Functions and methods that extend core crossfire objects. 1247Functions and methods that extend core crossfire objects.
940 1248
941=cut 1249=cut
953Returns the given player object, loading it if necessary (might block). 1261Returns the given player object, loading it if necessary (might block).
954 1262
955=cut 1263=cut
956 1264
957sub playerdir($) { 1265sub playerdir($) {
958 cf::localdir 1266 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1267 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1268}
964 1269
965sub path($) { 1270sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1271 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1030 $cf::PLAYER{$login} = $self; 1335 $cf::PLAYER{$login} = $self;
1031 1336
1032 $self 1337 $self
1033} 1338}
1034 1339
1340=item $player->send_msg ($channel, $msg, $color, [extra...])
1341
1342=cut
1343
1344sub send_msg {
1345 my $ns = shift->ns
1346 or return;
1347 $ns->send_msg (@_);
1348}
1349
1035=item $pl->quit_character 1350=item $pl->quit_character
1036 1351
1037Nukes the player without looking back. If logged in, the connection will 1352Nukes the player without looking back. If logged in, the connection will
1038be destroyed. May block for a long time. 1353be destroyed. May block for a long time.
1039 1354
1086while and may block, so not sync_job-capable, ever. 1401while and may block, so not sync_job-capable, ever.
1087 1402
1088=cut 1403=cut
1089 1404
1090sub list_logins { 1405sub list_logins {
1091 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1406 my $dirs = aio_readdir $PLAYERDIR
1092 or return []; 1407 or return [];
1093 1408
1094 my @logins; 1409 my @logins;
1095 1410
1096 for my $login (@$dirs) { 1411 for my $login (@$dirs) {
1131 } 1446 }
1132 1447
1133 \@paths 1448 \@paths
1134} 1449}
1135 1450
1451=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1452
1453Expand crossfire pod fragments into protocol xml.
1454
1455=cut
1456
1457sub expand_cfpod {
1458 ((my $self), (local $_)) = @_;
1459
1460 # escape & and <
1461 s/&/&amp;/g;
1462 s/(?<![BIUGH])</&lt;/g;
1463
1464 # this is buggy, it needs to properly take care of nested <'s
1465
1466 1 while
1467 # replace B<>, I<>, U<> etc.
1468 s/B<([^\>]*)>/<b>$1<\/b>/
1469 || s/I<([^\>]*)>/<i>$1<\/i>/
1470 || s/U<([^\>]*)>/<u>$1<\/u>/
1471 # replace G<male|female> tags
1472 || s{G<([^>|]*)\|([^>]*)>}{
1473 $self->gender ? $2 : $1
1474 }ge
1475 # replace H<hint text>
1476 || s{H<([^\>]*)>}
1477 {
1478 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1479 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1480 "")
1481 [$self->{hintmode}]
1482 }ge;
1483
1484 # create single paragraphs (very hackish)
1485 s/(?<=\S)\n(?=\w)/ /g;
1486
1487 # compress some whitespace
1488 s/\s+\n/\n/g; # ws line-ends
1489 s/\n\n+/\n/g; # double lines
1490 s/^\n+//; # beginning lines
1491 s/\n+$//; # ending lines
1492
1493 $_
1494}
1495
1496sub hintmode {
1497 $_[0]{hintmode} = $_[1] if @_ > 1;
1498 $_[0]{hintmode}
1499}
1500
1136=item $player->ext_reply ($msgid, %msg) 1501=item $player->ext_reply ($msgid, @msg)
1137 1502
1138Sends an ext reply to the player. 1503Sends an ext reply to the player.
1139 1504
1140=cut 1505=cut
1141 1506
1142sub ext_reply($$%) { 1507sub ext_reply($$@) {
1143 my ($self, $id, %msg) = @_; 1508 my ($self, $id, @msg) = @_;
1144 1509
1145 $msg{msgid} = $id; 1510 if ($self->ns->extcmd == 2) {
1146 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1147 $self->send ("ext " . cf::to_json \%msg); 1512 } elsif ($self->ns->extcmd == 1) {
1513 #TODO: version 1, remove
1514 unshift @msg, msgtype => "reply", msgid => $id;
1515 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1516 }
1148} 1517}
1149 1518
1150=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1151 1520
1152Sends an ext event to the client. 1521Sends an ext event to the client.
1153 1522
1154=cut 1523=cut
1155 1524
1156sub ext_event($$%) { 1525sub ext_msg($$@) {
1157 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1158 1527
1159 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1160} 1529}
1161 1530
1162package cf; 1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1163 1559
1164=back 1560=back
1165
1166 1561
1167=head3 cf::map 1562=head3 cf::map
1168 1563
1169=over 4 1564=over 4
1170 1565
1225 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1226 1621
1227 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1228 local $self->{path}; 1623 local $self->{path};
1229 local $self->{load_path}; 1624 local $self->{load_path};
1230 local $self->{deny_save};
1231 local $self->{deny_reset};
1232 1625
1233 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1234} 1627}
1235 1628
1236sub normalise { 1629sub normalise {
1283 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1284 return $self; 1677 return $self;
1285 } 1678 }
1286 } 1679 }
1287 1680
1288 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1289 () 1682 ()
1290} 1683}
1291 1684
1292sub init { 1685sub init {
1293 my ($self) = @_; 1686 my ($self) = @_;
1308 1701
1309# the original (read-only) location 1702# the original (read-only) location
1310sub load_path { 1703sub load_path {
1311 my ($self) = @_; 1704 my ($self) = @_;
1312 1705
1313 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1314} 1707}
1315 1708
1316# the temporary/swap location 1709# the temporary/swap location
1317sub save_path { 1710sub save_path {
1318 my ($self) = @_; 1711 my ($self) = @_;
1319 1712
1320 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1321 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1322} 1715}
1323 1716
1324# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1325sub uniq_path { 1718sub uniq_path {
1326 my ($self) = @_; 1719 my ($self) = @_;
1327 1720
1328 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1329 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1330} 1723}
1331 1724
1332# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1333# all maps in C++... 1726# all maps in C++...
1334sub change_all_map_light { 1727sub change_all_map_light {
1335 my ($change) = @_; 1728 my ($change) = @_;
1336 1729
1337 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1338 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1732}
1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1339} 1740}
1340 1741
1341sub unlink_save { 1742sub unlink_save {
1342 my ($self) = @_; 1743 my ($self) = @_;
1343 1744
1401 $self->load_header_orig 1802 $self->load_header_orig
1402 or return; 1803 or return;
1403 $self->prepare_orig; 1804 $self->prepare_orig;
1404 } 1805 }
1405 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1812
1406 1 1813 1
1407} 1814}
1408 1815
1409sub find; 1816sub find;
1410sub find { 1817sub find {
1422 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1423 1830
1424 $map->load_header 1831 $map->load_header
1425 or return; 1832 or return;
1426 1833
1427 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1428 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1429 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1430 $map->reset; 1837 $map->reset;
1431 undef $guard; 1838 undef $guard;
1432 return find $path; 1839 return find $path;
1443 my ($self) = @_; 1850 my ($self) = @_;
1444 1851
1445 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1446 1853
1447 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1448 my $guard = cf::lock_acquire "map_load:$path"; 1857 my $guard = cf::lock_acquire "map_load:$path";
1449 1858
1450 return if $self->in_memory != cf::MAP_SWAPPED; 1859 return if $self->in_memory != cf::MAP_SWAPPED;
1451 1860
1452 $self->in_memory (cf::MAP_LOADING); 1861 $self->in_memory (cf::MAP_LOADING);
1453 1862
1454 $self->alloc; 1863 $self->alloc;
1455 1864
1456 $self->pre_load; 1865 $self->pre_load;
1457
1458 $self->_load_objects ($self->{load_path}, 1)
1459 or return;
1460
1461 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1462 if delete $self->{load_original};
1463
1464 if (my $uniq = $self->uniq_path) {
1465 utf8::encode $uniq;
1466 if (aio_open $uniq, O_RDONLY, 0) {
1467 $self->clear_unique_items;
1468 $self->_load_objects ($uniq, 0);
1469 }
1470 }
1471
1472 Coro::cede;
1473
1474 # now do the right thing for maps
1475 $self->link_multipart_objects;
1476
1477 unless ($self->{deny_activate}) {
1478 $self->decay_objects;
1479 $self->fix_auto_apply;
1480 $self->update_buttons;
1481 Coro::cede; 1866 Coro::cede;
1482 $self->set_darkness_map; 1867
1868 $self->_load_objects ($self->{load_path}, 1)
1869 or return;
1870
1871 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1872 if delete $self->{load_original};
1873
1874 if (my $uniq = $self->uniq_path) {
1875 utf8::encode $uniq;
1876 if (aio_open $uniq, O_RDONLY, 0) {
1877 $self->clear_unique_items;
1878 $self->_load_objects ($uniq, 0);
1879 }
1880 }
1881
1882 Coro::cede;
1883 # now do the right thing for maps
1884 $self->link_multipart_objects;
1483 $self->difficulty ($self->estimate_difficulty) 1885 $self->difficulty ($self->estimate_difficulty)
1484 unless $self->difficulty; 1886 unless $self->difficulty;
1485 Coro::cede; 1887 Coro::cede;
1888
1889 unless ($self->{deny_activate}) {
1890 $self->decay_objects;
1891 $self->fix_auto_apply;
1892 $self->update_buttons;
1893 Coro::cede;
1894 $self->set_darkness_map;
1895 Coro::cede;
1486 $self->activate; 1896 $self->activate;
1897 }
1898
1899 $self->{last_save} = $cf::RUNTIME;
1900 $self->last_access ($cf::RUNTIME);
1901
1902 $self->in_memory (cf::MAP_IN_MEMORY);
1487 } 1903 }
1488 1904
1489 $self->post_load; 1905 $self->post_load;
1490
1491 $self->in_memory (cf::MAP_IN_MEMORY);
1492} 1906}
1493 1907
1494sub customise_for { 1908sub customise_for {
1495 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1496 1910
1497 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1498 if $self->per_player; 1912 if $self->per_player;
1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1499 1916
1500 $self 1917 $self
1501} 1918}
1502 1919
1503# find and load all maps in the 3x3 area around a map 1920# find and load all maps in the 3x3 area around a map
1550 1967
1551 undef $MAP_PREFETCH{$path}; 1968 undef $MAP_PREFETCH{$path};
1552 $MAP_PREFETCHER ||= cf::async { 1969 $MAP_PREFETCHER ||= cf::async {
1553 while (%MAP_PREFETCH) { 1970 while (%MAP_PREFETCH) {
1554 for my $path (keys %MAP_PREFETCH) { 1971 for my $path (keys %MAP_PREFETCH) {
1555 my $map = find $path 1972 if (my $map = find $path) {
1556 or next;
1557 $map->load; 1973 $map->load;
1974 }
1558 1975
1559 delete $MAP_PREFETCH{$path}; 1976 delete $MAP_PREFETCH{$path};
1560 } 1977 }
1561 } 1978 }
1562 undef $MAP_PREFETCHER; 1979 undef $MAP_PREFETCHER;
1614 2031
1615sub reset_at { 2032sub reset_at {
1616 my ($self) = @_; 2033 my ($self) = @_;
1617 2034
1618 # TODO: safety, remove and allow resettable per-player maps 2035 # TODO: safety, remove and allow resettable per-player maps
1619 return 1e99 if $self->isa ("ext::map_per_player");#d#
1620 return 1e99 if $self->{deny_reset}; 2036 return 1e99 if $self->{deny_reset};
1621 2037
1622 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2038 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1623 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2039 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1624 2040
1635 my ($self) = @_; 2051 my ($self) = @_;
1636 2052
1637 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1638 2054
1639 return if $self->players; 2055 return if $self->players;
1640 return if $self->isa ("ext::map_per_player");#d#
1641 2056
1642 warn "resetting map ", $self->path;#d# 2057 warn "resetting map ", $self->path;
1643 2058
1644 $self->in_memory (cf::MAP_SWAPPED); 2059 $self->in_memory (cf::MAP_SWAPPED);
1645 2060
1646 # need to save uniques path 2061 # need to save uniques path
1647 unless ($self->{deny_save}) { 2062 unless ($self->{deny_save}) {
1679 $cf::MAP{$self->path} = $self; 2094 $cf::MAP{$self->path} = $self;
1680 2095
1681 $self->reset; # polite request, might not happen 2096 $self->reset; # polite request, might not happen
1682} 2097}
1683 2098
2099=item $maps = cf::map::tmp_maps
2100
2101Returns an arrayref with all map paths of currently instantiated and saved
2102maps. May block.
2103
2104=cut
2105
2106sub tmp_maps() {
2107 [
2108 map {
2109 utf8::decode $_;
2110 /\.map$/
2111 ? normalise $_
2112 : ()
2113 } @{ aio_readdir $TMPDIR or [] }
2114 ]
2115}
2116
2117=item $maps = cf::map::random_maps
2118
2119Returns an arrayref with all map paths of currently instantiated and saved
2120random maps. May block.
2121
2122=cut
2123
2124sub random_maps() {
2125 [
2126 map {
2127 utf8::decode $_;
2128 /\.map$/
2129 ? normalise "?random/$_"
2130 : ()
2131 } @{ aio_readdir $RANDOMDIR or [] }
2132 ]
2133}
2134
1684=item cf::map::unique_maps 2135=item cf::map::unique_maps
1685 2136
1686Returns an arrayref of paths of all shared maps that have 2137Returns an arrayref of paths of all shared maps that have
1687instantiated unique items. May block. 2138instantiated unique items. May block.
1688 2139
1689=cut 2140=cut
1690 2141
1691sub unique_maps() { 2142sub unique_maps() {
1692 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2143 [
1693 or return; 2144 map {
1694
1695 my @paths;
1696
1697 for (@$files) {
1698 utf8::decode $_; 2145 utf8::decode $_;
1699 next if /\.pst$/; 2146 /\.map$/
1700 next unless /^$PATH_SEP/o; 2147 ? normalise $_
1701 2148 : ()
1702 push @paths, cf::map::normalise $_; 2149 } @{ aio_readdir $UNIQUEDIR or [] }
1703 } 2150 ]
1704
1705 \@paths
1706} 2151}
1707 2152
1708package cf; 2153package cf;
1709 2154
1710=back 2155=back
1756 2201
1757 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2202 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1758 2203
1759 if ($self->{record_replies}) { 2204 if ($self->{record_replies}) {
1760 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2205 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2206
1761 } else { 2207 } else {
2208 my $pl = $self->contr;
2209
2210 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2211 my $dialog = $pl->{npc_dialog};
2212 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2213
2214 } else {
1762 $msg = $npc->name . " says: $msg" if $npc; 2215 $msg = $npc->name . " says: $msg" if $npc;
1763 $self->message ($msg, $flags); 2216 $self->message ($msg, $flags);
2217 }
1764 } 2218 }
2219}
2220
2221=item $object->send_msg ($channel, $msg, $color, [extra...])
2222
2223=cut
2224
2225sub cf::object::send_msg {
2226 my $pl = shift->contr
2227 or return;
2228 $pl->send_msg (@_);
1765} 2229}
1766 2230
1767=item $player_object->may ("access") 2231=item $player_object->may ("access")
1768 2232
1769Returns wether the given player is authorized to access resource "access" 2233Returns wether the given player is authorized to access resource "access"
1816 $self->deactivate_recursive; 2280 $self->deactivate_recursive;
1817 2281
1818 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2282 return if UNIVERSAL::isa $self->map, "ext::map_link";
1819 2283
1820 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2284 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1821 if $self->map; 2285 if $self->map && $self->map->{path} ne "{link}";
1822 2286
1823 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2287 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1824} 2288}
1825 2289
1826sub cf::object::player::leave_link { 2290sub cf::object::player::leave_link {
1827 my ($self, $map, $x, $y) = @_; 2291 my ($self, $map, $x, $y) = @_;
2292
2293 return unless $self->contr->active;
1828 2294
1829 my $link_pos = delete $self->{_link_pos}; 2295 my $link_pos = delete $self->{_link_pos};
1830 2296
1831 unless ($map) { 2297 unless ($map) {
1832 # restore original map position 2298 # restore original map position
1855 2321
1856 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2322 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1857 $self->enter_map ($map, $x, $y); 2323 $self->enter_map ($map, $x, $y);
1858} 2324}
1859 2325
1860cf::player->attach ( 2326=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1861 on_logout => sub {
1862 my ($pl) = @_;
1863 2327
1864 # abort map switching before logout 2328Moves the player to the given map-path and coordinates by first freezing
1865 if ($pl->ob->{_link_pos}) { 2329her, loading and preparing them map, calling the provided $check callback
1866 cf::sync_job { 2330that has to return the map if sucecssful, and then unfreezes the player on
1867 $pl->ob->leave_link 2331the new (success) or old (failed) map position. In either case, $done will
1868 }; 2332be called at the end of this process.
1869 }
1870 },
1871 on_login => sub {
1872 my ($pl) = @_;
1873 2333
1874 # try to abort aborted map switching on player login :)
1875 # should happen only on crashes
1876 if ($pl->ob->{_link_pos}) {
1877 $pl->ob->enter_link;
1878 (async {
1879 $pl->ob->reply (undef,
1880 "There was an internal problem at your last logout, "
1881 . "the server will try to bring you to your intended destination in a second.",
1882 cf::NDI_RED);
1883 # we need this sleep as the login has a concurrent enter_exit running
1884 # and this sleep increases chances of the player not ending up in scorn
1885 Coro::Timer::sleep 1;
1886 $pl->ob->leave_link;
1887 })->prio (2);
1888 }
1889 },
1890);
1891
1892=item $player_object->goto ($path, $x, $y)
1893
1894=cut 2334=cut
2335
2336our $GOTOGEN;
1895 2337
1896sub cf::object::player::goto { 2338sub cf::object::player::goto {
1897 my ($self, $path, $x, $y) = @_; 2339 my ($self, $path, $x, $y, $check, $done) = @_;
2340
2341 # do generation counting so two concurrent goto's will be executed in-order
2342 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1898 2343
1899 $self->enter_link; 2344 $self->enter_link;
1900 2345
1901 (async { 2346 (async {
1902 my $map = eval { 2347 my $map = eval {
1903 my $map = cf::map::find $path; 2348 my $map = cf::map::find $path;
2349
2350 if ($map) {
1904 $map = $map->customise_for ($self) if $map; 2351 $map = $map->customise_for ($self);
2352 $map = $check->($map) if $check && $map;
2353 } else {
2354 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2355 }
2356
1905 $map 2357 $map
2358 };
2359
2360 if ($@) {
2361 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2362 LOG llevError | logBacktrace, Carp::longmess $@;
1906 } or 2363 }
1907 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1908 2364
2365 if ($gen == $self->{_goto_generation}) {
2366 delete $self->{_goto_generation};
1909 $self->leave_link ($map, $x, $y); 2367 $self->leave_link ($map, $x, $y);
2368 }
2369
2370 $done->() if $done;
1910 })->prio (1); 2371 })->prio (1);
1911} 2372}
1912 2373
1913=item $player_object->enter_exit ($exit_object) 2374=item $player_object->enter_exit ($exit_object)
1914 2375
1953 2414
1954 $rmp->{random_seed} ||= $exit->random_seed; 2415 $rmp->{random_seed} ||= $exit->random_seed;
1955 2416
1956 my $data = cf::to_json $rmp; 2417 my $data = cf::to_json $rmp;
1957 my $md5 = Digest::MD5::md5_hex $data; 2418 my $md5 = Digest::MD5::md5_hex $data;
1958 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2419 my $meta = "$RANDOMDIR/$md5.meta";
1959 2420
1960 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2421 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1961 aio_write $fh, 0, (length $data), $data, 0; 2422 aio_write $fh, 0, (length $data), $data, 0;
1962 undef $fh; 2423 undef $fh;
1963 aio_rename "$meta~", $meta; 2424 aio_rename "$meta~", $meta;
1982 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2443 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1983 my $hp = $exit->stats->hp; 2444 my $hp = $exit->stats->hp;
1984 my $sp = $exit->stats->sp; 2445 my $sp = $exit->stats->sp;
1985 2446
1986 $self->enter_link; 2447 $self->enter_link;
2448
2449 # if exit is damned, update players death & WoR home-position
2450 $self->contr->savebed ($slaying, $hp, $sp)
2451 if $exit->flag (FLAG_DAMNED);
1987 2452
1988 (async { 2453 (async {
1989 $self->deactivate_recursive; # just to be sure 2454 $self->deactivate_recursive; # just to be sure
1990 unless (eval { 2455 unless (eval {
1991 $self->goto ($slaying, $hp, $sp); 2456 $self->goto ($slaying, $hp, $sp);
2019 2484
2020 utf8::encode $text; 2485 utf8::encode $text;
2021 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2486 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2022} 2487}
2023 2488
2489=item $client->send_msg ($channel, $msg, $color, [extra...])
2490
2491Send a drawinfo or msg packet to the client, formatting the msg for the
2492client if neccessary. C<$type> should be a string identifying the type of
2493the message, with C<log> being the default. If C<$color> is negative, suppress
2494the message unless the client supports the msg packet.
2495
2496=cut
2497
2498sub cf::client::send_msg {
2499 my ($self, $channel, $msg, $color, @extra) = @_;
2500
2501 $msg = $self->pl->expand_cfpod ($msg);
2502
2503 $color &= cf::NDI_CLIENT_MASK; # just in case...
2504
2505 if (ref $channel) {
2506 # send meta info to client, if not yet sent
2507 unless (exists $self->{channel}{$channel->{id}}) {
2508 $self->{channel}{$channel->{id}} = $channel;
2509 $self->ext_msg (channel_info => $channel);
2510 }
2511
2512 $channel = $channel->{id};
2513 }
2514
2515 return unless @extra || length $msg;
2516
2517 if ($self->can_msg) {
2518 # default colour, mask it out
2519 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2520 if $color & cf::NDI_DEF;
2521
2522 $self->send_packet ("msg " . $self->{json_coder}->encode (
2523 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2524 } else {
2525 if ($color >= 0) {
2526 # replace some tags by gcfclient-compatible ones
2527 for ($msg) {
2528 1 while
2529 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2530 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2531 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2532 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2533 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2534 }
2535
2536 $color &= cf::NDI_COLOR_MASK;
2537
2538 utf8::encode $msg;
2539
2540 if (0 && $msg =~ /\[/) {
2541 # COMMAND/INFO
2542 $self->send_packet ("drawextinfo $color 10 8 $msg")
2543 } else {
2544 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2545 $self->send_packet ("drawinfo $color $msg")
2546 }
2547 }
2548 }
2549}
2550
2024=item $client->ext_event ($type, %msg) 2551=item $client->ext_msg ($type, @msg)
2025 2552
2026Sends an exti event to the client. 2553Sends an ext event to the client.
2027 2554
2028=cut 2555=cut
2029 2556
2030sub cf::client::ext_event($$%) { 2557sub cf::client::ext_msg($$@) {
2031 my ($self, $type, %msg) = @_; 2558 my ($self, $type, @msg) = @_;
2032 2559
2560 my $extcmd = $self->extcmd;
2561
2562 if ($extcmd == 2) {
2563 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2564 } elsif ($extcmd == 1) { # TODO: remove
2033 $msg{msgtype} = "event_$type"; 2565 push @msg, msgtype => "event_$type";
2034 $self->send_packet ("ext " . cf::to_json \%msg); 2566 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2567 }
2035} 2568}
2036 2569
2037=item $success = $client->query ($flags, "text", \&cb) 2570=item $success = $client->query ($flags, "text", \&cb)
2038 2571
2039Queues a query to the client, calling the given callback with 2572Queues a query to the client, calling the given callback with
2040the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2573the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2041C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2574C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2042 2575
2043Queries can fail, so check the return code. Or don't, as queries will become 2576Queries can fail, so check the return code. Or don't, as queries will
2044reliable at some point in the future. 2577become reliable at some point in the future.
2045 2578
2046=cut 2579=cut
2047 2580
2048sub cf::client::query { 2581sub cf::client::query {
2049 my ($self, $flags, $text, $cb) = @_; 2582 my ($self, $flags, $text, $cb) = @_;
2057 utf8::encode $text; 2590 utf8::encode $text;
2058 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2591 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2059 2592
2060 $self->send_packet ($self->{query_queue}[0][0]) 2593 $self->send_packet ($self->{query_queue}[0][0])
2061 if @{ $self->{query_queue} } == 1; 2594 if @{ $self->{query_queue} } == 1;
2595
2596 1
2062} 2597}
2063 2598
2064cf::client->attach ( 2599cf::client->attach (
2600 on_connect => sub {
2601 my ($ns) = @_;
2602
2603 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2604 },
2065 on_reply => sub { 2605 on_reply => sub {
2066 my ($ns, $msg) = @_; 2606 my ($ns, $msg) = @_;
2067 2607
2068 # this weird shuffling is so that direct followup queries 2608 # this weird shuffling is so that direct followup queries
2069 # get handled first 2609 # get handled first
2081 } else { 2621 } else {
2082 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2622 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2083 } 2623 }
2084 } 2624 }
2085 }, 2625 },
2626 on_exticmd => sub {
2627 my ($ns, $buf) = @_;
2628
2629 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2630
2631 if (ref $msg) {
2632 my ($type, $reply, @payload) =
2633 "ARRAY" eq ref $msg
2634 ? @$msg
2635 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2636
2637 if (my $cb = $EXTICMD{$type}) {
2638 my @reply = $cb->($ns, @payload);
2639
2640 $ns->ext_reply ($reply, @reply)
2641 if $reply;
2642 }
2643 } else {
2644 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2645 }
2646
2647 cf::override;
2648 },
2086); 2649);
2087 2650
2088=item $client->async (\&cb) 2651=item $client->async (\&cb)
2089 2652
2090Create a new coroutine, running the specified callback. The coroutine will 2653Create a new coroutine, running the specified callback. The coroutine will
2131our $safe = new Safe "safe"; 2694our $safe = new Safe "safe";
2132our $safe_hole = new Safe::Hole; 2695our $safe_hole = new Safe::Hole;
2133 2696
2134$SIG{FPE} = 'IGNORE'; 2697$SIG{FPE} = 'IGNORE';
2135 2698
2136$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2699$safe->permit_only (Opcode::opset qw(
2700 :base_core :base_mem :base_orig :base_math
2701 grepstart grepwhile mapstart mapwhile
2702 sort time
2703));
2137 2704
2138# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2139 2706
2140=pod 2707=pod
2141 2708
2142The following functions and methods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2143 2710
2144 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove name archname title slaying race
2714
2145 cf::object::player player 2715 cf::object::player
2146 cf::player peaceful 2716 player
2147 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2148 2723
2149=cut 2724=cut
2150 2725
2151for ( 2726for (
2152 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove inv name archname title slaying race)],
2153 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2154 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2155 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2156) { 2732) {
2157 no strict 'refs'; 2733 no strict 'refs';
2228=back 2804=back
2229 2805
2230=cut 2806=cut
2231 2807
2232############################################################################# 2808#############################################################################
2233
2234=head2 EXTENSION DATABASE SUPPORT
2235
2236Crossfire maintains a very simple database for extension use. It can
2237currently store anything that can be serialised using Storable, which
2238excludes objects.
2239
2240The parameter C<$family> should best start with the name of the extension
2241using it, it should be unique.
2242
2243=over 4
2244
2245=item $value = cf::db_get $family => $key
2246
2247Returns a single value from the database.
2248
2249=item cf::db_put $family => $key => $value
2250
2251Stores the given C<$value> in the family.
2252
2253=cut
2254
2255our $DB;
2256
2257sub db_init {
2258 unless ($DB) {
2259 $DB = BDB::db_create $DB_ENV;
2260
2261 cf::sync_job {
2262 eval {
2263 $DB->set_flags (BDB::CHKSUM);
2264
2265 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2266 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2267 cf::cleanup "db_open(db): $!" if $!;
2268 };
2269 cf::cleanup "db_open(db): $@" if $@;
2270 };
2271
2272 my $path = cf::localdir . "/database.pst";
2273 if (stat $path) {
2274 cf::sync_job {
2275 my $pst = Storable::retrieve $path;
2276
2277 cf::db_put (board => data => $pst->{board});
2278 cf::db_put (guildrules => data => $pst->{guildrules});
2279 cf::db_put (rent => balance => $pst->{rent}{balance});
2280 BDB::db_env_txn_checkpoint $DB_ENV;
2281
2282 unlink $path;
2283 };
2284 }
2285 }
2286}
2287
2288sub db_get($$) {
2289 my $key = "$_[0]/$_[1]";
2290
2291 cf::sync_job {
2292 BDB::db_get $DB, undef, $key, my $data;
2293
2294 $! ? ()
2295 : Compress::LZF::sthaw $data
2296 }
2297}
2298
2299sub db_put($$$) {
2300 BDB::dbreq_pri 4;
2301 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2302}
2303
2304#############################################################################
2305# the server's init and main functions 2809# the server's init and main functions
2306 2810
2307sub load_facedata { 2811sub load_facedata($) {
2308 my $path = sprintf "%s/facedata", cf::datadir; 2812 my ($path) = @_;
2309 2813
2310 warn "loading facedata from $path\n"; 2814 warn "loading facedata from $path\n";
2311 2815
2312 my $faces; 2816 my $facedata;
2313 0 < aio_load $path, $faces 2817 0 < aio_load $path, $facedata
2314 or die "$path: $!"; 2818 or die "$path: $!";
2315 2819
2316 Coro::cede;
2317 $faces = Storable::thaw $faces; 2820 $facedata = Coro::Storable::thaw $facedata;
2318 Coro::cede;
2319 2821
2320 my $meta = delete $faces->{""};
2321 $meta->{version} == 1 2822 $facedata->{version} == 2
2322 or cf::cleanup "$path: version mismatch, cannot proceed."; 2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
2323 2824
2825 {
2826 my $faces = $facedata->{faceinfo};
2827
2324 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2325 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2326 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2327 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2328 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2329 Coro::cede;
2330 }
2331 2834
2835 cf::cede_to_tick;
2836 }
2837
2332 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2333 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2334 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2335 or next; 2841 or next;
2336 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2337 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2338 } else { 2845 } else {
2339 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2340 } 2847 }
2341 Coro::cede; 2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 my $soundconf = delete $res->{"res/sound.conf"};
2871
2872 while (my ($name, $info) = each %$res) {
2873 my $meta = $enc->encode ({
2874 name => $name,
2875 %{ $info->{meta} || {} },
2876 });
2877
2878 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2879
2880 if ($info->{type} & 1) {
2881 # prepend meta info
2882
2883 my $data = pack "(w/a*)*", $meta, $info->{data};
2884 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2885
2886 cf::face::set_data $idx, 0, $data, $chk;
2887 } else {
2888 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2889 }
2890
2891 cf::face::set_type $idx, $info->{type};
2892
2893 cf::cede_to_tick;
2894 }
2895
2896 if ($soundconf) {
2897 $soundconf = $enc->decode (delete $soundconf->{data});
2898
2899 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2900 my $sound = $soundconf->{compat}[$_]
2901 or next;
2902
2903 my $face = cf::face::find "sound/$sound->[1]";
2904 cf::sound::set $sound->[0] => $face;
2905 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2906 }
2907
2908 while (my ($k, $v) = each %{$soundconf->{event}}) {
2909 my $face = cf::face::find "sound/$v";
2910 cf::sound::set $k => $face;
2911 }
2912 }
2342 } 2913 }
2343 2914
2344 1 2915 1
2345} 2916}
2346 2917
2918register_exticmd fx_want => sub {
2919 my ($ns, $want) = @_;
2920
2921 while (my ($k, $v) = each %$want) {
2922 $ns->fx_want ($k, $v);
2923 }
2924};
2925
2926sub reload_regions {
2927 load_resource_file "$MAPDIR/regions"
2928 or die "unable to load regions file\n";
2929
2930 for (cf::region::list) {
2931 $_->{match} = qr/$_->{match}/
2932 if exists $_->{match};
2933 }
2934}
2935
2936sub reload_facedata {
2937 load_facedata "$DATADIR/facedata"
2938 or die "unable to load facedata\n";
2939}
2940
2941sub reload_archetypes {
2942 load_resource_file "$DATADIR/archetypes"
2943 or die "unable to load archetypes\n";
2944 #d# NEED to laod twice to resolve forward references
2945 # this really needs to be done in an extra post-pass
2946 # (which needs to be synchronous, so solve it differently)
2947 load_resource_file "$DATADIR/archetypes"
2948 or die "unable to load archetypes\n";
2949}
2950
2951sub reload_treasures {
2952 load_resource_file "$DATADIR/treasures"
2953 or die "unable to load treasurelists\n";
2954}
2955
2347sub reload_resources { 2956sub reload_resources {
2348 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2957 warn "reloading resource files...\n";
2349 or die "unable to load regions file\n";#d# 2958
2959 reload_regions;
2350 load_facedata 2960 reload_facedata;
2351 or die "unable to load facedata\n";#d# 2961 #reload_archetypes;#d#
2962 reload_archetypes;
2963 reload_treasures;
2964
2965 warn "finished reloading resource files\n";
2352} 2966}
2353 2967
2354sub init { 2968sub init {
2355 reload_resources; 2969 reload_resources;
2356} 2970}
2357 2971
2358sub cfg_load { 2972sub cfg_load {
2359 open my $fh, "<:utf8", cf::confdir . "/config" 2973 open my $fh, "<:utf8", "$CONFDIR/config"
2360 or return; 2974 or return;
2361 2975
2362 local $/; 2976 local $/;
2363 *CFG = YAML::Syck::Load <$fh>; 2977 *CFG = YAML::Syck::Load <$fh>;
2364 2978
2409 }, 3023 },
2410 ); 3024 );
2411 } 3025 }
2412} 3026}
2413 3027
3028sub write_runtime {
3029 my $runtime = "$LOCALDIR/runtime";
3030
3031 # first touch the runtime file to show we are still running:
3032 # the fsync below can take a very very long time.
3033
3034 IO::AIO::aio_utime $runtime, undef, undef;
3035
3036 my $guard = cf::lock_acquire "write_runtime";
3037
3038 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3039 or return;
3040
3041 my $value = $cf::RUNTIME + 90 + 10;
3042 # 10 is the runtime save interval, for a monotonic clock
3043 # 60 allows for the watchdog to kill the server.
3044
3045 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3046 and return;
3047
3048 # always fsync - this file is important
3049 aio_fsync $fh
3050 and return;
3051
3052 # touch it again to show we are up-to-date
3053 aio_utime $fh, undef, undef;
3054
3055 close $fh
3056 or return;
3057
3058 aio_rename "$runtime~", $runtime
3059 and return;
3060
3061 warn "runtime file written.\n";
3062
3063 1
3064}
3065
2414sub emergency_save() { 3066sub emergency_save() {
2415 my $freeze_guard = cf::freeze_mainloop; 3067 my $freeze_guard = cf::freeze_mainloop;
2416 3068
2417 warn "enter emergency perl save\n"; 3069 warn "enter emergency perl save\n";
2418 3070
2449 3101
2450 warn Carp::longmess "post_cleanup backtrace" 3102 warn Carp::longmess "post_cleanup backtrace"
2451 if $make_core; 3103 if $make_core;
2452} 3104}
2453 3105
2454sub reload() { 3106sub do_reload_perl() {
2455 # can/must only be called in main 3107 # can/must only be called in main
2456 if ($Coro::current != $Coro::main) { 3108 if ($Coro::current != $Coro::main) {
2457 warn "can only reload from main coroutine"; 3109 warn "can only reload from main coroutine";
2458 return; 3110 return;
2459 } 3111 }
2493 %EXT_CORO = (); 3145 %EXT_CORO = ();
2494 3146
2495 warn "removing commands"; 3147 warn "removing commands";
2496 %COMMAND = (); 3148 %COMMAND = ();
2497 3149
2498 warn "removing ext commands"; 3150 warn "removing ext/exti commands";
2499 %EXTCMD = (); 3151 %EXTCMD = ();
3152 %EXTICMD = ();
2500 3153
2501 warn "unloading/nuking all extensions"; 3154 warn "unloading/nuking all extensions";
2502 for my $pkg (@EXTS) { 3155 for my $pkg (@EXTS) {
2503 warn "... unloading $pkg"; 3156 warn "... unloading $pkg";
2504 3157
2534 Symbol::delete_package "safe::$_" 3187 Symbol::delete_package "safe::$_"
2535 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3188 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2536 3189
2537 warn "unloading cf.pm \"a bit\""; 3190 warn "unloading cf.pm \"a bit\"";
2538 delete $INC{"cf.pm"}; 3191 delete $INC{"cf.pm"};
3192 delete $INC{"cf/pod.pm"};
2539 3193
2540 # don't, removes xs symbols, too, 3194 # don't, removes xs symbols, too,
2541 # and global variables created in xs 3195 # and global variables created in xs
2542 #Symbol::delete_package __PACKAGE__; 3196 #Symbol::delete_package __PACKAGE__;
2543 3197
2558 warn "reattaching attachments to maps"; 3212 warn "reattaching attachments to maps";
2559 reattach $_ for values %MAP; 3213 reattach $_ for values %MAP;
2560 warn "reattaching attachments to players"; 3214 warn "reattaching attachments to players";
2561 reattach $_ for values %PLAYER; 3215 reattach $_ for values %PLAYER;
2562 3216
2563 warn "loading reloadable resources";
2564 reload_resources;
2565
2566 warn "leaving sync_job"; 3217 warn "leaving sync_job";
2567 3218
2568 1 3219 1
2569 } or do { 3220 } or do {
2570 warn $@; 3221 warn $@;
2575 warn "reloaded"; 3226 warn "reloaded";
2576}; 3227};
2577 3228
2578our $RELOAD_WATCHER; # used only during reload 3229our $RELOAD_WATCHER; # used only during reload
2579 3230
3231sub reload_perl() {
3232 # doing reload synchronously and two reloads happen back-to-back,
3233 # coro crashes during coro_state_free->destroy here.
3234
3235 $RELOAD_WATCHER ||= Event->timer (
3236 reentrant => 0,
3237 after => 0,
3238 data => WF_AUTOCANCEL,
3239 cb => sub {
3240 do_reload_perl;
3241 undef $RELOAD_WATCHER;
3242 },
3243 );
3244}
3245
2580register_command "reload" => sub { 3246register_command "reload" => sub {
2581 my ($who, $arg) = @_; 3247 my ($who, $arg) = @_;
2582 3248
2583 if ($who->flag (FLAG_WIZ)) { 3249 if ($who->flag (FLAG_WIZ)) {
2584 $who->message ("reloading server."); 3250 $who->message ("reloading server.");
2585 3251 async { reload_perl };
2586 # doing reload synchronously and two reloads happen back-to-back,
2587 # coro crashes during coro_state_free->destroy here.
2588
2589 $RELOAD_WATCHER ||= Event->timer (
2590 reentrant => 0,
2591 after => 0,
2592 data => WF_AUTOCANCEL,
2593 cb => sub {
2594 reload;
2595 undef $RELOAD_WATCHER;
2596 },
2597 );
2598 } 3252 }
2599}; 3253};
2600 3254
2601unshift @INC, $LIBDIR; 3255unshift @INC, $LIBDIR;
2602 3256
2603my $bug_warning = 0; 3257my $bug_warning = 0;
2604 3258
3259our @WAIT_FOR_TICK;
3260our @WAIT_FOR_TICK_BEGIN;
3261
3262sub wait_for_tick {
3263 return unless $TICK_WATCHER->is_active;
3264 return if $Coro::current == $Coro::main;
3265
3266 my $signal = new Coro::Signal;
3267 push @WAIT_FOR_TICK, $signal;
3268 $signal->wait;
3269}
3270
3271sub wait_for_tick_begin {
3272 return unless $TICK_WATCHER->is_active;
3273 return if $Coro::current == $Coro::main;
3274
3275 my $signal = new Coro::Signal;
3276 push @WAIT_FOR_TICK_BEGIN, $signal;
3277 $signal->wait;
3278}
3279
3280 my $min = 1e6;#d#
3281 my $avg = 10;
2605$TICK_WATCHER = Event->timer ( 3282$TICK_WATCHER = Event->timer (
2606 reentrant => 0, 3283 reentrant => 0,
2607 parked => 1, 3284 parked => 1,
2608 prio => 0, 3285 prio => 0,
2609 at => $NEXT_TICK || $TICK, 3286 at => $NEXT_TICK || $TICK,
2613 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3290 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2614 unless ++$bug_warning > 10; 3291 unless ++$bug_warning > 10;
2615 return; 3292 return;
2616 } 3293 }
2617 3294
2618 $NOW = Event::time; 3295 $NOW = $tick_start = Event::time;
2619 3296
2620 cf::server_tick; # one server iteration 3297 cf::server_tick; # one server iteration
3298
3299 0 && sync_job {#d#
3300 for(1..10) {
3301 my $t = Event::time;
3302 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3303 or die;
3304
3305 $map->width (50);
3306 $map->height (50);
3307 $map->alloc;
3308 $map->_load_objects ("/tmp/x.map", 1);
3309 my $t = Event::time - $t;
3310
3311 #next unless $t < 0.0013;#d#
3312 if ($t < $min) {
3313 $min = $t;
3314 }
3315 $avg = $avg * 0.99 + $t * 0.01;
3316 }
3317 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3318 exit 0;
3319 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3320 };
3321
2621 $RUNTIME += $TICK; 3322 $RUNTIME += $TICK;
2622 $NEXT_TICK += $TICK; 3323 $NEXT_TICK += $TICK;
2623 3324
2624 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3325 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2625 $NEXT_RUNTIME_WRITE = $NOW + 10; 3326 $NEXT_RUNTIME_WRITE = $NOW + 10;
2627 write_runtime 3328 write_runtime
2628 or warn "ERROR: unable to write runtime file: $!"; 3329 or warn "ERROR: unable to write runtime file: $!";
2629 }; 3330 };
2630 } 3331 }
2631 3332
2632 $WAIT_FOR_TICK->broadcast;
2633 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2634
2635# my $AFTER = Event::time; 3333# my $AFTER = Event::time;
2636# warn $AFTER - $NOW;#d# 3334# warn $AFTER - $NOW;#d#
2637 3335
3336 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3337 $sig->send;
3338 }
3339 while (my $sig = shift @WAIT_FOR_TICK) {
3340 $sig->send;
3341 }
3342
3343 $NOW = Event::time;
3344
2638 # if we are delayed by four ticks or more, skip them all 3345 # if we are delayed by four ticks or more, skip them all
2639 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3346 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2640 3347
2641 $TICK_WATCHER->at ($NEXT_TICK); 3348 $TICK_WATCHER->at ($NEXT_TICK);
2642 $TICK_WATCHER->start; 3349 $TICK_WATCHER->start;
3350
3351 $LOAD = ($NOW - $tick_start) / $TICK;
3352 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3353
3354 _post_tick;
3355
3356
2643 }, 3357 },
2644); 3358);
2645 3359
2646{ 3360{
2647 BDB::max_poll_time $TICK * 0.1; 3361 BDB::max_poll_time $TICK * 0.1;
2675 3389
2676 cf::sync_job { 3390 cf::sync_job {
2677 eval { 3391 eval {
2678 BDB::db_env_open 3392 BDB::db_env_open
2679 $DB_ENV, 3393 $DB_ENV,
2680 $BDB_ENV_DIR, 3394 $BDBDIR,
2681 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3395 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2682 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3396 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2683 0666; 3397 0666;
2684 3398
2685 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3399 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2686 3400
2687 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3401 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2688 $DB_ENV->set_lk_detect; 3402 $DB_ENV->set_lk_detect;
2689 }; 3403 };
2690 3404
2706 prio => 6, 3420 prio => 6,
2707 cb => \&IO::AIO::poll_cb, 3421 cb => \&IO::AIO::poll_cb,
2708 ); 3422 );
2709} 3423}
2710 3424
3425my $_log_backtrace;
3426
3427sub _log_backtrace {
3428 my ($msg, @addr) = @_;
3429
3430 $msg =~ s/\n//;
3431
3432 # limit the # of concurrent backtraces
3433 if ($_log_backtrace < 2) {
3434 ++$_log_backtrace;
3435 async {
3436 my @bt = fork_call {
3437 @addr = map { sprintf "%x", $_ } @addr;
3438 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3439 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3440 or die "addr2line: $!";
3441
3442 my @funcs;
3443 my @res = <$fh>;
3444 chomp for @res;
3445 while (@res) {
3446 my ($func, $line) = splice @res, 0, 2, ();
3447 push @funcs, "[$func] $line";
3448 }
3449
3450 @funcs
3451 };
3452
3453 LOG llevInfo, "[ABT] $msg\n";
3454 LOG llevInfo, "[ABT] $_\n" for @bt;
3455 --$_log_backtrace;
3456 };
3457 } else {
3458 LOG llevInfo, "[ABT] $msg\n";
3459 LOG llevInfo, "[ABT] [suppressed]\n";
3460 }
3461}
3462
3463# load additional modules
3464use cf::pod;
3465
2711END { cf::emergency_save } 3466END { cf::emergency_save }
2712 3467
27131 34681
2714 3469

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines