ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/server/lib/cf.pm
(Generate patch)

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.238 by root, Sat Apr 14 07:23:00 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;
21use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
22 25
26use JSON::XS 1.4 ();
23use BDB (); 27use BDB ();
24use Data::Dumper; 28use Data::Dumper;
25use Digest::MD5; 29use Digest::MD5;
26use Fcntl; 30use Fcntl;
27use YAML::Syck (); 31use YAML::Syck ();
28use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
29use Time::HiRes; 33use Time::HiRes;
30use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
31 36
32# configure various modules to our taste 37# configure various modules to our taste
33# 38#
34$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
35Coro::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
47our %COMMAND = (); 52our %COMMAND = ();
48our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
49 54
50our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
51our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
52our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
53our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
54 60
55our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
56our @EVENT; 62our @EVENT;
57our $LIBDIR = datadir . "/ext";
58 63
59our $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(!)
60our $TICK_WATCHER; 77our $TICK_WATCHER;
61our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
62our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
63our $NEXT_TICK; 80our $NEXT_TICK;
64our $NOW; 81our $NOW;
73our $RUNTIME; 90our $RUNTIME;
74 91
75our %PLAYER; # all users 92our %PLAYER; # all users
76our %MAP; # all maps 93our %MAP; # all maps
77our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
78our $RANDOM_MAPS = cf::localdir . "/random";
79our $BDB_ENV_DIR = cf::localdir . "/db";
80
81our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
82our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
83 95
84# 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 ∕
85our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
86 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
87binmode STDOUT; 103binmode STDOUT;
88binmode STDERR; 104binmode STDERR;
89 105
90# read virtual server time, if available 106# read virtual server time, if available
91unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
92 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
93 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
94 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
95} 111}
96 112
97mkdir cf::localdir; 113mkdir $_
98mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
99mkdir cf::localdir . "/" . cf::tmpdir;
100mkdir cf::localdir . "/" . cf::uniquedir;
101mkdir $RANDOM_MAPS;
102mkdir $BDB_ENV_DIR;
103 115
104our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
105 117
106sub cf::map::normalise; 118sub cf::map::normalise;
107 119
118=item $cf::RUNTIME 130=item $cf::RUNTIME
119 131
120The 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
121every server tick. 133every server tick.
122 134
123=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
124 138
125The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
126be 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.
127 143
128=item $cf::NOW 144=item $cf::NOW
129 145
130The time of the last (current) server tick. 146The time of the last (current) server tick.
131 147
132=item $cf::TICK 148=item $cf::TICK
133 149
134The 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.
135 161
136=item %cf::CFG 162=item %cf::CFG
137 163
138Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
139from wherever your confdir points to. 165from wherever your confdir points to.
140 166
141=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
142 168
143These 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
144or 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
145processing 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.
146window 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.
147 178
148=back 179=back
149 180
150=cut 181=cut
151 182
152BEGIN { 183BEGIN {
153 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
154 my $msg = join "", @_; 185 my $msg = join "", @_;
155 utf8::encode $msg;
156 186
157 $msg .= "\n" 187 $msg .= "\n"
158 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
159 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
160 LOG llevError, $msg; 193 LOG llevError, $msg;
161 }; 194 };
162} 195}
163 196
164@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
165@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
166@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
167@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
168@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';
169@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)
170 204
171# 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
172# within the Safe compartment. 206# within the Safe compartment.
173for my $pkg (qw( 207for my $pkg (qw(
174 cf::global cf::attachable 208 cf::global cf::attachable
182} 216}
183 217
184$Event::DIED = sub { 218$Event::DIED = sub {
185 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
186}; 220};
221
222#############################################################################
187 223
188=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
189 225
190=over 4 226=over 4
191 227
210 $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;
211 $d 247 $d
212 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
213} 249}
214 250
215use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
216
217=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
218 252
219Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
220 254
221=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
222 256
223Converts 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]) }
224 265
225=item cf::lock_wait $string 266=item cf::lock_wait $string
226 267
227Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
228 269
234returned. 275returned.
235 276
236Lock 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
237uses map_find and cf::map::load uses map_load). 278uses map_find and cf::map::load uses map_load).
238 279
280=item $locked = cf::lock_active $string
281
282Return true if the lock is currently active, i.e. somebody has locked it.
283
239=cut 284=cut
240 285
241our %LOCK; 286our %LOCK;
242 287
243sub lock_wait($) { 288sub lock_wait($) {
260 305
261 Coro::guard { 306 Coro::guard {
262 # wake up all waiters, to be on the safe side 307 # wake up all waiters, to be on the safe side
263 $_->ready for @{ delete $LOCK{$key} }; 308 $_->ready for @{ delete $LOCK{$key} };
264 } 309 }
310}
311
312sub lock_active($) {
313 my ($key) = @_;
314
315 ! ! $LOCK{$key}
265} 316}
266 317
267sub freeze_mainloop { 318sub freeze_mainloop {
268 return unless $TICK_WATCHER->is_active; 319 return unless $TICK_WATCHER->is_active;
269 320
272 }; 323 };
273 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
274 $guard 325 $guard
275} 326}
276 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
277=item cf::async { BLOCK } 384=item cf::async { BLOCK }
278 385
279Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
280C<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
281thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
284 391
285BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
286 393
287=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
288 395
289The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
290always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
291reentrant. 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.
292 400
293If 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
294the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
295server 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
296fast or be very important. 404fast or be very important.
299 407
300sub sync_job(&) { 408sub sync_job(&) {
301 my ($job) = @_; 409 my ($job) = @_;
302 410
303 if ($Coro::current == $Coro::main) { 411 if ($Coro::current == $Coro::main) {
412 my $time = Event::time;
413
304 # this is the main coro, too bad, we have to block 414 # this is the main coro, too bad, we have to block
305 # till the operation succeeds, freezing the server :/ 415 # till the operation succeeds, freezing the server :/
306 416
307 # TODO: use suspend/resume instead 417 # TODO: use suspend/resume instead
308 # (but this is cancel-safe) 418 # (but this is cancel-safe)
319 429
320 while ($busy) { 430 while ($busy) {
321 Coro::cede or Event::one_event; 431 Coro::cede or Event::one_event;
322 } 432 }
323 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
324 wantarray ? @res : $res[0] 441 wantarray ? @res : $res[0]
325 } else { 442 } else {
326 # we are in another coroutine, how wonderful, everything just works 443 # we are in another coroutine, how wonderful, everything just works
327 444
328 $job->() 445 $job->()
347 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
348 465
349 $coro 466 $coro
350} 467}
351 468
352sub write_runtime { 469=item fork_call { }, $args
353 my $guard = cf::lock_acquire "write_runtime";
354 470
355 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.
356 475
357 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 476=cut
358 or return;
359 477
360 my $value = $cf::RUNTIME + 90 + 10; 478sub fork_call(&@) {
361 # 10 is the runtime save interval, for a monotonic clock 479 my ($cb, @args) = @_;
362 # 60 allows for the watchdog to kill the server.
363 480
364 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481 # we seemingly have to make a local copy of the whole thing,
365 and return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
366 484
367 # always fsync - this file is important 485 my @res = Coro::Util::fork_eval {
368 aio_fsync $fh 486 reset_signals;
369 and return; 487 &$cb
488 }, @args;
370 489
371 close $fh 490 wantarray ? @res : $res[-1]
372 or return; 491}
373 492
374 aio_rename "$runtime~", $runtime 493=item $value = cf::db_get $family => $key
375 and return;
376 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 };
377 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"
378} 607}
379 608
380=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
381 610
382Log 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.
400attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
401to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
402 631
403In 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>
404C<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
405crossfire+). 634Crossfire TRT).
406 635
407=over 4 636=over 4
408 637
409=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
410 639
573 $registry = $CB_TYPE[$object_type] ||= []; 802 $registry = $CB_TYPE[$object_type] ||= [];
574 803
575 } elsif ($type eq "subtype") { 804 } elsif ($type eq "subtype") {
576 defined $object_type or Carp::croak "subtype specified without type"; 805 defined $object_type or Carp::croak "subtype specified without type";
577 my $object_subtype = shift @arg; 806 my $object_subtype = shift @arg;
578 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 807 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
579 808
580 } elsif ($type eq "package") { 809 } elsif ($type eq "package") {
581 my $pkg = shift @arg; 810 my $pkg = shift @arg;
582 811
583 while (my ($name, $id) = each %cb_id) { 812 while (my ($name, $id) = each %cb_id) {
612 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
613 } 842 }
614 843
615 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
616 } else { 845 } else {
617 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
618 } 847 }
619 848
620 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
621} 850}
622 851
624 if (ref $_[0]) { 853 if (ref $_[0]) {
625 _object_attach @_; 854 _object_attach @_;
626 } else { 855 } else {
627 _attach shift->_attach_registry, @_; 856 _attach shift->_attach_registry, @_;
628 } 857 }
858 _recalc_want;
629}; 859};
630 860
631# all those should be optimised 861# all those should be optimised
632sub cf::attachable::detach { 862sub cf::attachable::detach {
633 my ($obj, $name) = @_; 863 my ($obj, $name) = @_;
636 delete $obj->{_attachment}{$name}; 866 delete $obj->{_attachment}{$name};
637 reattach ($obj); 867 reattach ($obj);
638 } else { 868 } else {
639 Carp::croak "cannot, currently, detach class attachments"; 869 Carp::croak "cannot, currently, detach class attachments";
640 } 870 }
871 _recalc_want;
641}; 872};
642 873
643sub cf::attachable::attached { 874sub cf::attachable::attached {
644 my ($obj, $name) = @_; 875 my ($obj, $name) = @_;
645 876
660 "; 891 ";
661 die if $@; 892 die if $@;
662} 893}
663 894
664our $override; 895our $override;
665our @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?
666 897
667sub override { 898sub override {
668 $override = 1; 899 $override = 1;
669 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
670} 901}
671 902
672sub do_invoke { 903sub do_invoke {
673 my $event = shift; 904 my $event = shift;
674 my $callbacks = shift; 905 my $callbacks = shift;
675 906
676 @invoke_results = (); 907 @INVOKE_RESULTS = ();
677 908
678 local $override; 909 local $override;
679 910
680 for (@$callbacks) { 911 for (@$callbacks) {
681 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
698 929
699Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
700 931
701This 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
702removed 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
703results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
704 935
705=back 936=back
706 937
707=cut 938=cut
708 939
709############################################################################# 940#############################################################################
710# 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}
711 953
712sub reattach { 954sub reattach {
713 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
714 my ($obj) = @_; 956 my ($obj) = @_;
715 957
818 or return; 1060 or return;
819 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
820 } 1062 }
821 1063
822 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
824 return ($data, $av); 1066 return ($data, $av);
825} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
826 1074
827############################################################################# 1075#############################################################################
828# command handling &c 1076# command handling &c
829 1077
830=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
843 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
844} 1092}
845 1093
846=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
847 1095
848Register 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.
849 1101
850If 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
851called. 1103called.
852 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
853=cut 1116=cut
854 1117
855sub register_extcmd { 1118sub register_extcmd {
856 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
857 1120
858 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
859} 1128}
860 1129
861cf::player->attach ( 1130cf::player->attach (
862 on_command => sub { 1131 on_command => sub {
863 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
872 cf::override; 1141 cf::override;
873 }, 1142 },
874 on_extcmd => sub { 1143 on_extcmd => sub {
875 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
876 1145
877 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
878 1147
879 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
880 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1154 if (my $cb = $EXTCMD{$type}) {
881 if (my %reply = $cb->($pl, $msg)) { 1155 my @reply = $cb->($pl, @payload);
1156
882 $pl->ext_reply ($msg->{msgid}, %reply); 1157 $pl->ext_reply ($reply, @reply)
883 } 1158 if $reply;
884 } 1159 }
885 } else { 1160 } else {
886 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1161 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
887 } 1162 }
888 1163
889 cf::override; 1164 cf::override;
890 }, 1165 },
891); 1166);
892 1167
893sub load_extension {
894 my ($path) = @_;
895
896 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
897 my $base = $1;
898 my $pkg = $1;
899 $pkg =~ s/[^[:word:]]/_/g;
900 $pkg = "ext::$pkg";
901
902 warn "... loading '$path' into '$pkg'\n";
903
904 open my $fh, "<:utf8", $path
905 or die "$path: $!";
906
907 my $source =
908 "package $pkg; use strict; use utf8;\n"
909 . "#line 1 \"$path\"\n{\n"
910 . (do { local $/; <$fh> })
911 . "\n};\n1";
912
913 unless (eval $source) {
914 my $msg = $@ ? "$path: $@\n"
915 : "extension disabled.\n";
916 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
917 warn $@;
918 warn "mandatory extension failed to load, exiting.\n";
919 exit 1;
920 }
921 die $@;
922 }
923
924 push @EXTS, $pkg;
925}
926
927sub load_extensions { 1168sub load_extensions {
1169 cf::sync_job {
1170 my %todo;
1171
928 for my $ext (<$LIBDIR/*.ext>) { 1172 for my $path (<$LIBDIR/*.ext>) {
929 next unless -r $ext; 1173 next unless -r $path;
930 eval { 1174
931 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;
932 1 1232 }
933 } or warn "$ext not loaded: $@"; 1233
1234 skip:
1235 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1236 unless $progress;
1237 }
934 } 1238 };
935} 1239}
936 1240
937############################################################################# 1241#############################################################################
938 1242
1243=back
1244
939=head2 CORE EXTENSIONS 1245=head2 CORE EXTENSIONS
940 1246
941Functions and methods that extend core crossfire objects. 1247Functions and methods that extend core crossfire objects.
942 1248
943=cut 1249=cut
955Returns the given player object, loading it if necessary (might block). 1261Returns the given player object, loading it if necessary (might block).
956 1262
957=cut 1263=cut
958 1264
959sub playerdir($) { 1265sub playerdir($) {
960 cf::localdir 1266 "$PLAYERDIR/"
961 . "/"
962 . cf::playerdir
963 . "/"
964 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1267 . (ref $_[0] ? $_[0]->ob->name : $_[0])
965} 1268}
966 1269
967sub path($) { 1270sub path($) {
968 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1271 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1032 $cf::PLAYER{$login} = $self; 1335 $cf::PLAYER{$login} = $self;
1033 1336
1034 $self 1337 $self
1035} 1338}
1036 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
1037=item $pl->quit_character 1350=item $pl->quit_character
1038 1351
1039Nukes the player without looking back. If logged in, the connection will 1352Nukes the player without looking back. If logged in, the connection will
1040be destroyed. May block for a long time. 1353be destroyed. May block for a long time.
1041 1354
1088while and may block, so not sync_job-capable, ever. 1401while and may block, so not sync_job-capable, ever.
1089 1402
1090=cut 1403=cut
1091 1404
1092sub list_logins { 1405sub list_logins {
1093 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1406 my $dirs = aio_readdir $PLAYERDIR
1094 or return []; 1407 or return [];
1095 1408
1096 my @logins; 1409 my @logins;
1097 1410
1098 for my $login (@$dirs) { 1411 for my $login (@$dirs) {
1133 } 1446 }
1134 1447
1135 \@paths 1448 \@paths
1136} 1449}
1137 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
1138=item $player->ext_reply ($msgid, %msg) 1501=item $player->ext_reply ($msgid, @msg)
1139 1502
1140Sends an ext reply to the player. 1503Sends an ext reply to the player.
1141 1504
1142=cut 1505=cut
1143 1506
1144sub ext_reply($$%) { 1507sub ext_reply($$@) {
1145 my ($self, $id, %msg) = @_; 1508 my ($self, $id, @msg) = @_;
1146 1509
1147 $msg{msgid} = $id; 1510 if ($self->ns->extcmd == 2) {
1148 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1149 $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 }
1150} 1517}
1151 1518
1152=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1153 1520
1154Sends an ext event to the client. 1521Sends an ext event to the client.
1155 1522
1156=cut 1523=cut
1157 1524
1158sub ext_event($$%) { 1525sub ext_msg($$@) {
1159 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1160 1527
1161 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1162} 1529}
1163 1530
1164=head3 cf::region 1531=head3 cf::region
1165 1532
1166=over 4 1533=over 4
1169 1536
1170package cf::region; 1537package cf::region;
1171 1538
1172=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1173 1540
1174Tries to decuce the probable region for a map knowing only its path. 1541Tries to decuce the likely region for a map knowing only its path.
1175 1542
1176=cut 1543=cut
1177 1544
1178sub find_by_path($) { 1545sub find_by_path($) {
1179 my ($path) = @_; 1546 my ($path) = @_;
1180 1547
1181 my ($match, $specificity); 1548 my ($match, $specificity);
1182 1549
1183 for my $region (list) { 1550 for my $region (list) {
1184 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1185 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1186 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1187 } 1554 }
1188 } 1555 }
1189 1556
1253 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1254 1621
1255 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1256 local $self->{path}; 1623 local $self->{path};
1257 local $self->{load_path}; 1624 local $self->{load_path};
1258 local $self->{deny_save};
1259 local $self->{deny_reset};
1260 1625
1261 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1262} 1627}
1263 1628
1264sub normalise { 1629sub normalise {
1311 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1312 return $self; 1677 return $self;
1313 } 1678 }
1314 } 1679 }
1315 1680
1316 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1317 () 1682 ()
1318} 1683}
1319 1684
1320sub init { 1685sub init {
1321 my ($self) = @_; 1686 my ($self) = @_;
1336 1701
1337# the original (read-only) location 1702# the original (read-only) location
1338sub load_path { 1703sub load_path {
1339 my ($self) = @_; 1704 my ($self) = @_;
1340 1705
1341 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1342} 1707}
1343 1708
1344# the temporary/swap location 1709# the temporary/swap location
1345sub save_path { 1710sub save_path {
1346 my ($self) = @_; 1711 my ($self) = @_;
1347 1712
1348 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1349 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1350} 1715}
1351 1716
1352# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1353sub uniq_path { 1718sub uniq_path {
1354 my ($self) = @_; 1719 my ($self) = @_;
1355 1720
1356 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1357 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1358} 1723}
1359 1724
1360# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1361# all maps in C++... 1726# all maps in C++...
1362sub change_all_map_light { 1727sub change_all_map_light {
1363 my ($change) = @_; 1728 my ($change) = @_;
1364 1729
1365 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1366 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;
1367} 1740}
1368 1741
1369sub unlink_save { 1742sub unlink_save {
1370 my ($self) = @_; 1743 my ($self) = @_;
1371 1744
1429 $self->load_header_orig 1802 $self->load_header_orig
1430 or return; 1803 or return;
1431 $self->prepare_orig; 1804 $self->prepare_orig;
1432 } 1805 }
1433 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1434 $self->default_region (cf::region::find_by_path $self->{path}) 1810 $self->default_region (cf::region::find_by_path $self->{path})
1435 unless $self->default_region; 1811 unless $self->default_region;
1436 1812
1437 1 1813 1
1438} 1814}
1453 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1454 1830
1455 $map->load_header 1831 $map->load_header
1456 or return; 1832 or return;
1457 1833
1458 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1459 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1460 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1461 $map->reset; 1837 $map->reset;
1462 undef $guard; 1838 undef $guard;
1463 return find $path; 1839 return find $path;
1474 my ($self) = @_; 1850 my ($self) = @_;
1475 1851
1476 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1477 1853
1478 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1479 my $guard = cf::lock_acquire "map_load:$path"; 1857 my $guard = cf::lock_acquire "map_load:$path";
1480 1858
1481 return if $self->in_memory != cf::MAP_SWAPPED; 1859 return if $self->in_memory != cf::MAP_SWAPPED;
1482 1860
1483 $self->in_memory (cf::MAP_LOADING); 1861 $self->in_memory (cf::MAP_LOADING);
1484 1862
1485 $self->alloc; 1863 $self->alloc;
1486 1864
1487 $self->pre_load; 1865 $self->pre_load;
1488
1489 $self->_load_objects ($self->{load_path}, 1)
1490 or return;
1491
1492 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1493 if delete $self->{load_original};
1494
1495 if (my $uniq = $self->uniq_path) {
1496 utf8::encode $uniq;
1497 if (aio_open $uniq, O_RDONLY, 0) {
1498 $self->clear_unique_items;
1499 $self->_load_objects ($uniq, 0);
1500 }
1501 }
1502
1503 Coro::cede;
1504
1505 # now do the right thing for maps
1506 $self->link_multipart_objects;
1507
1508 unless ($self->{deny_activate}) {
1509 $self->decay_objects;
1510 $self->fix_auto_apply;
1511 $self->update_buttons;
1512 Coro::cede; 1866 Coro::cede;
1513 $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;
1514 $self->difficulty ($self->estimate_difficulty) 1885 $self->difficulty ($self->estimate_difficulty)
1515 unless $self->difficulty; 1886 unless $self->difficulty;
1516 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;
1517 $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);
1518 } 1903 }
1519 1904
1520 $self->post_load; 1905 $self->post_load;
1521
1522 $self->in_memory (cf::MAP_IN_MEMORY);
1523} 1906}
1524 1907
1525sub customise_for { 1908sub customise_for {
1526 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1527 1910
1528 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1529 if $self->per_player; 1912 if $self->per_player;
1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1530 1916
1531 $self 1917 $self
1532} 1918}
1533 1919
1534# 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
1581 1967
1582 undef $MAP_PREFETCH{$path}; 1968 undef $MAP_PREFETCH{$path};
1583 $MAP_PREFETCHER ||= cf::async { 1969 $MAP_PREFETCHER ||= cf::async {
1584 while (%MAP_PREFETCH) { 1970 while (%MAP_PREFETCH) {
1585 for my $path (keys %MAP_PREFETCH) { 1971 for my $path (keys %MAP_PREFETCH) {
1586 my $map = find $path 1972 if (my $map = find $path) {
1587 or next;
1588 $map->load; 1973 $map->load;
1974 }
1589 1975
1590 delete $MAP_PREFETCH{$path}; 1976 delete $MAP_PREFETCH{$path};
1591 } 1977 }
1592 } 1978 }
1593 undef $MAP_PREFETCHER; 1979 undef $MAP_PREFETCHER;
1645 2031
1646sub reset_at { 2032sub reset_at {
1647 my ($self) = @_; 2033 my ($self) = @_;
1648 2034
1649 # TODO: safety, remove and allow resettable per-player maps 2035 # TODO: safety, remove and allow resettable per-player maps
1650 return 1e99 if $self->isa ("ext::map_per_player");#d#
1651 return 1e99 if $self->{deny_reset}; 2036 return 1e99 if $self->{deny_reset};
1652 2037
1653 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2038 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1654 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;
1655 2040
1666 my ($self) = @_; 2051 my ($self) = @_;
1667 2052
1668 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1669 2054
1670 return if $self->players; 2055 return if $self->players;
1671 return if $self->isa ("ext::map_per_player");#d#
1672 2056
1673 warn "resetting map ", $self->path;#d# 2057 warn "resetting map ", $self->path;
1674 2058
1675 $self->in_memory (cf::MAP_SWAPPED); 2059 $self->in_memory (cf::MAP_SWAPPED);
1676 2060
1677 # need to save uniques path 2061 # need to save uniques path
1678 unless ($self->{deny_save}) { 2062 unless ($self->{deny_save}) {
1710 $cf::MAP{$self->path} = $self; 2094 $cf::MAP{$self->path} = $self;
1711 2095
1712 $self->reset; # polite request, might not happen 2096 $self->reset; # polite request, might not happen
1713} 2097}
1714 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
1715=item cf::map::unique_maps 2135=item cf::map::unique_maps
1716 2136
1717Returns an arrayref of paths of all shared maps that have 2137Returns an arrayref of paths of all shared maps that have
1718instantiated unique items. May block. 2138instantiated unique items. May block.
1719 2139
1720=cut 2140=cut
1721 2141
1722sub unique_maps() { 2142sub unique_maps() {
1723 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2143 [
1724 or return; 2144 map {
1725
1726 my @paths;
1727
1728 for (@$files) {
1729 utf8::decode $_; 2145 utf8::decode $_;
1730 next if /\.pst$/; 2146 /\.map$/
1731 next unless /^$PATH_SEP/o; 2147 ? normalise $_
1732 2148 : ()
1733 push @paths, cf::map::normalise $_; 2149 } @{ aio_readdir $UNIQUEDIR or [] }
1734 } 2150 ]
1735
1736 \@paths
1737} 2151}
1738 2152
1739package cf; 2153package cf;
1740 2154
1741=back 2155=back
1787 2201
1788 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2202 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1789 2203
1790 if ($self->{record_replies}) { 2204 if ($self->{record_replies}) {
1791 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2205 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2206
1792 } 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 {
1793 $msg = $npc->name . " says: $msg" if $npc; 2215 $msg = $npc->name . " says: $msg" if $npc;
1794 $self->message ($msg, $flags); 2216 $self->message ($msg, $flags);
2217 }
1795 } 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 (@_);
1796} 2229}
1797 2230
1798=item $player_object->may ("access") 2231=item $player_object->may ("access")
1799 2232
1800Returns wether the given player is authorized to access resource "access" 2233Returns wether the given player is authorized to access resource "access"
1847 $self->deactivate_recursive; 2280 $self->deactivate_recursive;
1848 2281
1849 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2282 return if UNIVERSAL::isa $self->map, "ext::map_link";
1850 2283
1851 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2284 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1852 if $self->map; 2285 if $self->map && $self->map->{path} ne "{link}";
1853 2286
1854 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2287 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1855} 2288}
1856 2289
1857sub cf::object::player::leave_link { 2290sub cf::object::player::leave_link {
1858 my ($self, $map, $x, $y) = @_; 2291 my ($self, $map, $x, $y) = @_;
2292
2293 return unless $self->contr->active;
1859 2294
1860 my $link_pos = delete $self->{_link_pos}; 2295 my $link_pos = delete $self->{_link_pos};
1861 2296
1862 unless ($map) { 2297 unless ($map) {
1863 # restore original map position 2298 # restore original map position
1886 2321
1887 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2322 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1888 $self->enter_map ($map, $x, $y); 2323 $self->enter_map ($map, $x, $y);
1889} 2324}
1890 2325
1891cf::player->attach ( 2326=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1892 on_logout => sub {
1893 my ($pl) = @_;
1894 2327
1895 # abort map switching before logout 2328Moves the player to the given map-path and coordinates by first freezing
1896 if ($pl->ob->{_link_pos}) { 2329her, loading and preparing them map, calling the provided $check callback
1897 cf::sync_job { 2330that has to return the map if sucecssful, and then unfreezes the player on
1898 $pl->ob->leave_link 2331the new (success) or old (failed) map position. In either case, $done will
1899 }; 2332be called at the end of this process.
1900 }
1901 },
1902 on_login => sub {
1903 my ($pl) = @_;
1904 2333
1905 # try to abort aborted map switching on player login :)
1906 # should happen only on crashes
1907 if ($pl->ob->{_link_pos}) {
1908 $pl->ob->enter_link;
1909 (async {
1910 $pl->ob->reply (undef,
1911 "There was an internal problem at your last logout, "
1912 . "the server will try to bring you to your intended destination in a second.",
1913 cf::NDI_RED);
1914 # we need this sleep as the login has a concurrent enter_exit running
1915 # and this sleep increases chances of the player not ending up in scorn
1916 Coro::Timer::sleep 1;
1917 $pl->ob->leave_link;
1918 })->prio (2);
1919 }
1920 },
1921);
1922
1923=item $player_object->goto ($path, $x, $y)
1924
1925=cut 2334=cut
2335
2336our $GOTOGEN;
1926 2337
1927sub cf::object::player::goto { 2338sub cf::object::player::goto {
1928 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;
1929 2343
1930 $self->enter_link; 2344 $self->enter_link;
1931 2345
1932 (async { 2346 (async {
1933 my $map = eval { 2347 my $map = eval {
1934 my $map = cf::map::find $path; 2348 my $map = cf::map::find $path;
2349
2350 if ($map) {
1935 $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
1936 $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 $@;
1937 } or 2363 }
1938 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1939 2364
2365 if ($gen == $self->{_goto_generation}) {
2366 delete $self->{_goto_generation};
1940 $self->leave_link ($map, $x, $y); 2367 $self->leave_link ($map, $x, $y);
2368 }
2369
2370 $done->() if $done;
1941 })->prio (1); 2371 })->prio (1);
1942} 2372}
1943 2373
1944=item $player_object->enter_exit ($exit_object) 2374=item $player_object->enter_exit ($exit_object)
1945 2375
1984 2414
1985 $rmp->{random_seed} ||= $exit->random_seed; 2415 $rmp->{random_seed} ||= $exit->random_seed;
1986 2416
1987 my $data = cf::to_json $rmp; 2417 my $data = cf::to_json $rmp;
1988 my $md5 = Digest::MD5::md5_hex $data; 2418 my $md5 = Digest::MD5::md5_hex $data;
1989 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2419 my $meta = "$RANDOMDIR/$md5.meta";
1990 2420
1991 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2421 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1992 aio_write $fh, 0, (length $data), $data, 0; 2422 aio_write $fh, 0, (length $data), $data, 0;
1993 undef $fh; 2423 undef $fh;
1994 aio_rename "$meta~", $meta; 2424 aio_rename "$meta~", $meta;
2013 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;
2014 my $hp = $exit->stats->hp; 2444 my $hp = $exit->stats->hp;
2015 my $sp = $exit->stats->sp; 2445 my $sp = $exit->stats->sp;
2016 2446
2017 $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);
2018 2452
2019 (async { 2453 (async {
2020 $self->deactivate_recursive; # just to be sure 2454 $self->deactivate_recursive; # just to be sure
2021 unless (eval { 2455 unless (eval {
2022 $self->goto ($slaying, $hp, $sp); 2456 $self->goto ($slaying, $hp, $sp);
2050 2484
2051 utf8::encode $text; 2485 utf8::encode $text;
2052 $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);
2053} 2487}
2054 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
2055=item $client->ext_event ($type, %msg) 2551=item $client->ext_msg ($type, @msg)
2056 2552
2057Sends an exti event to the client. 2553Sends an ext event to the client.
2058 2554
2059=cut 2555=cut
2060 2556
2061sub cf::client::ext_event($$%) { 2557sub cf::client::ext_msg($$@) {
2062 my ($self, $type, %msg) = @_; 2558 my ($self, $type, @msg) = @_;
2063 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
2064 $msg{msgtype} = "event_$type"; 2565 push @msg, msgtype => "event_$type";
2065 $self->send_packet ("ext " . cf::to_json \%msg); 2566 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2567 }
2066} 2568}
2067 2569
2068=item $success = $client->query ($flags, "text", \&cb) 2570=item $success = $client->query ($flags, "text", \&cb)
2069 2571
2070Queues a query to the client, calling the given callback with 2572Queues a query to the client, calling the given callback with
2071the 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>,
2072C<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>.
2073 2575
2074Queries 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
2075reliable at some point in the future. 2577become reliable at some point in the future.
2076 2578
2077=cut 2579=cut
2078 2580
2079sub cf::client::query { 2581sub cf::client::query {
2080 my ($self, $flags, $text, $cb) = @_; 2582 my ($self, $flags, $text, $cb) = @_;
2088 utf8::encode $text; 2590 utf8::encode $text;
2089 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2591 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2090 2592
2091 $self->send_packet ($self->{query_queue}[0][0]) 2593 $self->send_packet ($self->{query_queue}[0][0])
2092 if @{ $self->{query_queue} } == 1; 2594 if @{ $self->{query_queue} } == 1;
2595
2596 1
2093} 2597}
2094 2598
2095cf::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 },
2096 on_reply => sub { 2605 on_reply => sub {
2097 my ($ns, $msg) = @_; 2606 my ($ns, $msg) = @_;
2098 2607
2099 # this weird shuffling is so that direct followup queries 2608 # this weird shuffling is so that direct followup queries
2100 # get handled first 2609 # get handled first
2112 } else { 2621 } else {
2113 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2622 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2114 } 2623 }
2115 } 2624 }
2116 }, 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 },
2117); 2649);
2118 2650
2119=item $client->async (\&cb) 2651=item $client->async (\&cb)
2120 2652
2121Create a new coroutine, running the specified callback. The coroutine will 2653Create a new coroutine, running the specified callback. The coroutine will
2162our $safe = new Safe "safe"; 2694our $safe = new Safe "safe";
2163our $safe_hole = new Safe::Hole; 2695our $safe_hole = new Safe::Hole;
2164 2696
2165$SIG{FPE} = 'IGNORE'; 2697$SIG{FPE} = 'IGNORE';
2166 2698
2167$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));
2168 2704
2169# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2170 2706
2171=pod 2707=pod
2172 2708
2173The following functions and methods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2174 2710
2175 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
2176 cf::object::player player 2715 cf::object::player
2177 cf::player peaceful 2716 player
2178 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2179 2723
2180=cut 2724=cut
2181 2725
2182for ( 2726for (
2183 ["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)],
2184 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2185 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2186 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2187) { 2732) {
2188 no strict 'refs'; 2733 no strict 'refs';
2259=back 2804=back
2260 2805
2261=cut 2806=cut
2262 2807
2263############################################################################# 2808#############################################################################
2264
2265=head2 EXTENSION DATABASE SUPPORT
2266
2267Crossfire maintains a very simple database for extension use. It can
2268currently store anything that can be serialised using Storable, which
2269excludes objects.
2270
2271The parameter C<$family> should best start with the name of the extension
2272using it, it should be unique.
2273
2274=over 4
2275
2276=item $value = cf::db_get $family => $key
2277
2278Returns a single value from the database.
2279
2280=item cf::db_put $family => $key => $value
2281
2282Stores the given C<$value> in the family.
2283
2284=cut
2285
2286our $DB;
2287
2288sub db_init {
2289 unless ($DB) {
2290 $DB = BDB::db_create $DB_ENV;
2291
2292 cf::sync_job {
2293 eval {
2294 $DB->set_flags (BDB::CHKSUM);
2295
2296 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2297 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2298 cf::cleanup "db_open(db): $!" if $!;
2299 };
2300 cf::cleanup "db_open(db): $@" if $@;
2301 };
2302
2303 my $path = cf::localdir . "/database.pst";
2304 if (stat $path) {
2305 cf::sync_job {
2306 my $pst = Storable::retrieve $path;
2307
2308 cf::db_put (board => data => $pst->{board});
2309 cf::db_put (guildrules => data => $pst->{guildrules});
2310 cf::db_put (rent => balance => $pst->{rent}{balance});
2311 BDB::db_env_txn_checkpoint $DB_ENV;
2312
2313 unlink $path;
2314 };
2315 }
2316 }
2317}
2318
2319sub db_get($$) {
2320 my $key = "$_[0]/$_[1]";
2321
2322 cf::sync_job {
2323 BDB::db_get $DB, undef, $key, my $data;
2324
2325 $! ? ()
2326 : Compress::LZF::sthaw $data
2327 }
2328}
2329
2330sub db_put($$$) {
2331 BDB::dbreq_pri 4;
2332 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2333}
2334
2335#############################################################################
2336# the server's init and main functions 2809# the server's init and main functions
2337 2810
2338sub load_facedata { 2811sub load_facedata($) {
2339 my $path = sprintf "%s/facedata", cf::datadir; 2812 my ($path) = @_;
2340 2813
2341 warn "loading facedata from $path\n"; 2814 warn "loading facedata from $path\n";
2342 2815
2343 my $facedata; 2816 my $facedata;
2344 0 < aio_load $path, $facedata 2817 0 < aio_load $path, $facedata
2352 { 2825 {
2353 my $faces = $facedata->{faceinfo}; 2826 my $faces = $facedata->{faceinfo};
2354 2827
2355 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2356 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2357 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2358 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2359 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2360 Coro::cede; 2834
2835 cf::cede_to_tick;
2361 } 2836 }
2362 2837
2363 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2364 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2365 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2366 or next; 2841 or next;
2367 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2368 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2369 } else { 2845 } else {
2370 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2371 } 2847 }
2372 Coro::cede; 2848
2849 cf::cede_to_tick;
2373 } 2850 }
2374 } 2851 }
2375 2852
2376 { 2853 {
2377 my $anims = $facedata->{animinfo}; 2854 my $anims = $facedata->{animinfo};
2378 2855
2379 while (my ($anim, $info) = each %$anims) { 2856 while (my ($anim, $info) = each %$anims) {
2380 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2381 Coro::cede; 2858 cf::cede_to_tick;
2382 } 2859 }
2383 2860
2384 cf::anim::invalidate_all; # d'oh 2861 cf::anim::invalidate_all; # d'oh
2385 } 2862 }
2386 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 }
2913 }
2914
2387 1 2915 1
2388} 2916}
2389 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
2390sub reload_resources { 2956sub reload_resources {
2391 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2957 warn "reloading resource files...\n";
2392 or die "unable to load regions file\n";#d# 2958
2959 reload_regions;
2393 load_facedata 2960 reload_facedata;
2394 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";
2395} 2966}
2396 2967
2397sub init { 2968sub init {
2398 reload_resources; 2969 reload_resources;
2399} 2970}
2400 2971
2401sub cfg_load { 2972sub cfg_load {
2402 open my $fh, "<:utf8", cf::confdir . "/config" 2973 open my $fh, "<:utf8", "$CONFDIR/config"
2403 or return; 2974 or return;
2404 2975
2405 local $/; 2976 local $/;
2406 *CFG = YAML::Syck::Load <$fh>; 2977 *CFG = YAML::Syck::Load <$fh>;
2407 2978
2452 }, 3023 },
2453 ); 3024 );
2454 } 3025 }
2455} 3026}
2456 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
2457sub emergency_save() { 3066sub emergency_save() {
2458 my $freeze_guard = cf::freeze_mainloop; 3067 my $freeze_guard = cf::freeze_mainloop;
2459 3068
2460 warn "enter emergency perl save\n"; 3069 warn "enter emergency perl save\n";
2461 3070
2492 3101
2493 warn Carp::longmess "post_cleanup backtrace" 3102 warn Carp::longmess "post_cleanup backtrace"
2494 if $make_core; 3103 if $make_core;
2495} 3104}
2496 3105
2497sub reload() { 3106sub do_reload_perl() {
2498 # can/must only be called in main 3107 # can/must only be called in main
2499 if ($Coro::current != $Coro::main) { 3108 if ($Coro::current != $Coro::main) {
2500 warn "can only reload from main coroutine"; 3109 warn "can only reload from main coroutine";
2501 return; 3110 return;
2502 } 3111 }
2536 %EXT_CORO = (); 3145 %EXT_CORO = ();
2537 3146
2538 warn "removing commands"; 3147 warn "removing commands";
2539 %COMMAND = (); 3148 %COMMAND = ();
2540 3149
2541 warn "removing ext commands"; 3150 warn "removing ext/exti commands";
2542 %EXTCMD = (); 3151 %EXTCMD = ();
3152 %EXTICMD = ();
2543 3153
2544 warn "unloading/nuking all extensions"; 3154 warn "unloading/nuking all extensions";
2545 for my $pkg (@EXTS) { 3155 for my $pkg (@EXTS) {
2546 warn "... unloading $pkg"; 3156 warn "... unloading $pkg";
2547 3157
2577 Symbol::delete_package "safe::$_" 3187 Symbol::delete_package "safe::$_"
2578 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);
2579 3189
2580 warn "unloading cf.pm \"a bit\""; 3190 warn "unloading cf.pm \"a bit\"";
2581 delete $INC{"cf.pm"}; 3191 delete $INC{"cf.pm"};
3192 delete $INC{"cf/pod.pm"};
2582 3193
2583 # don't, removes xs symbols, too, 3194 # don't, removes xs symbols, too,
2584 # and global variables created in xs 3195 # and global variables created in xs
2585 #Symbol::delete_package __PACKAGE__; 3196 #Symbol::delete_package __PACKAGE__;
2586 3197
2601 warn "reattaching attachments to maps"; 3212 warn "reattaching attachments to maps";
2602 reattach $_ for values %MAP; 3213 reattach $_ for values %MAP;
2603 warn "reattaching attachments to players"; 3214 warn "reattaching attachments to players";
2604 reattach $_ for values %PLAYER; 3215 reattach $_ for values %PLAYER;
2605 3216
2606 warn "loading reloadable resources";
2607 reload_resources;
2608
2609 warn "leaving sync_job"; 3217 warn "leaving sync_job";
2610 3218
2611 1 3219 1
2612 } or do { 3220 } or do {
2613 warn $@; 3221 warn $@;
2618 warn "reloaded"; 3226 warn "reloaded";
2619}; 3227};
2620 3228
2621our $RELOAD_WATCHER; # used only during reload 3229our $RELOAD_WATCHER; # used only during reload
2622 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
2623register_command "reload" => sub { 3246register_command "reload" => sub {
2624 my ($who, $arg) = @_; 3247 my ($who, $arg) = @_;
2625 3248
2626 if ($who->flag (FLAG_WIZ)) { 3249 if ($who->flag (FLAG_WIZ)) {
2627 $who->message ("reloading server."); 3250 $who->message ("reloading server.");
2628 3251 async { reload_perl };
2629 # doing reload synchronously and two reloads happen back-to-back,
2630 # coro crashes during coro_state_free->destroy here.
2631
2632 $RELOAD_WATCHER ||= Event->timer (
2633 reentrant => 0,
2634 after => 0,
2635 data => WF_AUTOCANCEL,
2636 cb => sub {
2637 reload;
2638 undef $RELOAD_WATCHER;
2639 },
2640 );
2641 } 3252 }
2642}; 3253};
2643 3254
2644unshift @INC, $LIBDIR; 3255unshift @INC, $LIBDIR;
2645 3256
2646my $bug_warning = 0; 3257my $bug_warning = 0;
2647 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;
2648$TICK_WATCHER = Event->timer ( 3282$TICK_WATCHER = Event->timer (
2649 reentrant => 0, 3283 reentrant => 0,
2650 parked => 1, 3284 parked => 1,
2651 prio => 0, 3285 prio => 0,
2652 at => $NEXT_TICK || $TICK, 3286 at => $NEXT_TICK || $TICK,
2656 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"
2657 unless ++$bug_warning > 10; 3291 unless ++$bug_warning > 10;
2658 return; 3292 return;
2659 } 3293 }
2660 3294
2661 $NOW = Event::time; 3295 $NOW = $tick_start = Event::time;
2662 3296
2663 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
2664 $RUNTIME += $TICK; 3322 $RUNTIME += $TICK;
2665 $NEXT_TICK += $TICK; 3323 $NEXT_TICK += $TICK;
2666 3324
2667 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3325 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2668 $NEXT_RUNTIME_WRITE = $NOW + 10; 3326 $NEXT_RUNTIME_WRITE = $NOW + 10;
2670 write_runtime 3328 write_runtime
2671 or warn "ERROR: unable to write runtime file: $!"; 3329 or warn "ERROR: unable to write runtime file: $!";
2672 }; 3330 };
2673 } 3331 }
2674 3332
2675 $WAIT_FOR_TICK->broadcast;
2676 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2677
2678# my $AFTER = Event::time; 3333# my $AFTER = Event::time;
2679# warn $AFTER - $NOW;#d# 3334# warn $AFTER - $NOW;#d#
2680 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
2681 # 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
2682 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3346 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2683 3347
2684 $TICK_WATCHER->at ($NEXT_TICK); 3348 $TICK_WATCHER->at ($NEXT_TICK);
2685 $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
2686 }, 3357 },
2687); 3358);
2688 3359
2689{ 3360{
2690 BDB::max_poll_time $TICK * 0.1; 3361 BDB::max_poll_time $TICK * 0.1;
2718 3389
2719 cf::sync_job { 3390 cf::sync_job {
2720 eval { 3391 eval {
2721 BDB::db_env_open 3392 BDB::db_env_open
2722 $DB_ENV, 3393 $DB_ENV,
2723 $BDB_ENV_DIR, 3394 $BDBDIR,
2724 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
2725 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3396 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2726 0666; 3397 0666;
2727 3398
2728 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3399 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2729 3400
2730 $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);
2731 $DB_ENV->set_lk_detect; 3402 $DB_ENV->set_lk_detect;
2732 }; 3403 };
2733 3404
2749 prio => 6, 3420 prio => 6,
2750 cb => \&IO::AIO::poll_cb, 3421 cb => \&IO::AIO::poll_cb,
2751 ); 3422 );
2752} 3423}
2753 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
2754END { cf::emergency_save } 3466END { cf::emergency_save }
2755 3467
27561 34681
2757 3469

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines