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.159 by root, Wed Jan 10 22:50:12 2007 UTC vs.
Revision 1.475 by root, Tue Jul 21 06:17:00 2009 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18#
19# The authors can be reached via e-mail to <support@deliantra.net>
20#
21
1package cf; 22package cf;
2 23
24use 5.10.0;
3use utf8; 25use utf8;
4use strict; 26use strict qw(vars subs);
5 27
6use Symbol; 28use Symbol;
7use List::Util; 29use List::Util;
8use Storable; 30use Socket;
31use EV;
9use Opcode; 32use Opcode;
10use Safe; 33use Safe;
11use Safe::Hole; 34use Safe::Hole;
35use Storable ();
12 36
37use Guard ();
13use Coro 3.3 (); 38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
14use Coro::Event; 42use Coro::AnyEvent;
15use Coro::Timer; 43use Coro::Timer;
16use Coro::Signal; 44use Coro::Signal;
17use Coro::Semaphore; 45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
18use Coro::AIO; 48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
19 52
53use JSON::XS 2.01 ();
54use BDB ();
20use Data::Dumper; 55use Data::Dumper;
21use Digest::MD5; 56use Digest::MD5;
22use Fcntl; 57use Fcntl;
58use YAML ();
23use IO::AIO 2.32 (); 59use IO::AIO ();
24use YAML::Syck ();
25use Time::HiRes; 60use Time::HiRes;
61use Compress::LZF;
62use Digest::MD5 ();
26 63
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 64AnyEvent::detect;
65
66# configure various modules to our taste
67#
68$Storable::canonical = 1; # reduce rsync transfers
69Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
70
71$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
72
73# make sure c-lzf reinitialises itself
74Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
75Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
76
77# strictly for debugging
78$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
28 79
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 80sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1;
33
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 81
36our %COMMAND = (); 82our %COMMAND = ();
37our %COMMAND_TIME = (); 83our %COMMAND_TIME = ();
38 84
39our @EXTS = (); # list of extension package names 85our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 86our %EXTCMD = ();
87our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 88our %EXT_CORO = (); # coroutines bound to extensions
89our %EXT_MAP = (); # pluggable maps
42 90
91our $RELOAD; # number of reloads so far, non-zero while in reload
43our @EVENT; 92our @EVENT;
44our $LIBDIR = datadir . "/ext";
45 93
46our $TICK = MAX_TIME * 1e-6; 94our $CONFDIR = confdir;
47our $TICK_WATCHER; 95our $DATADIR = datadir;
96our $LIBDIR = "$DATADIR/ext";
97our $PODDIR = "$DATADIR/pod";
98our $MAPDIR = "$DATADIR/" . mapdir;
99our $LOCALDIR = localdir;
100our $TMPDIR = "$LOCALDIR/" . tmpdir;
101our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
102our $PLAYERDIR = "$LOCALDIR/" . playerdir;
103our $RANDOMDIR = "$LOCALDIR/random";
104our $BDBDIR = "$LOCALDIR/db";
105our $PIDFILE = "$LOCALDIR/pid";
106our $RUNTIMEFILE = "$LOCALDIR/runtime";
107
108our %RESOURCE;
109
110our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
111our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
48our $NEXT_TICK; 112our $NEXT_TICK;
49our $NOW; 113our $USE_FSYNC = 1; # use fsync to write maps - default on
114
115our $BDB_DEADLOCK_WATCHER;
116our $BDB_CHECKPOINT_WATCHER;
117our $BDB_TRICKLE_WATCHER;
118our $DB_ENV;
119
120our @EXTRA_MODULES = qw(pod mapscript);
50 121
51our %CFG; 122our %CFG;
52 123
53our $UPTIME; $UPTIME ||= time; 124our $UPTIME; $UPTIME ||= time;
54our $RUNTIME; 125our $RUNTIME;
126our $NOW;
55 127
56our %PLAYER; # all users 128our (%PLAYER, %PLAYER_LOADING); # all users
57our %MAP; # all maps 129our (%MAP, %MAP_LOADING ); # all maps
58our $LINK_MAP; # the special {link} map 130our $LINK_MAP; # the special {link} map, which is always available
59our $RANDOM_MAPS = cf::localdir . "/random";
60 131
61our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; 132# used to convert map paths into valid unix filenames by replacing / by ∕
62our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; 133our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
134
135our $LOAD; # a number between 0 (idle) and 1 (too many objects)
136our $LOADAVG; # same thing, but with alpha-smoothing
137our $JITTER; # average jitter
138our $TICK_START; # for load detecting purposes
139
140our @POST_INIT;
141
142our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
143our $REALLY_UNLOOP; # never set to true, please :)
63 144
64binmode STDOUT; 145binmode STDOUT;
65binmode STDERR; 146binmode STDERR;
66 147
67# read virtual server time, if available 148# read virtual server time, if available
68unless ($RUNTIME || !-e cf::localdir . "/runtime") { 149unless ($RUNTIME || !-e $RUNTIMEFILE) {
69 open my $fh, "<", cf::localdir . "/runtime" 150 open my $fh, "<", $RUNTIMEFILE
70 or die "unable to read runtime file: $!"; 151 or die "unable to read $RUNTIMEFILE file: $!";
71 $RUNTIME = <$fh> + 0.; 152 $RUNTIME = <$fh> + 0.;
72} 153}
73 154
74mkdir cf::localdir; 155eval "sub TICK() { $TICK } 1" or die;
75mkdir cf::localdir . "/" . cf::playerdir;
76mkdir cf::localdir . "/" . cf::tmpdir;
77mkdir cf::localdir . "/" . cf::uniquedir;
78mkdir $RANDOM_MAPS;
79 156
80# a special map that is always available 157mkdir $_
81our $LINK_MAP; 158 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
159
82our $EMERGENCY_POSITION; 160our $EMERGENCY_POSITION;
161
162sub cf::map::normalise;
83 163
84############################################################################# 164#############################################################################
85 165
86=head2 GLOBAL VARIABLES 166=head2 GLOBAL VARIABLES
87 167
94=item $cf::RUNTIME 174=item $cf::RUNTIME
95 175
96The time this server has run, starts at 0 and is increased by $cf::TICK on 176The time this server has run, starts at 0 and is increased by $cf::TICK on
97every server tick. 177every server tick.
98 178
99=item $cf::LIBDIR 179=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
180$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
181$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
100 182
101The perl library directory, where extensions and cf-specific modules can 183Various directories - "/etc", read-only install directory, perl-library
102be found. It will be added to C<@INC> automatically. 184directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
185unique-items directory, player file directory, random maps directory and
186database environment.
103 187
104=item $cf::NOW 188=item $cf::NOW
105 189
106The time of the last (current) server tick. 190The time of the last (current) server tick.
107 191
108=item $cf::TICK 192=item $cf::TICK
109 193
110The interval between server ticks, in seconds. 194The interval between server ticks, in seconds.
111 195
196=item $cf::LOADAVG
197
198The current CPU load on the server (alpha-smoothed), as a value between 0
199(none) and 1 (overloaded), indicating how much time is spent on processing
200objects per tick. Healthy values are < 0.5.
201
202=item $cf::LOAD
203
204The raw value load value from the last tick.
205
112=item %cf::CFG 206=item %cf::CFG
113 207
114Configuration for the server, loaded from C</etc/crossfire/config>, or 208Configuration for the server, loaded from C</etc/deliantra-server/config>, or
115from wherever your confdir points to. 209from wherever your confdir points to.
116 210
117=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 211=item cf::wait_for_tick, cf::wait_for_tick_begin
118 212
119These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 213These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
120or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 214returns directly I<after> the tick processing (and consequently, can only wake one process
121processing has been done. Call C<< ->wait >> on them to maximise the 215per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
122window of cpu time available, or simply to synchronise to the server tick. 216
217=item @cf::INVOKE_RESULTS
218
219This array contains the results of the last C<invoke ()> call. When
220C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
221that call.
123 222
124=back 223=back
125 224
126=cut 225=cut
127 226
128BEGIN { 227BEGIN {
129 *CORE::GLOBAL::warn = sub { 228 *CORE::GLOBAL::warn = sub {
130 my $msg = join "", @_; 229 my $msg = join "", @_;
131 utf8::encode $msg;
132 230
133 $msg .= "\n" 231 $msg .= "\n"
134 unless $msg =~ /\n$/; 232 unless $msg =~ /\n$/;
135 233
234 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
235
136 LOG llevError, $msg; 236 LOG llevError, $msg;
137 }; 237 };
138} 238}
239
240$Coro::State::DIEHOOK = sub {
241 return unless $^S eq 0; # "eq", not "=="
242
243 if ($Coro::current == $Coro::main) {#d#
244 warn "DIEHOOK called in main context, Coro bug?\n";#d#
245 return;#d#
246 }#d#
247
248 # kill coroutine otherwise
249 warn Carp::longmess $_[0];
250 Coro::terminate
251};
252
253$SIG{__DIE__} = sub { }; #d#?
139 254
140@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 255@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
141@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 256@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
142@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 257@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
143@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 258@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
144@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 259@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
260@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
145@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 261@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
146 262
147# we bless all objects into (empty) derived classes to force a method lookup 263# we bless all objects into (empty) derived classes to force a method lookup
148# within the Safe compartment. 264# within the Safe compartment.
149for my $pkg (qw( 265for my $pkg (qw(
150 cf::global cf::attachable 266 cf::global cf::attachable
151 cf::object cf::object::player 267 cf::object cf::object::player
152 cf::client cf::player 268 cf::client cf::player
153 cf::arch cf::living 269 cf::arch cf::living
270 cf::map cf::mapspace
154 cf::map cf::party cf::region 271 cf::party cf::region
155)) { 272)) {
156 no strict 'refs';
157 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 273 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
158} 274}
159 275
160$Event::DIED = sub { 276$EV::DIED = sub {
161 warn "error in event callback: @_"; 277 warn "error in event callback: @_";
162}; 278};
279
280#############################################################################
163 281
164=head2 UTILITY FUNCTIONS 282=head2 UTILITY FUNCTIONS
165 283
166=over 4 284=over 4
167 285
186 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 304 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
187 $d 305 $d
188 } || "[unable to dump $_[0]: '$@']"; 306 } || "[unable to dump $_[0]: '$@']";
189} 307}
190 308
191use JSON::Syck (); # TODO# replace by JSON::PC once working
192
193=item $ref = cf::from_json $json 309=item $ref = cf::decode_json $json
194 310
195Converts a JSON string into the corresponding perl data structure. 311Converts a JSON string into the corresponding perl data structure.
196 312
197=cut
198
199sub from_json($) {
200 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
201 JSON::Syck::Load $_[0]
202}
203
204=item $json = cf::to_json $ref 313=item $json = cf::encode_json $ref
205 314
206Converts a perl data structure into its JSON representation. 315Converts a perl data structure into its JSON representation.
207 316
208=cut 317=cut
209 318
210sub to_json($) { 319our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
211 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 320
212 JSON::Syck::Dump $_[0] 321sub encode_json($) { $json_coder->encode ($_[0]) }
322sub decode_json($) { $json_coder->decode ($_[0]) }
323
324=item cf::post_init { BLOCK }
325
326Execute the given codeblock, I<after> all extensions have been (re-)loaded,
327but I<before> the server starts ticking again.
328
329The cdoeblock will have a single boolean argument to indicate whether this
330is a reload or not.
331
332=cut
333
334sub post_init(&) {
335 push @POST_INIT, shift;
213} 336}
214 337
215=item cf::lock_wait $string 338=item cf::lock_wait $string
216 339
217Wait until the given lock is available. See cf::lock_acquire. 340Wait until the given lock is available. See cf::lock_acquire.
218 341
219=item my $lock = cf::lock_acquire $string 342=item my $lock = cf::lock_acquire $string
220 343
221Wait until the given lock is available and then acquires it and returns 344Wait until the given lock is available and then acquires it and returns
222a Coro::guard object. If the guard object gets destroyed (goes out of scope, 345a L<Guard> object. If the guard object gets destroyed (goes out of scope,
223for example when the coroutine gets canceled), the lock is automatically 346for example when the coroutine gets canceled), the lock is automatically
224returned. 347returned.
225 348
349Locks are *not* recursive, locking from the same coro twice results in a
350deadlocked coro.
351
226Lock names should begin with a unique identifier (for example, cf::map::find 352Lock names should begin with a unique identifier (for example, cf::map::find
227uses map_find and cf::map::load uses map_load). 353uses map_find and cf::map::load uses map_load).
228 354
229=cut 355=item $locked = cf::lock_active $string
230 356
231our %LOCK; 357Return true if the lock is currently active, i.e. somebody has locked it.
358
359=cut
360
361our $LOCKS = new Coro::SemaphoreSet;
232 362
233sub lock_wait($) { 363sub lock_wait($) {
234 my ($key) = @_; 364 $LOCKS->wait ($_[0]);
235
236 # wait for lock, if any
237 while ($LOCK{$key}) {
238 push @{ $LOCK{$key} }, $Coro::current;
239 Coro::schedule;
240 }
241} 365}
242 366
243sub lock_acquire($) { 367sub lock_acquire($) {
244 my ($key) = @_; 368 $LOCKS->guard ($_[0])
369}
245 370
246 # wait, to be sure we are not locked 371sub lock_active($) {
247 lock_wait $key; 372 $LOCKS->count ($_[0]) < 1
248
249 $LOCK{$key} = [];
250
251 Coro::guard {
252 # wake up all waiters, to be on the safe side
253 $_->ready for @{ delete $LOCK{$key} };
254 }
255} 373}
256 374
257sub freeze_mainloop { 375sub freeze_mainloop {
258 return unless $TICK_WATCHER->is_active; 376 tick_inhibit_inc;
259 377
260 my $guard = Coro::guard { $TICK_WATCHER->start }; 378 &Guard::guard (\&tick_inhibit_dec);
261 $TICK_WATCHER->stop; 379}
262 $guard 380
381=item cf::periodic $interval, $cb
382
383Like EV::periodic, but randomly selects a starting point so that the actions
384get spread over timer.
385
386=cut
387
388sub periodic($$) {
389 my ($interval, $cb) = @_;
390
391 my $start = rand List::Util::min 180, $interval;
392
393 EV::periodic $start, $interval, 0, $cb
394}
395
396=item cf::get_slot $time[, $priority[, $name]]
397
398Allocate $time seconds of blocking CPU time at priority C<$priority>:
399This call blocks and returns only when you have at least C<$time> seconds
400of cpu time till the next tick. The slot is only valid till the next cede.
401
402The optional C<$name> can be used to identify the job to run. It might be
403used for statistical purposes and should identify the same time-class.
404
405Useful for short background jobs.
406
407=cut
408
409our @SLOT_QUEUE;
410our $SLOT_QUEUE;
411
412$SLOT_QUEUE->cancel if $SLOT_QUEUE;
413$SLOT_QUEUE = Coro::async {
414 $Coro::current->desc ("timeslot manager");
415
416 my $signal = new Coro::Signal;
417
418 while () {
419 next_job:
420 my $avail = cf::till_tick;
421 if ($avail > 0.01) {
422 for (0 .. $#SLOT_QUEUE) {
423 if ($SLOT_QUEUE[$_][0] < $avail) {
424 my $job = splice @SLOT_QUEUE, $_, 1, ();
425 $job->[2]->send;
426 Coro::cede;
427 goto next_job;
428 }
429 }
430 }
431
432 if (@SLOT_QUEUE) {
433 # we do not use wait_for_tick() as it returns immediately when tick is inactive
434 push @cf::WAIT_FOR_TICK, $signal;
435 $signal->wait;
436 } else {
437 Coro::schedule;
438 }
439 }
440};
441
442sub get_slot($;$$) {
443 return if tick_inhibit || $Coro::current == $Coro::main;
444
445 my ($time, $pri, $name) = @_;
446
447 $time = $TICK * .6 if $time > $TICK * .6;
448 my $sig = new Coro::Signal;
449
450 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
451 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
452 $SLOT_QUEUE->ready;
453 $sig->wait;
263} 454}
264 455
265=item cf::async { BLOCK } 456=item cf::async { BLOCK }
266 457
267Currently the same as Coro::async_pool, meaning you cannot use 458Currently the same as Coro::async_pool, meaning you cannot use
272 463
273BEGIN { *async = \&Coro::async_pool } 464BEGIN { *async = \&Coro::async_pool }
274 465
275=item cf::sync_job { BLOCK } 466=item cf::sync_job { BLOCK }
276 467
277The design of crossfire+ requires that the main coro ($Coro::main) is 468The design of Deliantra requires that the main coroutine ($Coro::main)
278always able to handle events or runnable, as crossfire+ is only partly 469is always able to handle events or runnable, as Deliantra is only
279reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 470partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
471acceptable.
280 472
281If it must be done, put the blocking parts into C<sync_job>. This will run 473If it must be done, put the blocking parts into C<sync_job>. This will run
282the given BLOCK in another coroutine while waiting for the result. The 474the given BLOCK in another coroutine while waiting for the result. The
283server will be frozen during this time, so the block should either finish 475server will be frozen during this time, so the block should either finish
284fast or be very important. 476fast or be very important.
287 479
288sub sync_job(&) { 480sub sync_job(&) {
289 my ($job) = @_; 481 my ($job) = @_;
290 482
291 if ($Coro::current == $Coro::main) { 483 if ($Coro::current == $Coro::main) {
484 my $time = EV::time;
485
292 # this is the main coro, too bad, we have to block 486 # this is the main coro, too bad, we have to block
293 # till the operation succeeds, freezing the server :/ 487 # till the operation succeeds, freezing the server :/
294 488
295 # TODO: use suspend/resume instead 489 LOG llevError, Carp::longmess "sync job";#d#
296 # (but this is cancel-safe) 490
297 my $freeze_guard = freeze_mainloop; 491 my $freeze_guard = freeze_mainloop;
298 492
299 my $busy = 1; 493 my $busy = 1;
300 my @res; 494 my @res;
301 495
302 (async { 496 (async {
497 $Coro::current->desc ("sync job coro");
303 @res = eval { $job->() }; 498 @res = eval { $job->() };
304 warn $@ if $@; 499 warn $@ if $@;
305 undef $busy; 500 undef $busy;
306 })->prio (Coro::PRIO_MAX); 501 })->prio (Coro::PRIO_MAX);
307 502
308 while ($busy) { 503 while ($busy) {
309 Coro::cede or Event::one_event; 504 if (Coro::nready) {
505 Coro::cede_notself;
506 } else {
507 EV::loop EV::LOOP_ONESHOT;
310 } 508 }
509 }
510
511 my $time = EV::time - $time;
512
513 $TICK_START += $time; # do not account sync jobs to server load
311 514
312 wantarray ? @res : $res[0] 515 wantarray ? @res : $res[0]
313 } else { 516 } else {
314 # we are in another coroutine, how wonderful, everything just works 517 # we are in another coroutine, how wonderful, everything just works
315 518
335 $EXT_CORO{$coro+0} = $coro; 538 $EXT_CORO{$coro+0} = $coro;
336 539
337 $coro 540 $coro
338} 541}
339 542
340sub write_runtime { 543=item fork_call { }, $args
341 my $runtime = cf::localdir . "/runtime";
342 544
343 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 545Executes the given code block with the given arguments in a seperate
344 or return; 546process, returning the results. Everything must be serialisable with
547Coro::Storable. May, of course, block. Note that the executed sub may
548never block itself or use any form of event handling.
345 549
346 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 550=cut
347 (aio_write $fh, 0, (length $value), $value, 0) <= 0
348 and return;
349 551
350 aio_fsync $fh 552sub fork_call(&@) {
351 and return; 553 my ($cb, @args) = @_;
352 554
353 close $fh 555 # we seemingly have to make a local copy of the whole thing,
354 or return; 556 # otherwise perl prematurely frees the stuff :/
557 # TODO: investigate and fix (likely this will be rather laborious)
355 558
356 aio_rename "$runtime~", $runtime 559 my @res = Coro::Util::fork_eval {
357 and return; 560 reset_signals;
561 &$cb
562 }, @args;
358 563
564 wantarray ? @res : $res[-1]
565}
566
567=item $coin = coin_from_name $name
568
569=cut
570
571our %coin_alias = (
572 "silver" => "silvercoin",
573 "silvercoin" => "silvercoin",
574 "silvercoins" => "silvercoin",
575 "gold" => "goldcoin",
576 "goldcoin" => "goldcoin",
577 "goldcoins" => "goldcoin",
578 "platinum" => "platinacoin",
579 "platinumcoin" => "platinacoin",
580 "platinumcoins" => "platinacoin",
581 "platina" => "platinacoin",
582 "platinacoin" => "platinacoin",
583 "platinacoins" => "platinacoin",
584 "royalty" => "royalty",
585 "royalties" => "royalty",
586);
587
588sub coin_from_name($) {
589 $coin_alias{$_[0]}
590 ? cf::arch::find $coin_alias{$_[0]}
591 : undef
592}
593
594=item $value = cf::db_get $family => $key
595
596Returns a single value from the environment database.
597
598=item cf::db_put $family => $key => $value
599
600Stores the given C<$value> in the family. It can currently store binary
601data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
602
603=item $db = cf::db_table "name"
604
605Create and/or open a new database table. The string must not be "db" and must be unique
606within each server.
607
608=cut
609
610sub db_table($) {
611 my ($name) = @_;
612 my $db = BDB::db_create $DB_ENV;
613
614 eval {
615 $db->set_flags (BDB::CHKSUM);
616
617 utf8::encode $name;
618 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
619 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
620 cf::cleanup "db_open(db): $!" if $!;
621 };
622 cf::cleanup "db_open(db): $@" if $@;
623
624 $db
625}
626
627our $DB;
628
629sub db_init {
630 cf::sync_job {
631 $DB ||= db_table "db";
632 };
633}
634
635sub db_get($$) {
636 my $key = "$_[0]/$_[1]";
637
638 cf::sync_job {
639 BDB::db_get $DB, undef, $key, my $data;
640
641 $! ? ()
642 : $data
359 1 643 }
644}
645
646sub db_put($$$) {
647 BDB::dbreq_pri 4;
648 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
649}
650
651=item cf::cache $id => [$paths...], $processversion => $process
652
653Generic caching function that returns the value of the resource $id,
654caching and regenerating as required.
655
656This function can block.
657
658=cut
659
660sub cache {
661 my ($id, $src, $processversion, $process) = @_;
662
663 my $meta =
664 join "\x00",
665 $processversion,
666 map {
667 aio_stat $_
668 and Carp::croak "$_: $!";
669
670 ($_, (stat _)[7,9])
671 } @$src;
672
673 my $dbmeta = db_get cache => "$id/meta";
674 if ($dbmeta ne $meta) {
675 # changed, we may need to process
676
677 my @data;
678 my $md5;
679
680 for (0 .. $#$src) {
681 0 <= aio_load $src->[$_], $data[$_]
682 or Carp::croak "$src->[$_]: $!";
683 }
684
685 # if processing is expensive, check
686 # checksum first
687 if (1) {
688 $md5 =
689 join "\x00",
690 $processversion,
691 map {
692 cf::cede_to_tick;
693 ($src->[$_], Digest::MD5::md5_hex $data[$_])
694 } 0.. $#$src;
695
696
697 my $dbmd5 = db_get cache => "$id/md5";
698 if ($dbmd5 eq $md5) {
699 db_put cache => "$id/meta", $meta;
700
701 return db_get cache => "$id/data";
702 }
703 }
704
705 my $t1 = Time::HiRes::time;
706 my $data = $process->(\@data);
707 my $t2 = Time::HiRes::time;
708
709 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
710
711 db_put cache => "$id/data", $data;
712 db_put cache => "$id/md5" , $md5;
713 db_put cache => "$id/meta", $meta;
714
715 return $data;
716 }
717
718 db_get cache => "$id/data"
719}
720
721=item cf::datalog type => key => value, ...
722
723Log a datalog packet of the given type with the given key-value pairs.
724
725=cut
726
727sub datalog($@) {
728 my ($type, %kv) = @_;
729 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
360} 730}
361 731
362=back 732=back
363 733
364=cut 734=cut
365 735
366############################################################################# 736#############################################################################
367 737
368package cf::path;
369
370use overload
371 '""' => \&as_string;
372
373# used to convert map paths into valid unix filenames by repalcing / by ∕
374our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
375
376sub new {
377 my ($class, $path, $base) = @_;
378
379 $path = $path->as_string if ref $path;
380
381 my $self = bless { }, $class;
382
383 # {... are special paths that are not touched
384 # ?xxx/... are special absolute paths
385 # ?random/... random maps
386 # /! non-realised random map exit
387 # /... normal maps
388 # ~/... per-player maps without a specific player (DO NOT USE)
389 # ~user/... per-player map of a specific user
390
391 $path =~ s/$PATH_SEP/\//go;
392
393 if ($path =~ /^{/) {
394 # fine as it is
395 } elsif ($path =~ s{^\?random/}{}) {
396 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
397 $self->{random} = cf::from_json $data;
398 } else {
399 if ($path =~ s{^~([^/]+)?}{}) {
400 $self->{user_rel} = 1;
401
402 if (defined $1) {
403 $self->{user} = $1;
404 } elsif ($base =~ m{^~([^/]+)/}) {
405 $self->{user} = $1;
406 } else {
407 warn "cannot resolve user-relative path without user <$path,$base>\n";
408 }
409 } elsif ($path =~ /^\//) {
410 # already absolute
411 } else {
412 $base =~ s{[^/]+/?$}{};
413 return $class->new ("$base/$path");
414 }
415
416 for ($path) {
417 redo if s{/\.?/}{/};
418 redo if s{/[^/]+/\.\./}{/};
419 }
420 }
421
422 $self->{path} = $path;
423
424 $self
425}
426
427# the name / primary key / in-game path
428sub as_string {
429 my ($self) = @_;
430
431 $self->{user_rel} ? "~$self->{user}$self->{path}"
432 : $self->{random} ? "?random/$self->{path}"
433 : $self->{path}
434}
435
436# the displayed name, this is a one way mapping
437sub visible_name {
438 my ($self) = @_;
439
440# if (my $rmp = $self->{random}) {
441# # todo: be more intelligent about this
442# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
443# } else {
444 $self->as_string
445# }
446}
447
448# escape the /'s in the path
449sub _escaped_path {
450 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
451 $path
452}
453
454# the original (read-only) location
455sub load_path {
456 my ($self) = @_;
457
458 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
459}
460
461# the temporary/swap location
462sub save_path {
463 my ($self) = @_;
464
465 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
466 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
467 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
468}
469
470# the unique path, might be eq to save_path
471sub uniq_path {
472 my ($self) = @_;
473
474 $self->{user_rel} || $self->{random}
475 ? undef
476 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
477}
478
479# return random map parameters, or undef
480sub random_map_params {
481 my ($self) = @_;
482
483 $self->{random}
484}
485
486# this is somewhat ugly, but style maps do need special treatment
487sub is_style_map {
488 $_[0]{path} =~ m{^/styles/}
489}
490
491package cf;
492
493#############################################################################
494
495=head2 ATTACHABLE OBJECTS 738=head2 ATTACHABLE OBJECTS
496 739
497Many objects in crossfire are so-called attachable objects. That means you can 740Many objects in deliantra are so-called attachable objects. That means you can
498attach callbacks/event handlers (a collection of which is called an "attachment") 741attach callbacks/event handlers (a collection of which is called an "attachment")
499to it. All such attachable objects support the following methods. 742to it. All such attachable objects support the following methods.
500 743
501In the following description, CLASS can be any of C<global>, C<object> 744In the following description, CLASS can be any of C<global>, C<object>
502C<player>, C<client> or C<map> (i.e. the attachable objects in 745C<player>, C<client> or C<map> (i.e. the attachable objects in
503crossfire+). 746Deliantra).
504 747
505=over 4 748=over 4
506 749
507=item $attachable->attach ($attachment, key => $value...) 750=item $attachable->attach ($attachment, key => $value...)
508 751
552=item cf::CLASS::attachment $name, ... 795=item cf::CLASS::attachment $name, ...
553 796
554Register an attachment by C<$name> through which attachable objects of the 797Register an attachment by C<$name> through which attachable objects of the
555given CLASS can refer to this attachment. 798given CLASS can refer to this attachment.
556 799
557Some classes such as crossfire maps and objects can specify attachments 800Some classes such as deliantra maps and objects can specify attachments
558that are attached at load/instantiate time, thus the need for a name. 801that are attached at load/instantiate time, thus the need for a name.
559 802
560These calls expect any number of the following handler/hook descriptions: 803These calls expect any number of the following handler/hook descriptions:
561 804
562=over 4 805=over 4
622our @CB_TYPE = (); # registry for type (cf-object class) based events 865our @CB_TYPE = (); # registry for type (cf-object class) based events
623our @CB_MAP = (); 866our @CB_MAP = ();
624 867
625my %attachment; 868my %attachment;
626 869
870sub cf::attachable::thawer_merge {
871 # simply override everything except _meta
872 local $_[0]{_meta};
873 %{$_[0]} = %{$_[1]};
874}
875
627sub _attach_cb($$$$) { 876sub _attach_cb($$$$) {
628 my ($registry, $event, $prio, $cb) = @_; 877 my ($registry, $event, $prio, $cb) = @_;
629 878
630 use sort 'stable'; 879 use sort 'stable';
631 880
665 $registry = $CB_TYPE[$object_type] ||= []; 914 $registry = $CB_TYPE[$object_type] ||= [];
666 915
667 } elsif ($type eq "subtype") { 916 } elsif ($type eq "subtype") {
668 defined $object_type or Carp::croak "subtype specified without type"; 917 defined $object_type or Carp::croak "subtype specified without type";
669 my $object_subtype = shift @arg; 918 my $object_subtype = shift @arg;
670 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 919 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
671 920
672 } elsif ($type eq "package") { 921 } elsif ($type eq "package") {
673 my $pkg = shift @arg; 922 my $pkg = shift @arg;
674 923
675 while (my ($name, $id) = each %cb_id) { 924 while (my ($name, $id) = each %cb_id) {
704 _attach $registry, $klass, @attach; 953 _attach $registry, $klass, @attach;
705 } 954 }
706 955
707 $obj->{$name} = \%arg; 956 $obj->{$name} = \%arg;
708 } else { 957 } else {
709 warn "object uses attachment '$name' that is not available, postponing.\n"; 958 warn "object uses attachment '$name' which is not available, postponing.\n";
710 } 959 }
711 960
712 $obj->{_attachment}{$name} = undef; 961 $obj->{_attachment}{$name} = undef;
713} 962}
714 963
716 if (ref $_[0]) { 965 if (ref $_[0]) {
717 _object_attach @_; 966 _object_attach @_;
718 } else { 967 } else {
719 _attach shift->_attach_registry, @_; 968 _attach shift->_attach_registry, @_;
720 } 969 }
970 _recalc_want;
721}; 971};
722 972
723# all those should be optimised 973# all those should be optimised
724sub cf::attachable::detach { 974sub cf::attachable::detach {
725 my ($obj, $name) = @_; 975 my ($obj, $name) = @_;
728 delete $obj->{_attachment}{$name}; 978 delete $obj->{_attachment}{$name};
729 reattach ($obj); 979 reattach ($obj);
730 } else { 980 } else {
731 Carp::croak "cannot, currently, detach class attachments"; 981 Carp::croak "cannot, currently, detach class attachments";
732 } 982 }
983 _recalc_want;
733}; 984};
734 985
735sub cf::attachable::attached { 986sub cf::attachable::attached {
736 my ($obj, $name) = @_; 987 my ($obj, $name) = @_;
737 988
752 "; 1003 ";
753 die if $@; 1004 die if $@;
754} 1005}
755 1006
756our $override; 1007our $override;
757our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1008our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
758 1009
759sub override { 1010sub override {
760 $override = 1; 1011 $override = 1;
761 @invoke_results = (); 1012 @INVOKE_RESULTS = (@_);
762} 1013}
763 1014
764sub do_invoke { 1015sub do_invoke {
765 my $event = shift; 1016 my $event = shift;
766 my $callbacks = shift; 1017 my $callbacks = shift;
767 1018
768 @invoke_results = (); 1019 @INVOKE_RESULTS = ();
769 1020
770 local $override; 1021 local $override;
771 1022
772 for (@$callbacks) { 1023 for (@$callbacks) {
773 eval { &{$_->[1]} }; 1024 eval { &{$_->[1]} };
782 } 1033 }
783 1034
784 0 1035 0
785} 1036}
786 1037
787=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1038=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
788 1039
789=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1040=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
790 1041
791Generate an object-specific event with the given arguments. 1042Generate an object-specific event with the given arguments.
792 1043
793This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1044This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
794removed in future versions), and there is no public API to access override 1045removed in future versions), and there is no public API to access override
795results (if you must, access C<@cf::invoke_results> directly). 1046results (if you must, access C<@cf::INVOKE_RESULTS> directly).
796 1047
797=back 1048=back
798 1049
799=cut 1050=cut
800 1051
801############################################################################# 1052#############################################################################
802# object support 1053# object support
1054
1055sub _object_equal($$);
1056sub _object_equal($$) {
1057 my ($a, $b) = @_;
1058
1059 return 0 unless (ref $a) eq (ref $b);
1060
1061 if ("HASH" eq ref $a) {
1062 my @ka = keys %$a;
1063 my @kb = keys %$b;
1064
1065 return 0 if @ka != @kb;
1066
1067 for (0 .. $#ka) {
1068 return 0 unless $ka[$_] eq $kb[$_];
1069 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1070 }
1071
1072 } elsif ("ARRAY" eq ref $a) {
1073
1074 return 0 if @$a != @$b;
1075
1076 for (0 .. $#$a) {
1077 return 0 unless _object_equal $a->[$_], $b->[$_];
1078 }
1079
1080 } elsif ($a ne $b) {
1081 return 0;
1082 }
1083
1084 1
1085}
1086
1087our $SLOW_MERGES;#d#
1088sub _can_merge {
1089 my ($ob1, $ob2) = @_;
1090
1091 ++$SLOW_MERGES;#d#
1092
1093 # we do the slow way here
1094 return _object_equal $ob1, $ob2
1095}
803 1096
804sub reattach { 1097sub reattach {
805 # basically do the same as instantiate, without calling instantiate 1098 # basically do the same as instantiate, without calling instantiate
806 my ($obj) = @_; 1099 my ($obj) = @_;
1100
1101 # no longer needed after getting rid of delete_package?
1102 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
807 1103
808 my $registry = $obj->registry; 1104 my $registry = $obj->registry;
809 1105
810 @$registry = (); 1106 @$registry = ();
811 1107
826cf::attachable->attach ( 1122cf::attachable->attach (
827 prio => -1000000, 1123 prio => -1000000,
828 on_instantiate => sub { 1124 on_instantiate => sub {
829 my ($obj, $data) = @_; 1125 my ($obj, $data) = @_;
830 1126
831 $data = from_json $data; 1127 $data = decode_json $data;
832 1128
833 for (@$data) { 1129 for (@$data) {
834 my ($name, $args) = @$_; 1130 my ($name, $args) = @$_;
835 1131
836 $obj->attach ($name, %{$args || {} }); 1132 $obj->attach ($name, %{$args || {} });
852sub object_freezer_save { 1148sub object_freezer_save {
853 my ($filename, $rdata, $objs) = @_; 1149 my ($filename, $rdata, $objs) = @_;
854 1150
855 sync_job { 1151 sync_job {
856 if (length $$rdata) { 1152 if (length $$rdata) {
1153 utf8::decode (my $decname = $filename);
857 warn sprintf "saving %s (%d,%d)\n", 1154 warn sprintf "saving %s (%d,%d)\n",
858 $filename, length $$rdata, scalar @$objs; 1155 $decname, length $$rdata, scalar @$objs;
859 1156
860 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1157 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
861 chmod SAVE_MODE, $fh; 1158 aio_chmod $fh, SAVE_MODE;
862 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1159 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
1160 if ($cf::USE_FSYNC) {
1161 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
863 aio_fsync $fh; 1162 aio_fsync $fh;
1163 }
864 close $fh; 1164 aio_close $fh;
865 1165
866 if (@$objs) { 1166 if (@$objs) {
867 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1167 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
868 chmod SAVE_MODE, $fh; 1168 aio_chmod $fh, SAVE_MODE;
869 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1169 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
870 aio_write $fh, 0, (length $data), $data, 0; 1170 aio_write $fh, 0, (length $data), $data, 0;
1171 if ($cf::USE_FSYNC) {
1172 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
871 aio_fsync $fh; 1173 aio_fsync $fh;
1174 }
872 close $fh; 1175 aio_close $fh;
873 aio_rename "$filename.pst~", "$filename.pst"; 1176 aio_rename "$filename.pst~", "$filename.pst";
874 } 1177 }
875 } else { 1178 } else {
876 aio_unlink "$filename.pst"; 1179 aio_unlink "$filename.pst";
877 } 1180 }
878 1181
879 aio_rename "$filename~", $filename; 1182 aio_rename "$filename~", $filename;
1183
1184 $filename =~ s%/[^/]+$%%;
1185 aio_pathsync $filename if $cf::USE_FSYNC;
880 } else { 1186 } else {
881 warn "FATAL: $filename~: $!\n"; 1187 warn "unable to save objects: $filename~: $!\n";
882 } 1188 }
883 } else { 1189 } else {
884 aio_unlink $filename; 1190 aio_unlink $filename;
885 aio_unlink "$filename.pst"; 1191 aio_unlink "$filename.pst";
886 } 1192 }
887 } 1193 };
888} 1194}
889 1195
890sub object_freezer_as_string { 1196sub object_freezer_as_string {
891 my ($rdata, $objs) = @_; 1197 my ($rdata, $objs) = @_;
892 1198
904 or return; 1210 or return;
905 1211
906 unless (aio_stat "$filename.pst") { 1212 unless (aio_stat "$filename.pst") {
907 (aio_load "$filename.pst", $av) >= 0 1213 (aio_load "$filename.pst", $av) >= 0
908 or return; 1214 or return;
1215
909 $av = eval { (Storable::thaw $av)->{objs} }; 1216 my $st = eval { Coro::Storable::thaw $av };
1217 $av = $st->{objs};
910 } 1218 }
911 1219
1220 utf8::decode (my $decname = $filename);
912 warn sprintf "loading %s (%d)\n", 1221 warn sprintf "loading %s (%d,%d)\n",
913 $filename, length $data, scalar @{$av || []};#d# 1222 $decname, length $data, scalar @{$av || []};
1223
914 return ($data, $av); 1224 ($data, $av)
915} 1225}
1226
1227=head2 COMMAND CALLBACKS
1228
1229=over 4
1230
1231=cut
916 1232
917############################################################################# 1233#############################################################################
918# command handling &c 1234# command handling &c
919 1235
920=item cf::register_command $name => \&callback($ob,$args); 1236=item cf::register_command $name => \&callback($ob,$args);
933 push @{ $COMMAND{$name} }, [$caller, $cb]; 1249 push @{ $COMMAND{$name} }, [$caller, $cb];
934} 1250}
935 1251
936=item cf::register_extcmd $name => \&callback($pl,$packet); 1252=item cf::register_extcmd $name => \&callback($pl,$packet);
937 1253
938Register a callbackf ro execution when the client sends an extcmd packet. 1254Register a callback for execution when the client sends an (synchronous)
1255extcmd packet. Ext commands will be processed in the order they are
1256received by the server, like other user commands. The first argument is
1257the logged-in player. Ext commands can only be processed after a player
1258has logged in successfully.
939 1259
940If the callback returns something, it is sent back as if reply was being 1260If the callback returns something, it is sent back as if reply was being
941called. 1261called.
942 1262
1263=item cf::register_exticmd $name => \&callback($ns,$packet);
1264
1265Register a callback for execution when the client sends an (asynchronous)
1266exticmd packet. Exti commands are processed by the server as soon as they
1267are received, i.e. out of order w.r.t. other commands. The first argument
1268is a client socket. Exti commands can be received anytime, even before
1269log-in.
1270
1271If the callback returns something, it is sent back as if reply was being
1272called.
1273
943=cut 1274=cut
944 1275
945sub register_extcmd { 1276sub register_extcmd {
946 my ($name, $cb) = @_; 1277 my ($name, $cb) = @_;
947 1278
948 $EXTCMD{$name} = $cb; 1279 $EXTCMD{$name} = $cb;
949} 1280}
1281
1282sub register_exticmd {
1283 my ($name, $cb) = @_;
1284
1285 $EXTICMD{$name} = $cb;
1286}
1287
1288use File::Glob ();
950 1289
951cf::player->attach ( 1290cf::player->attach (
952 on_command => sub { 1291 on_command => sub {
953 my ($pl, $name, $params) = @_; 1292 my ($pl, $name, $params) = @_;
954 1293
962 cf::override; 1301 cf::override;
963 }, 1302 },
964 on_extcmd => sub { 1303 on_extcmd => sub {
965 my ($pl, $buf) = @_; 1304 my ($pl, $buf) = @_;
966 1305
967 my $msg = eval { from_json $buf }; 1306 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
968 1307
969 if (ref $msg) { 1308 if (ref $msg) {
1309 my ($type, $reply, @payload) =
1310 "ARRAY" eq ref $msg
1311 ? @$msg
1312 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1313
1314 my @reply;
1315
970 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1316 if (my $cb = $EXTCMD{$type}) {
971 if (my %reply = $cb->($pl, $msg)) { 1317 @reply = $cb->($pl, @payload);
972 $pl->ext_reply ($msg->{msgid}, %reply);
973 }
974 } 1318 }
1319
1320 $pl->ext_reply ($reply, @reply)
1321 if $reply;
1322
975 } else { 1323 } else {
976 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1324 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
977 } 1325 }
978 1326
979 cf::override; 1327 cf::override;
980 }, 1328 },
981); 1329);
982 1330
1331# "readahead" all extensions
983sub load_extension { 1332sub cache_extensions {
984 my ($path) = @_; 1333 my $grp = IO::AIO::aio_group;
985 1334
986 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1335 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
987 my $base = $1; 1336 for (grep /\.ext$/, @{$_[0]}) {
988 my $pkg = $1; 1337 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
989 $pkg =~ s/[^[:word:]]/_/g; 1338 }
990 $pkg = "ext::$pkg"; 1339 };
991 1340
992 warn "loading '$path' into '$pkg'\n"; 1341 $grp
993
994 open my $fh, "<:utf8", $path
995 or die "$path: $!";
996
997 my $source =
998 "package $pkg; use strict; use utf8;\n"
999 . "#line 1 \"$path\"\n{\n"
1000 . (do { local $/; <$fh> })
1001 . "\n};\n1";
1002
1003 eval $source
1004 or die $@ ? "$path: $@\n"
1005 : "extension disabled.\n";
1006
1007 push @EXTS, $pkg;
1008} 1342}
1009 1343
1010sub load_extensions { 1344sub load_extensions {
1345 cf::sync_job {
1346 my %todo;
1347
1011 for my $ext (<$LIBDIR/*.ext>) { 1348 for my $path (<$LIBDIR/*.ext>) {
1012 next unless -r $ext; 1349 next unless -r $path;
1013 eval { 1350
1014 load_extension $ext; 1351 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1352 my $base = $1;
1353 my $pkg = $1;
1354 $pkg =~ s/[^[:word:]]/_/g;
1355 $pkg = "ext::$pkg";
1356
1357 open my $fh, "<:utf8", $path
1358 or die "$path: $!";
1359
1360 my $source = do { local $/; <$fh> };
1361
1362 my %ext = (
1363 path => $path,
1364 base => $base,
1365 pkg => $pkg,
1366 );
1367
1368 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1369 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1370
1371 $ext{source} =
1372 "package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
1373 . "#line 1 \"$path\"\n{\n"
1374 . $source
1375 . "\n};\n1";
1376
1377 $todo{$base} = \%ext;
1378 }
1379
1380 my %done;
1381 while (%todo) {
1382 my $progress;
1383
1384 while (my ($k, $v) = each %todo) {
1385 for (split /,\s*/, $v->{meta}{depends}) {
1386 goto skip
1387 unless exists $done{$_};
1388 }
1389
1390 warn "... loading '$k' into '$v->{pkg}'\n";
1391
1392 unless (eval $v->{source}) {
1393 my $msg = $@ ? "$v->{path}: $@\n"
1394 : "$v->{base}: extension inactive.\n";
1395
1396 if (exists $v->{meta}{mandatory}) {
1397 warn $msg;
1398 cf::cleanup "mandatory extension failed to load, exiting.";
1399 }
1400
1401 warn $msg;
1402 }
1403
1404 $done{$k} = delete $todo{$k};
1405 push @EXTS, $v->{pkg};
1406 $progress = 1;
1015 1 1407 }
1016 } or warn "$ext not loaded: $@"; 1408
1409 skip:
1410 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1411 unless $progress;
1412 }
1017 } 1413 };
1018} 1414}
1019 1415
1020############################################################################# 1416#############################################################################
1021# load/save/clean perl data associated with a map
1022 1417
1023*cf::mapsupport::on_clean = sub { 1418=back
1024 my ($map) = @_;
1025
1026 my $path = $map->tmpname;
1027 defined $path or return;
1028
1029 unlink "$path.pst";
1030};
1031
1032cf::map->attach (prio => -10000, package => cf::mapsupport::);
1033
1034#############################################################################
1035 1419
1036=head2 CORE EXTENSIONS 1420=head2 CORE EXTENSIONS
1037 1421
1038Functions and methods that extend core crossfire objects. 1422Functions and methods that extend core deliantra objects.
1039 1423
1040=cut 1424=cut
1041 1425
1042package cf::player; 1426package cf::player;
1043 1427
1045 1429
1046=head3 cf::player 1430=head3 cf::player
1047 1431
1048=over 4 1432=over 4
1049 1433
1434=item cf::player::num_playing
1435
1436Returns the official number of playing players, as per the Crossfire metaserver rules.
1437
1438=cut
1439
1440sub num_playing {
1441 scalar grep
1442 $_->ob->map
1443 && !$_->hidden
1444 && !$_->ob->flag (cf::FLAG_WIZ),
1445 cf::player::list
1446}
1447
1050=item cf::player::find $login 1448=item cf::player::find $login
1051 1449
1052Returns the given player object, loading it if necessary (might block). 1450Returns the given player object, loading it if necessary (might block).
1053 1451
1054=cut 1452=cut
1055 1453
1056sub playerdir($) { 1454sub playerdir($) {
1057 cf::localdir 1455 "$PLAYERDIR/"
1058 . "/"
1059 . cf::playerdir
1060 . "/"
1061 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1456 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1062} 1457}
1063 1458
1064sub path($) { 1459sub path($) {
1065 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1460 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1066 1461
1067 (playerdir $login) . "/$login.pl" 1462 (playerdir $login) . "/playerdata"
1068} 1463}
1069 1464
1070sub find_active($) { 1465sub find_active($) {
1071 $cf::PLAYER{$_[0]} 1466 $cf::PLAYER{$_[0]}
1072 and $cf::PLAYER{$_[0]}->active 1467 and $cf::PLAYER{$_[0]}->active
1075 1470
1076sub exists($) { 1471sub exists($) {
1077 my ($login) = @_; 1472 my ($login) = @_;
1078 1473
1079 $cf::PLAYER{$login} 1474 $cf::PLAYER{$login}
1080 or cf::sync_job { !aio_stat $login } 1475 or !aio_stat path $login
1081} 1476}
1082 1477
1083sub find($) { 1478sub find($) {
1084 return $cf::PLAYER{$_[0]} || do { 1479 return $cf::PLAYER{$_[0]} || do {
1085 my $login = $_[0]; 1480 my $login = $_[0];
1086 1481
1087 my $guard = cf::lock_acquire "user_find:$login"; 1482 my $guard = cf::lock_acquire "user_find:$login";
1088 1483
1089 $cf::PLAYER{$_[0]} || do { 1484 $cf::PLAYER{$_[0]} || do {
1090 my $pl = load_pl path $login 1485 # rename old playerfiles to new ones
1486 #TODO: remove when no longer required
1487 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1488 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1489 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1490 aio_unlink +(playerdir $login) . "/$login.pl";
1491
1492 my $f = new_from_file cf::object::thawer path $login
1091 or return; 1493 or return;
1494
1495 my $pl = cf::player::load_pl $f
1496 or return;
1497
1498 local $cf::PLAYER_LOADING{$login} = $pl;
1499 $f->resolve_delayed_derefs;
1092 $cf::PLAYER{$login} = $pl 1500 $cf::PLAYER{$login} = $pl
1093 } 1501 }
1094 } 1502 }
1095} 1503}
1096 1504
1105 return if $pl->{deny_save}; 1513 return if $pl->{deny_save};
1106 1514
1107 aio_mkdir playerdir $pl, 0770; 1515 aio_mkdir playerdir $pl, 0770;
1108 $pl->{last_save} = $cf::RUNTIME; 1516 $pl->{last_save} = $cf::RUNTIME;
1109 1517
1518 cf::get_slot 0.01;
1519
1110 $pl->save_pl ($path); 1520 $pl->save_pl ($path);
1111 Coro::cede; 1521 cf::cede_to_tick;
1112} 1522}
1113 1523
1114sub new($) { 1524sub new($) {
1115 my ($login) = @_; 1525 my ($login) = @_;
1116 1526
1122 $cf::PLAYER{$login} = $self; 1532 $cf::PLAYER{$login} = $self;
1123 1533
1124 $self 1534 $self
1125} 1535}
1126 1536
1537=item $player->send_msg ($channel, $msg, $color, [extra...])
1538
1539=cut
1540
1541sub send_msg {
1542 my $ns = shift->ns
1543 or return;
1544 $ns->send_msg (@_);
1545}
1546
1127=item $pl->quit_character 1547=item $pl->quit_character
1128 1548
1129Nukes the player without looking back. If logged in, the connection will 1549Nukes the player without looking back. If logged in, the connection will
1130be destroyed. May block for a long time. 1550be destroyed. May block for a long time.
1131 1551
1132=cut 1552=cut
1133 1553
1134sub quit_character { 1554sub quit_character {
1135 my ($pl) = @_; 1555 my ($pl) = @_;
1136 1556
1557 my $name = $pl->ob->name;
1558
1137 $pl->{deny_save} = 1; 1559 $pl->{deny_save} = 1;
1138 $pl->password ("*"); # this should lock out the player until we nuked the dir 1560 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1139 1561
1140 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1562 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1141 $pl->deactivate; 1563 $pl->deactivate;
1564 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1565 $pl->ob->check_score;
1142 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1566 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1143 $pl->ns->destroy if $pl->ns; 1567 $pl->ns->destroy if $pl->ns;
1144 1568
1145 my $path = playerdir $pl; 1569 my $path = playerdir $pl;
1146 my $temp = "$path~$cf::RUNTIME~deleting~"; 1570 my $temp = "$path~$cf::RUNTIME~deleting~";
1147 aio_rename $path, $temp; 1571 aio_rename $path, $temp;
1148 delete $cf::PLAYER{$pl->ob->name}; 1572 delete $cf::PLAYER{$pl->ob->name};
1149 $pl->destroy; 1573 $pl->destroy;
1574
1575 my $prefix = qr<^~\Q$name\E/>;
1576
1577 # nuke player maps
1578 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1579
1150 IO::AIO::aio_rmtree $temp; 1580 IO::AIO::aio_rmtree $temp;
1581}
1582
1583=item $pl->kick
1584
1585Kicks a player out of the game. This destroys the connection.
1586
1587=cut
1588
1589sub kick {
1590 my ($pl, $kicker) = @_;
1591
1592 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1593 $pl->killer ("kicked");
1594 $pl->ns->destroy;
1151} 1595}
1152 1596
1153=item cf::player::list_logins 1597=item cf::player::list_logins
1154 1598
1155Returns am arrayref of all valid playernames in the system, can take a 1599Returns am arrayref of all valid playernames in the system, can take a
1156while and may block, so not sync_job-capable, ever. 1600while and may block, so not sync_job-capable, ever.
1157 1601
1158=cut 1602=cut
1159 1603
1160sub list_logins { 1604sub list_logins {
1161 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1605 my $dirs = aio_readdir $PLAYERDIR
1162 or return []; 1606 or return [];
1163 1607
1164 my @logins; 1608 my @logins;
1165 1609
1166 for my $login (@$dirs) { 1610 for my $login (@$dirs) {
1611 my $path = path $login;
1612
1613 # a .pst is a dead give-away for a valid player
1614 # if no pst file found, open and chekc for blocked users
1615 if (aio_stat "$path.pst") {
1167 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1616 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1168 aio_read $fh, 0, 512, my $buf, 0 or next; 1617 aio_read $fh, 0, 512, my $buf, 0 or next;
1169 $buf !~ /^password -------------$/m or next; # official not-valid tag 1618 $buf !~ /^password -------------$/m or next; # official not-valid tag
1619 }
1170 1620
1171 utf8::decode $login; 1621 utf8::decode $login;
1172 push @logins, $login; 1622 push @logins, $login;
1173 } 1623 }
1174 1624
1175 \@logins 1625 \@logins
1176} 1626}
1177 1627
1178=item $player->maps 1628=item $player->maps
1179 1629
1180Returns an arrayref of cf::path's of all maps that are private for this 1630Returns an arrayref of map paths that are private for this
1181player. May block. 1631player. May block.
1182 1632
1183=cut 1633=cut
1184 1634
1185sub maps($) { 1635sub maps($) {
1186 my ($pl) = @_; 1636 my ($pl) = @_;
1637
1638 $pl = ref $pl ? $pl->ob->name : $pl;
1187 1639
1188 my $files = aio_readdir playerdir $pl 1640 my $files = aio_readdir playerdir $pl
1189 or return; 1641 or return;
1190 1642
1191 my @paths; 1643 my @paths;
1193 for (@$files) { 1645 for (@$files) {
1194 utf8::decode $_; 1646 utf8::decode $_;
1195 next if /\.(?:pl|pst)$/; 1647 next if /\.(?:pl|pst)$/;
1196 next unless /^$PATH_SEP/o; 1648 next unless /^$PATH_SEP/o;
1197 1649
1198 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; 1650 push @paths, cf::map::normalise "~$pl/$_";
1199 } 1651 }
1200 1652
1201 \@paths 1653 \@paths
1202} 1654}
1203 1655
1656=item $protocol_xml = $player->expand_cfpod ($cfpod)
1657
1658Expand deliantra pod fragments into protocol xml.
1659
1204=item $player->ext_reply ($msgid, $msgtype, %msg) 1660=item $player->ext_reply ($msgid, @msg)
1205 1661
1206Sends an ext reply to the player. 1662Sends an ext reply to the player.
1207 1663
1208=cut 1664=cut
1209 1665
1210sub ext_reply($$$%) { 1666sub ext_reply($$@) {
1211 my ($self, $id, %msg) = @_; 1667 my ($self, $id, @msg) = @_;
1212 1668
1213 $msg{msgid} = $id; 1669 $self->ns->ext_reply ($id, @msg)
1214
1215 $self->send ("ext " . cf::to_json \%msg);
1216} 1670}
1217 1671
1218package cf; 1672=item $player->ext_msg ($type, @msg)
1673
1674Sends an ext event to the client.
1675
1676=cut
1677
1678sub ext_msg($$@) {
1679 my ($self, $type, @msg) = @_;
1680
1681 $self->ns->ext_msg ($type, @msg);
1682}
1683
1684=head3 cf::region
1685
1686=over 4
1687
1688=cut
1689
1690package cf::region;
1691
1692=item cf::region::find_by_path $path
1693
1694Tries to decuce the likely region for a map knowing only its path.
1695
1696=cut
1697
1698sub find_by_path($) {
1699 my ($path) = @_;
1700
1701 my ($match, $specificity);
1702
1703 for my $region (list) {
1704 if ($region->{match} && $path =~ $region->{match}) {
1705 ($match, $specificity) = ($region, $region->specificity)
1706 if $region->specificity > $specificity;
1707 }
1708 }
1709
1710 $match
1711}
1219 1712
1220=back 1713=back
1221
1222 1714
1223=head3 cf::map 1715=head3 cf::map
1224 1716
1225=over 4 1717=over 4
1226 1718
1229package cf::map; 1721package cf::map;
1230 1722
1231use Fcntl; 1723use Fcntl;
1232use Coro::AIO; 1724use Coro::AIO;
1233 1725
1726use overload
1727 '""' => \&as_string,
1728 fallback => 1;
1729
1234our $MAX_RESET = 3600; 1730our $MAX_RESET = 3600;
1235our $DEFAULT_RESET = 3000; 1731our $DEFAULT_RESET = 3000;
1236 1732
1237sub generate_random_map { 1733sub generate_random_map {
1238 my ($path, $rmp) = @_; 1734 my ($self, $rmp) = @_;
1735
1736 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1239 1737
1240 # mit "rum" bekleckern, nicht 1738 # mit "rum" bekleckern, nicht
1241 cf::map::_create_random_map 1739 $self->_create_random_map (
1242 $path,
1243 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1740 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1244 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1741 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1245 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1742 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1246 $rmp->{exit_on_final_map}, 1743 $rmp->{exit_on_final_map},
1247 $rmp->{xsize}, $rmp->{ysize}, 1744 $rmp->{xsize}, $rmp->{ysize},
1248 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1745 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1249 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1746 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1250 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1747 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1251 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1748 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1252 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1749 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1253 (cf::region::find $rmp->{region}) 1750 (cf::region::find $rmp->{region}), $rmp->{custom}
1751 )
1254} 1752}
1255 1753
1256# and all this just because we cannot iterate over 1754=item cf::map->register ($regex, $prio)
1257# all maps in C++...
1258sub change_all_map_light {
1259 my ($change) = @_;
1260 1755
1261 $_->change_map_light ($change) 1756Register a handler for the map path matching the given regex at the
1262 for grep $_->outdoor, values %cf::MAP; 1757givne priority (higher is better, built-in handlers have priority 0, the
1263} 1758default).
1264 1759
1265sub try_load_header($) { 1760=cut
1761
1762sub register {
1763 my (undef, $regex, $prio) = @_;
1764 my $pkg = caller;
1765
1766 no strict;
1767 push @{"$pkg\::ISA"}, __PACKAGE__;
1768
1769 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1770}
1771
1772# also paths starting with '/'
1773$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1774
1775sub thawer_merge {
1776 my ($self, $merge) = @_;
1777
1778 # we have to keep some variables in memory intact
1779 local $self->{path};
1780 local $self->{load_path};
1781
1782 $self->SUPER::thawer_merge ($merge);
1783}
1784
1785sub normalise {
1266 my ($path) = @_; 1786 my ($path, $base) = @_;
1787
1788 $path = "$path"; # make sure its a string
1789
1790 $path =~ s/\.map$//;
1791
1792 # map plan:
1793 #
1794 # /! non-realised random map exit (special hack!)
1795 # {... are special paths that are not being touched
1796 # ?xxx/... are special absolute paths
1797 # ?random/... random maps
1798 # /... normal maps
1799 # ~user/... per-player map of a specific user
1800
1801 $path =~ s/$PATH_SEP/\//go;
1802
1803 # treat it as relative path if it starts with
1804 # something that looks reasonable
1805 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1806 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1807
1808 $base =~ s{[^/]+/?$}{};
1809 $path = "$base/$path";
1810 }
1811
1812 for ($path) {
1813 redo if s{//}{/};
1814 redo if s{/\.?/}{/};
1815 redo if s{/[^/]+/\.\./}{/};
1816 }
1817
1818 $path
1819}
1820
1821sub new_from_path {
1822 my (undef, $path, $base) = @_;
1823
1824 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1825
1826 $path = normalise $path, $base;
1827
1828 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1829 if ($path =~ $EXT_MAP{$pkg}[1]) {
1830 my $self = bless cf::map::new, $pkg;
1831 $self->{path} = $path; $self->path ($path);
1832 $self->init; # pass $1 etc.
1833 return $self;
1834 }
1835 }
1836
1837 Carp::cluck "unable to resolve path '$path' (base '$base').";
1838 ()
1839}
1840
1841sub init {
1842 my ($self) = @_;
1843
1844 $self
1845}
1846
1847sub as_string {
1848 my ($self) = @_;
1849
1850 "$self->{path}"
1851}
1852
1853# the displayed name, this is a one way mapping
1854sub visible_name {
1855 &as_string
1856}
1857
1858# the original (read-only) location
1859sub load_path {
1860 my ($self) = @_;
1861
1862 "$MAPDIR/$self->{path}.map"
1863}
1864
1865# the temporary/swap location
1866sub save_path {
1867 my ($self) = @_;
1868
1869 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1870 "$TMPDIR/$path.map"
1871}
1872
1873# the unique path, undef == no special unique path
1874sub uniq_path {
1875 my ($self) = @_;
1876
1877 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1878 "$UNIQUEDIR/$path"
1879}
1880
1881sub decay_objects {
1882 my ($self) = @_;
1883
1884 return if $self->{deny_reset};
1885
1886 $self->do_decay_objects;
1887}
1888
1889sub unlink_save {
1890 my ($self) = @_;
1891
1892 utf8::encode (my $save = $self->save_path);
1893 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1894 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1895}
1896
1897sub load_header_from($) {
1898 my ($self, $path) = @_;
1267 1899
1268 utf8::encode $path; 1900 utf8::encode $path;
1269 aio_open $path, O_RDONLY, 0 1901 my $f = new_from_file cf::object::thawer $path
1270 or return; 1902 or return;
1271 1903
1272 my $map = cf::map::new 1904 $self->_load_header ($f)
1273 or return; 1905 or return;
1274 1906
1275 # for better error messages only, will be overwritten 1907 local $MAP_LOADING{$self->{path}} = $self;
1276 $map->path ($path); 1908 $f->resolve_delayed_derefs;
1277 1909
1278 $map->load_header ($path) 1910 $self->{load_path} = $path;
1911
1912 1
1913}
1914
1915sub load_header_orig {
1916 my ($self) = @_;
1917
1918 $self->load_header_from ($self->load_path)
1919}
1920
1921sub load_header_temp {
1922 my ($self) = @_;
1923
1924 $self->load_header_from ($self->save_path)
1925}
1926
1927sub prepare_temp {
1928 my ($self) = @_;
1929
1930 $self->last_access ((delete $self->{last_access})
1931 || $cf::RUNTIME); #d#
1932 # safety
1933 $self->{instantiate_time} = $cf::RUNTIME
1934 if $self->{instantiate_time} > $cf::RUNTIME;
1935}
1936
1937sub prepare_orig {
1938 my ($self) = @_;
1939
1940 $self->{load_original} = 1;
1941 $self->{instantiate_time} = $cf::RUNTIME;
1942 $self->last_access ($cf::RUNTIME);
1943 $self->instantiate;
1944}
1945
1946sub load_header {
1947 my ($self) = @_;
1948
1949 if ($self->load_header_temp) {
1950 $self->prepare_temp;
1951 } else {
1952 $self->load_header_orig
1279 or return; 1953 or return;
1954 $self->prepare_orig;
1955 }
1280 1956
1281 $map->{load_path} = $path; 1957 $self->{deny_reset} = 1
1958 if $self->no_reset;
1282 1959
1283 $map 1960 $self->default_region (cf::region::find_by_path $self->{path})
1961 unless $self->default_region;
1962
1963 1
1284} 1964}
1285 1965
1286sub find; 1966sub find;
1287sub find { 1967sub find {
1288 my ($path, $origin) = @_; 1968 my ($path, $origin) = @_;
1289 1969
1290 #warn "find<$path,$origin>\n";#d#
1291
1292 $path = new cf::path $path, $origin && $origin->path; 1970 $path = normalise $path, $origin && $origin->path;
1293 my $key = $path->as_string;
1294 1971
1295 cf::lock_wait "map_find:$key"; 1972 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1296
1297 $cf::MAP{$key} || do {
1298 my $guard = cf::lock_acquire "map_find:$key"; 1973 my $guard2 = cf::lock_acquire "map_find:$path";
1299 1974
1300 # do it the slow way 1975 $cf::MAP{$path} || do {
1301 my $map = try_load_header $path->save_path; 1976 my $map = new_from_path cf::map $path
1302
1303 Coro::cede;
1304
1305 if ($map) {
1306 $map->last_access ((delete $map->{last_access})
1307 || $cf::RUNTIME); #d#
1308 # safety
1309 $map->{instantiate_time} = $cf::RUNTIME
1310 if $map->{instantiate_time} > $cf::RUNTIME;
1311 } else {
1312 if (my $rmp = $path->random_map_params) {
1313 $map = generate_random_map $key, $rmp;
1314 } else {
1315 $map = try_load_header $path->load_path;
1316 }
1317
1318 $map or return; 1977 or return;
1319 1978
1320 $map->{load_original} = 1;
1321 $map->{instantiate_time} = $cf::RUNTIME;
1322 $map->last_access ($cf::RUNTIME);
1323 $map->instantiate;
1324
1325 # per-player maps become, after loading, normal maps
1326 $map->per_player (0) if $path->{user_rel};
1327 }
1328
1329 $map->path ($key);
1330 $map->{path} = $path;
1331 $map->{last_save} = $cf::RUNTIME; 1979 $map->{last_save} = $cf::RUNTIME;
1332 1980
1333 Coro::cede; 1981 $map->load_header
1982 or return;
1334 1983
1335 if ($map->should_reset) { 1984 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1985 # doing this can freeze the server in a sync job, obviously
1986 #$cf::WAIT_FOR_TICK->wait;
1987 undef $guard2;
1988 undef $guard1;
1336 $map->reset; 1989 $map->reset;
1337 undef $guard;
1338 $map = find $path 1990 return find $path;
1339 or return;
1340 } 1991 }
1341 1992
1342 $cf::MAP{$key} = $map 1993 $cf::MAP{$path} = $map
1343 } 1994 }
1344} 1995}
1996
1997sub pre_load { }
1998sub post_load { }
1345 1999
1346sub load { 2000sub load {
1347 my ($self) = @_; 2001 my ($self) = @_;
1348 2002
2003 local $self->{deny_reset} = 1; # loading can take a long time
2004
1349 my $path = $self->{path}; 2005 my $path = $self->{path};
2006
2007 {
1350 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2008 my $guard = cf::lock_acquire "map_data:$path";
1351 2009
2010 return unless $self->valid;
1352 return if $self->in_memory != cf::MAP_SWAPPED; 2011 return unless $self->in_memory == cf::MAP_SWAPPED;
1353 2012
1354 $self->in_memory (cf::MAP_LOADING); 2013 $self->in_memory (cf::MAP_LOADING);
1355 2014
1356 $self->alloc; 2015 $self->alloc;
1357 $self->load_objects ($self->{load_path}, 1) 2016
2017 $self->pre_load;
2018 cf::cede_to_tick;
2019
2020 my $f = new_from_file cf::object::thawer $self->{load_path};
2021 $f->skip_block;
2022 $self->_load_objects ($f)
1358 or return; 2023 or return;
1359 2024
1360 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2025 $self->post_load_original
1361 if delete $self->{load_original}; 2026 if delete $self->{load_original};
1362 2027
1363 if (my $uniq = $path->uniq_path) { 2028 if (my $uniq = $self->uniq_path) {
1364 utf8::encode $uniq; 2029 utf8::encode $uniq;
1365 if (aio_open $uniq, O_RDONLY, 0) { 2030 unless (aio_stat $uniq) {
2031 if (my $f = new_from_file cf::object::thawer $uniq) {
1366 $self->clear_unique_items; 2032 $self->clear_unique_items;
1367 $self->load_objects ($uniq, 0); 2033 $self->_load_objects ($f);
2034 $f->resolve_delayed_derefs;
2035 }
1368 } 2036 }
1369 } 2037 }
1370 2038
1371 Coro::cede; 2039 $f->resolve_delayed_derefs;
1372 2040
2041 cf::cede_to_tick;
1373 # now do the right thing for maps 2042 # now do the right thing for maps
1374 $self->link_multipart_objects; 2043 $self->link_multipart_objects;
1375
1376 if ($self->{path}->is_style_map) {
1377 $self->{deny_save} = 1;
1378 $self->{deny_reset} = 1;
1379 } else {
1380 $self->fix_auto_apply;
1381 $self->decay_objects;
1382 $self->update_buttons;
1383 $self->set_darkness_map;
1384 $self->difficulty ($self->estimate_difficulty) 2044 $self->difficulty ($self->estimate_difficulty)
1385 unless $self->difficulty; 2045 unless $self->difficulty;
2046 cf::cede_to_tick;
2047
2048 unless ($self->{deny_activate}) {
2049 $self->decay_objects;
2050 $self->fix_auto_apply;
2051 $self->update_buttons;
2052 cf::cede_to_tick;
1386 $self->activate; 2053 $self->activate;
1387 } 2054 }
1388 2055
1389 Coro::cede; 2056 $self->{last_save} = $cf::RUNTIME;
2057 $self->last_access ($cf::RUNTIME);
1390 2058
1391 $self->in_memory (cf::MAP_IN_MEMORY); 2059 $self->in_memory (cf::MAP_ACTIVE);
2060 }
2061
2062 $self->post_load;
2063}
2064
2065sub customise_for {
2066 my ($self, $ob) = @_;
2067
2068 return find "~" . $ob->name . "/" . $self->{path}
2069 if $self->per_player;
2070
2071# return find "?party/" . $ob->name . "/" . $self->{path}
2072# if $self->per_party;
2073
2074 $self
1392} 2075}
1393 2076
1394# find and load all maps in the 3x3 area around a map 2077# find and load all maps in the 3x3 area around a map
1395sub load_diag { 2078sub load_neighbours {
1396 my ($map) = @_; 2079 my ($map) = @_;
1397 2080
1398 my @diag; # diagonal neighbours 2081 my @neigh; # diagonal neighbours
1399 2082
1400 for (0 .. 3) { 2083 for (0 .. 3) {
1401 my $neigh = $map->tile_path ($_) 2084 my $neigh = $map->tile_path ($_)
1402 or next; 2085 or next;
1403 $neigh = find $neigh, $map 2086 $neigh = find $neigh, $map
1404 or next; 2087 or next;
1405 $neigh->load; 2088 $neigh->load;
1406 2089
2090 push @neigh,
1407 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2091 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1408 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2092 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1409 } 2093 }
1410 2094
1411 for (@diag) { 2095 for (grep defined $_->[0], @neigh) {
2096 my ($path, $origin) = @$_;
1412 my $neigh = find @$_ 2097 my $neigh = find $path, $origin
1413 or next; 2098 or next;
1414 $neigh->load; 2099 $neigh->load;
1415 } 2100 }
1416} 2101}
1417 2102
1422} 2107}
1423 2108
1424sub do_load_sync { 2109sub do_load_sync {
1425 my ($map) = @_; 2110 my ($map) = @_;
1426 2111
2112 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2113 if $Coro::current == $Coro::main;
2114
1427 cf::sync_job { $map->load }; 2115 cf::sync_job { $map->load };
1428} 2116}
1429 2117
1430our %MAP_PREFETCH; 2118our %MAP_PREFETCH;
2119our $MAP_PREFETCHER = undef;
2120
2121sub find_async {
2122 my ($path, $origin, $load) = @_;
2123
2124 $path = normalise $path, $origin && $origin->{path};
2125
2126 if (my $map = $cf::MAP{$path}) {
2127 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2128 }
2129
2130 $MAP_PREFETCH{$path} |= $load;
2131
1431our $MAP_PREFETCHER = Coro::async { 2132 $MAP_PREFETCHER ||= cf::async {
1432 while () { 2133 $Coro::current->{desc} = "map prefetcher";
2134
1433 while (%MAP_PREFETCH) { 2135 while (%MAP_PREFETCH) {
1434 my $key = each %MAP_PREFETCH 2136 while (my ($k, $v) = each %MAP_PREFETCH) {
1435 or next; 2137 if (my $map = find $k) {
2138 $map->load if $v;
2139 }
2140
1436 my $path = delete $MAP_PREFETCH{$key}; 2141 delete $MAP_PREFETCH{$k};
1437
1438 my $map = find $path
1439 or next;
1440 $map->load;
1441 } 2142 }
1442 Coro::schedule; 2143 }
2144 undef $MAP_PREFETCHER;
1443 } 2145 };
1444};
1445
1446sub find_async {
1447 my ($path, $origin) = @_;
1448
1449 $path = new cf::path $path, $origin && $origin->path;
1450 my $key = $path->as_string;
1451
1452 if (my $map = $cf::MAP{$key}) {
1453 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1454 }
1455
1456 $MAP_PREFETCH{$key} = $path;
1457 $MAP_PREFETCHER->ready; 2146 $MAP_PREFETCHER->prio (6);
1458 2147
1459 () 2148 ()
1460} 2149}
1461 2150
1462sub save { 2151sub save {
1463 my ($self) = @_; 2152 my ($self) = @_;
1464 2153
1465 my $lock = cf::lock_acquire "map_data:" . $self->path; 2154 my $lock = cf::lock_acquire "map_data:$self->{path}";
1466 2155
1467 $self->{last_save} = $cf::RUNTIME; 2156 $self->{last_save} = $cf::RUNTIME;
1468 2157
1469 return unless $self->dirty; 2158 return unless $self->dirty;
1470 2159
1471 my $save = $self->{path}->save_path; utf8::encode $save; 2160 my $save = $self->save_path; utf8::encode $save;
1472 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2161 my $uniq = $self->uniq_path; utf8::encode $uniq;
1473 2162
1474 $self->{load_path} = $save; 2163 $self->{load_path} = $save;
1475 2164
1476 return if $self->{deny_save}; 2165 return if $self->{deny_save};
1477 2166
1478 local $self->{last_access} = $self->last_access;#d# 2167 local $self->{last_access} = $self->last_access;#d#
1479 2168
1480 cf::async { 2169 cf::async {
2170 $Coro::current->{desc} = "map player save";
1481 $_->contr->save for $self->players; 2171 $_->contr->save for $self->players;
1482 }; 2172 };
1483 2173
2174 cf::get_slot 0.02;
2175
1484 if ($uniq) { 2176 if ($uniq) {
1485 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2177 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1486 $self->save_objects ($uniq, cf::IO_UNIQUES); 2178 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1487 } else { 2179 } else {
1488 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2180 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1489 } 2181 }
1490} 2182}
1491 2183
1492sub swap_out { 2184sub swap_out {
1493 my ($self) = @_; 2185 my ($self) = @_;
1494 2186
1495 # save first because save cedes 2187 # save first because save cedes
1496 $self->save; 2188 $self->save;
1497 2189
1498 my $lock = cf::lock_acquire "map_data:" . $self->path; 2190 my $lock = cf::lock_acquire "map_data:$self->{path}";
1499 2191
1500 return if $self->players; 2192 return if $self->players;
1501 return if $self->in_memory != cf::MAP_IN_MEMORY; 2193 return if $self->in_memory != cf::MAP_ACTIVE;
1502 return if $self->{deny_save}; 2194 return if $self->{deny_save};
1503 2195
2196 $self->in_memory (cf::MAP_SWAPPED);
2197
2198 $self->deactivate;
2199 $_->clear_links_to ($self) for values %cf::MAP;
1504 $self->clear; 2200 $self->clear;
1505 $self->in_memory (cf::MAP_SWAPPED);
1506} 2201}
1507 2202
1508sub reset_at { 2203sub reset_at {
1509 my ($self) = @_; 2204 my ($self) = @_;
1510 2205
1511 # TODO: safety, remove and allow resettable per-player maps 2206 # TODO: safety, remove and allow resettable per-player maps
1512 return 1e99 if $self->{path}{user_rel};
1513 return 1e99 if $self->{deny_reset}; 2207 return 1e99 if $self->{deny_reset};
1514 2208
1515 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2209 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1516 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2210 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1517 2211
1522 my ($self) = @_; 2216 my ($self) = @_;
1523 2217
1524 $self->reset_at <= $cf::RUNTIME 2218 $self->reset_at <= $cf::RUNTIME
1525} 2219}
1526 2220
1527sub unlink_save {
1528 my ($self) = @_;
1529
1530 utf8::encode (my $save = $self->{path}->save_path);
1531 aioreq_pri 3; IO::AIO::aio_unlink $save;
1532 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1533}
1534
1535sub rename {
1536 my ($self, $new_path) = @_;
1537
1538 $self->unlink_save;
1539
1540 delete $cf::MAP{$self->path};
1541 $self->{path} = new cf::path $new_path;
1542 $self->path ($self->{path}->as_string);
1543 $cf::MAP{$self->path} = $self;
1544
1545 $self->save;
1546}
1547
1548sub reset { 2221sub reset {
1549 my ($self) = @_; 2222 my ($self) = @_;
1550 2223
1551 my $lock = cf::lock_acquire "map_data:" . $self->path; 2224 my $lock = cf::lock_acquire "map_data:$self->{path}";
1552 2225
1553 return if $self->players; 2226 return if $self->players;
1554 return if $self->{path}{user_rel};#d#
1555 2227
1556 warn "resetting map ", $self->path;#d# 2228 warn "resetting map ", $self->path;
2229
2230 $self->in_memory (cf::MAP_SWAPPED);
2231
2232 # need to save uniques path
2233 unless ($self->{deny_save}) {
2234 my $uniq = $self->uniq_path; utf8::encode $uniq;
2235
2236 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2237 if $uniq;
2238 }
1557 2239
1558 delete $cf::MAP{$self->path}; 2240 delete $cf::MAP{$self->path};
1559 2241
2242 $self->deactivate;
1560 $_->clear_links_to ($self) for values %cf::MAP; 2243 $_->clear_links_to ($self) for values %cf::MAP;
2244 $self->clear;
1561 2245
1562 $self->unlink_save; 2246 $self->unlink_save;
1563 $self->destroy; 2247 $self->destroy;
1564} 2248}
1565 2249
1566my $nuke_counter = "aaaa"; 2250my $nuke_counter = "aaaa";
1567 2251
1568sub nuke { 2252sub nuke {
1569 my ($self) = @_; 2253 my ($self) = @_;
1570 2254
2255 {
2256 my $lock = cf::lock_acquire "map_data:$self->{path}";
2257
2258 delete $cf::MAP{$self->path};
2259
2260 $self->unlink_save;
2261
2262 bless $self, "cf::map";
2263 delete $self->{deny_reset};
1571 $self->{deny_save} = 1; 2264 $self->{deny_save} = 1;
1572 $self->reset_timeout (1); 2265 $self->reset_timeout (1);
1573 $self->rename ("{nuke}/" . ($nuke_counter++)); 2266 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2267
2268 $cf::MAP{$self->path} = $self;
2269 }
2270
1574 $self->reset; # polite request, might not happen 2271 $self->reset; # polite request, might not happen
1575} 2272}
1576 2273
1577sub customise_for { 2274=item $maps = cf::map::tmp_maps
1578 my ($map, $ob) = @_;
1579 2275
1580 if ($map->per_player) { 2276Returns an arrayref with all map paths of currently instantiated and saved
1581 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2277maps. May block.
2278
2279=cut
2280
2281sub tmp_maps() {
1582 } 2282 [
2283 map {
2284 utf8::decode $_;
2285 /\.map$/
2286 ? normalise $_
2287 : ()
2288 } @{ aio_readdir $TMPDIR or [] }
2289 ]
2290}
1583 2291
1584 $map 2292=item $maps = cf::map::random_maps
2293
2294Returns an arrayref with all map paths of currently instantiated and saved
2295random maps. May block.
2296
2297=cut
2298
2299sub random_maps() {
2300 [
2301 map {
2302 utf8::decode $_;
2303 /\.map$/
2304 ? normalise "?random/$_"
2305 : ()
2306 } @{ aio_readdir $RANDOMDIR or [] }
2307 ]
1585} 2308}
1586 2309
1587=item cf::map::unique_maps 2310=item cf::map::unique_maps
1588 2311
1589Returns an arrayref of cf::path's of all shared maps that have 2312Returns an arrayref of paths of all shared maps that have
1590instantiated unique items. May block. 2313instantiated unique items. May block.
1591 2314
1592=cut 2315=cut
1593 2316
1594sub unique_maps() { 2317sub unique_maps() {
1595 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2318 [
1596 or return; 2319 map {
1597
1598 my @paths;
1599
1600 for (@$files) {
1601 utf8::decode $_; 2320 utf8::decode $_;
1602 next if /\.pst$/; 2321 s/\.map$//; # TODO future compatibility hack
1603 next unless /^$PATH_SEP/o; 2322 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1604 2323 ? ()
1605 push @paths, new cf::path $_; 2324 : normalise $_
2325 } @{ aio_readdir $UNIQUEDIR or [] }
1606 } 2326 ]
1607
1608 \@paths
1609} 2327}
1610
1611package cf;
1612 2328
1613=back 2329=back
1614 2330
1615=head3 cf::object 2331=head3 cf::object
1616 2332
1620 2336
1621=over 4 2337=over 4
1622 2338
1623=item $ob->inv_recursive 2339=item $ob->inv_recursive
1624 2340
1625Returns the inventory of the object _and_ their inventories, recursively. 2341Returns the inventory of the object I<and> their inventories, recursively,
2342but I<not> the object itself.
1626 2343
1627=cut 2344=cut
1628 2345
1629sub inv_recursive_; 2346sub inv_recursive_;
1630sub inv_recursive_ { 2347sub inv_recursive_ {
1633 2350
1634sub inv_recursive { 2351sub inv_recursive {
1635 inv_recursive_ inv $_[0] 2352 inv_recursive_ inv $_[0]
1636} 2353}
1637 2354
2355=item $ref = $ob->ref
2356
2357Creates and returns a persistent reference to an object that can be stored as a string.
2358
2359=item $ob = cf::object::deref ($refstring)
2360
2361returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2362even if the object actually exists. May block.
2363
2364=cut
2365
2366sub deref {
2367 my ($ref) = @_;
2368
2369 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2370 my ($uuid, $name) = ($1, $2);
2371 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2372 or return;
2373 $pl->ob->uuid eq $uuid
2374 or return;
2375
2376 $pl->ob
2377 } else {
2378 warn "$ref: cannot resolve object reference\n";
2379 undef
2380 }
2381}
2382
1638package cf; 2383package cf;
1639 2384
1640=back 2385=back
1641 2386
1642=head3 cf::object::player 2387=head3 cf::object::player
1648Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2393Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1649can be C<undef>. Does the right thing when the player is currently in a 2394can be C<undef>. Does the right thing when the player is currently in a
1650dialogue with the given NPC character. 2395dialogue with the given NPC character.
1651 2396
1652=cut 2397=cut
2398
2399our $SAY_CHANNEL = {
2400 id => "say",
2401 title => "Map",
2402 reply => "say ",
2403 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2404};
2405
2406our $CHAT_CHANNEL = {
2407 id => "chat",
2408 title => "Chat",
2409 reply => "chat ",
2410 tooltip => "Player chat and shouts, global to the server.",
2411};
1653 2412
1654# rough implementation of a future "reply" method that works 2413# rough implementation of a future "reply" method that works
1655# with dialog boxes. 2414# with dialog boxes.
1656#TODO: the first argument must go, split into a $npc->reply_to ( method 2415#TODO: the first argument must go, split into a $npc->reply_to ( method
1657sub cf::object::player::reply($$$;$) { 2416sub cf::object::player::reply($$$;$) {
1659 2418
1660 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2419 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1661 2420
1662 if ($self->{record_replies}) { 2421 if ($self->{record_replies}) {
1663 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2422 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2423
1664 } else { 2424 } else {
2425 my $pl = $self->contr;
2426
2427 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2428 my $dialog = $pl->{npc_dialog};
2429 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2430
2431 } else {
1665 $msg = $npc->name . " says: $msg" if $npc; 2432 $msg = $npc->name . " says: $msg" if $npc;
1666 $self->message ($msg, $flags); 2433 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2434 }
1667 } 2435 }
2436}
2437
2438=item $object->send_msg ($channel, $msg, $color, [extra...])
2439
2440=cut
2441
2442sub cf::object::send_msg {
2443 my $pl = shift->contr
2444 or return;
2445 $pl->send_msg (@_);
1668} 2446}
1669 2447
1670=item $player_object->may ("access") 2448=item $player_object->may ("access")
1671 2449
1672Returns wether the given player is authorized to access resource "access" 2450Returns wether the given player is authorized to access resource "access"
1685 2463
1686=item $player_object->enter_link 2464=item $player_object->enter_link
1687 2465
1688Freezes the player and moves him/her to a special map (C<{link}>). 2466Freezes the player and moves him/her to a special map (C<{link}>).
1689 2467
1690The player should be reaosnably safe there for short amounts of time. You 2468The player should be reasonably safe there for short amounts of time (e.g.
1691I<MUST> call C<leave_link> as soon as possible, though. 2469for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2470though, as the palyer cannot control the character while it is on the link
2471map.
2472
2473Will never block.
1692 2474
1693=item $player_object->leave_link ($map, $x, $y) 2475=item $player_object->leave_link ($map, $x, $y)
1694 2476
1695Moves the player out of the specila link map onto the given map. If the 2477Moves the player out of the special C<{link}> map onto the specified
1696map is not valid (or omitted), the player will be moved back to the 2478map. If the map is not valid (or omitted), the player will be moved back
1697location he/she was before the call to C<enter_link>, or, if that fails, 2479to the location he/she was before the call to C<enter_link>, or, if that
1698to the emergency map position. 2480fails, to the emergency map position.
1699 2481
1700Might block. 2482Might block.
1701 2483
1702=cut 2484=cut
2485
2486sub link_map {
2487 unless ($LINK_MAP) {
2488 $LINK_MAP = cf::map::find "{link}"
2489 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2490 $LINK_MAP->load;
2491 }
2492
2493 $LINK_MAP
2494}
1703 2495
1704sub cf::object::player::enter_link { 2496sub cf::object::player::enter_link {
1705 my ($self) = @_; 2497 my ($self) = @_;
1706 2498
1707 $self->deactivate_recursive; 2499 $self->deactivate_recursive;
1708 2500
1709 return if $self->map == $LINK_MAP; 2501 return if UNIVERSAL::isa $self->map, "ext::map_link";
1710 2502
1711 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2503 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1712 if $self->map; 2504 if $self->map && $self->map->{path} ne "{link}";
1713 2505
1714 $self->enter_map ($LINK_MAP, 20, 20); 2506 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1715} 2507}
1716 2508
1717sub cf::object::player::leave_link { 2509sub cf::object::player::leave_link {
1718 my ($self, $map, $x, $y) = @_; 2510 my ($self, $map, $x, $y) = @_;
2511
2512 return unless $self->contr->active;
1719 2513
1720 my $link_pos = delete $self->{_link_pos}; 2514 my $link_pos = delete $self->{_link_pos};
1721 2515
1722 unless ($map) { 2516 unless ($map) {
1723 # restore original map position 2517 # restore original map position
1737 # use -1 or undef as default coordinates, not 0, 0 2531 # use -1 or undef as default coordinates, not 0, 0
1738 ($x, $y) = ($map->enter_x, $map->enter_y) 2532 ($x, $y) = ($map->enter_x, $map->enter_y)
1739 if $x <=0 && $y <= 0; 2533 if $x <=0 && $y <= 0;
1740 2534
1741 $map->load; 2535 $map->load;
1742 $map->load_diag; 2536 $map->load_neighbours;
1743 2537
1744 return unless $self->contr->active; 2538 return unless $self->contr->active;
2539 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
1745 $self->activate_recursive; 2540 $self->activate_recursive;
2541
2542 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1746 $self->enter_map ($map, $x, $y); 2543 $self->enter_map ($map, $x, $y);
1747} 2544}
1748 2545
1749cf::player->attach ( 2546=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1750 on_logout => sub {
1751 my ($pl) = @_;
1752 2547
1753 # abort map switching before logout 2548Moves the player to the given map-path and coordinates by first freezing
1754 if ($pl->ob->{_link_pos}) { 2549her, loading and preparing them map, calling the provided $check callback
1755 cf::sync_job { 2550that has to return the map if sucecssful, and then unfreezes the player on
1756 $pl->ob->leave_link 2551the new (success) or old (failed) map position. In either case, $done will
1757 }; 2552be called at the end of this process.
1758 }
1759 },
1760 on_login => sub {
1761 my ($pl) = @_;
1762 2553
1763 # try to abort aborted map switching on player login :) 2554Note that $check will be called with a potentially non-loaded map, so if
1764 # should happen only on crashes 2555it needs a loaded map it has to call C<< ->load >>.
1765 if ($pl->ob->{_link_pos}) {
1766 $pl->ob->enter_link;
1767 (async {
1768 # we need this sleep as the login has a concurrent enter_exit running
1769 # and this sleep increases chances of the player not ending up in scorn
1770 $pl->ob->reply (undef,
1771 "There was an internal problem at your last logout, "
1772 . "the server will try to bring you to your intended destination in a second.",
1773 cf::NDI_RED);
1774 Coro::Timer::sleep 1;
1775 $pl->ob->leave_link;
1776 })->prio (2);
1777 }
1778 },
1779);
1780 2556
1781=item $player_object->goto ($path, $x, $y)
1782
1783=cut 2557=cut
2558
2559our $GOTOGEN;
1784 2560
1785sub cf::object::player::goto { 2561sub cf::object::player::goto {
1786 my ($self, $path, $x, $y) = @_; 2562 my ($self, $path, $x, $y, $check, $done) = @_;
1787 2563
1788 $path = new cf::path $path; 2564 # do generation counting so two concurrent goto's will be executed in-order
2565 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1789 2566
1790 $self->enter_link; 2567 $self->enter_link;
1791 2568
1792 (async { 2569 (async {
1793 my $map = cf::map::find $path->as_string; 2570 $Coro::current->{desc} = "player::goto $path $x $y";
2571
2572 # *tag paths override both path and x|y
2573 if ($path =~ /^\*(.*)$/) {
2574 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2575 my $ob = $obs[rand @obs];
2576
2577 # see if we actually can go there
2578 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2579 $ob = $obs[rand @obs];
2580 } else {
2581 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2582 }
2583 # else put us there anyways for now #d#
2584
2585 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2586 } else {
2587 ($path, $x, $y) = (undef, undef, undef);
2588 }
2589 }
2590
2591 my $map = eval {
2592 my $map = defined $path ? cf::map::find $path : undef;
2593
2594 if ($map) {
1794 $map = $map->customise_for ($self) if $map; 2595 $map = $map->customise_for ($self);
1795 2596 $map = $check->($map) if $check && $map;
1796# warn "entering ", $map->path, " at ($x, $y)\n" 2597 } else {
1797# if $map;
1798
1799 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2598 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2599 }
1800 2600
2601 $map
2602 };
2603
2604 if ($@) {
2605 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2606 LOG llevError | logBacktrace, Carp::longmess $@;
2607 }
2608
2609 if ($gen == $self->{_goto_generation}) {
2610 delete $self->{_goto_generation};
1801 $self->leave_link ($map, $x, $y); 2611 $self->leave_link ($map, $x, $y);
2612 }
2613
2614 $done->() if $done;
1802 })->prio (1); 2615 })->prio (1);
1803} 2616}
1804 2617
1805=item $player_object->enter_exit ($exit_object) 2618=item $player_object->enter_exit ($exit_object)
1806 2619
1808 2621
1809sub parse_random_map_params { 2622sub parse_random_map_params {
1810 my ($spec) = @_; 2623 my ($spec) = @_;
1811 2624
1812 my $rmp = { # defaults 2625 my $rmp = { # defaults
1813 xsize => 10, 2626 xsize => (cf::rndm 15, 40),
1814 ysize => 10, 2627 ysize => (cf::rndm 15, 40),
2628 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2629 #layout => string,
1815 }; 2630 };
1816 2631
1817 for (split /\n/, $spec) { 2632 for (split /\n/, $spec) {
1818 my ($k, $v) = split /\s+/, $_, 2; 2633 my ($k, $v) = split /\s+/, $_, 2;
1819 2634
1831 # that depends on the exit object 2646 # that depends on the exit object
1832 2647
1833 my $rmp = parse_random_map_params $exit->msg; 2648 my $rmp = parse_random_map_params $exit->msg;
1834 2649
1835 if ($exit->map) { 2650 if ($exit->map) {
1836 $rmp->{region} = $exit->map->region_name; 2651 $rmp->{region} = $exit->region->name;
1837 $rmp->{origin_map} = $exit->map->path; 2652 $rmp->{origin_map} = $exit->map->path;
1838 $rmp->{origin_x} = $exit->x; 2653 $rmp->{origin_x} = $exit->x;
1839 $rmp->{origin_y} = $exit->y; 2654 $rmp->{origin_y} = $exit->y;
2655
2656 $exit->map->touch;
1840 } 2657 }
1841 2658
1842 $rmp->{random_seed} ||= $exit->random_seed; 2659 $rmp->{random_seed} ||= $exit->random_seed;
1843 2660
1844 my $data = cf::to_json $rmp; 2661 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1845 my $md5 = Digest::MD5::md5_hex $data; 2662 my $md5 = Digest::MD5::md5_hex $data;
2663 my $meta = "$RANDOMDIR/$md5.meta";
1846 2664
1847 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2665 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1848 aio_write $fh, 0, (length $data), $data, 0; 2666 aio_write $fh, 0, (length $data), $data, 0;
2667 undef $fh;
2668 aio_rename "$meta~", $meta;
1849 2669
2670 my $slaying = "?random/$md5";
2671
2672 if ($exit->valid) {
1850 $exit->slaying ("?random/$md5"); 2673 $exit->slaying ("?random/$md5");
1851 $exit->msg (undef); 2674 $exit->msg (undef);
2675 }
1852 } 2676 }
1853} 2677}
1854 2678
1855sub cf::object::player::enter_exit { 2679sub cf::object::player::enter_exit {
1856 my ($self, $exit) = @_; 2680 my ($self, $exit) = @_;
1858 return unless $self->type == cf::PLAYER; 2682 return unless $self->type == cf::PLAYER;
1859 2683
1860 $self->enter_link; 2684 $self->enter_link;
1861 2685
1862 (async { 2686 (async {
1863 $self->deactivate_recursive; # just to be sure 2687 $Coro::current->{desc} = "enter_exit";
2688
1864 unless (eval { 2689 unless (eval {
2690 $self->deactivate_recursive; # just to be sure
2691
2692 # random map handling
2693 {
2694 my $guard = cf::lock_acquire "exit_prepare:$exit";
2695
1865 prepare_random_map $exit 2696 prepare_random_map $exit
1866 if $exit->slaying eq "/!"; 2697 if $exit->slaying eq "/!";
2698 }
1867 2699
1868 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2700 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1869 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2701 my $x = $exit->stats->hp;
2702 my $y = $exit->stats->sp;
1870 2703
2704 $self->goto ($map, $x, $y);
2705
2706 # if exit is damned, update players death & WoR home-position
2707 $self->contr->savebed ($map, $x, $y)
2708 if $exit->flag (cf::FLAG_DAMNED);
2709
1871 1; 2710 1
1872 }) { 2711 }) {
1873 $self->message ("Something went wrong deep within the crossfire server. " 2712 $self->message ("Something went wrong deep within the deliantra server. "
1874 . "I'll try to bring you back to the map you were before. " 2713 . "I'll try to bring you back to the map you were before. "
1875 . "Please report this to the dungeon master!", 2714 . "Please report this to the dungeon master!",
1876 cf::NDI_UNIQUE | cf::NDI_RED); 2715 cf::NDI_UNIQUE | cf::NDI_RED);
1877 2716
1878 warn "ERROR in enter_exit: $@"; 2717 warn "ERROR in enter_exit: $@";
1879 $self->leave_link; 2718 $self->leave_link;
1880 } 2719 }
1881 })->prio (1); 2720 })->prio (1);
1894 2733
1895sub cf::client::send_drawinfo { 2734sub cf::client::send_drawinfo {
1896 my ($self, $text, $flags) = @_; 2735 my ($self, $text, $flags) = @_;
1897 2736
1898 utf8::encode $text; 2737 utf8::encode $text;
1899 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2738 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1900} 2739}
1901 2740
2741=item $client->send_msg ($channel, $msg, $color, [extra...])
2742
2743Send a drawinfo or msg packet to the client, formatting the msg for the
2744client if neccessary. C<$type> should be a string identifying the type of
2745the message, with C<log> being the default. If C<$color> is negative, suppress
2746the message unless the client supports the msg packet.
2747
2748=cut
2749
2750# non-persistent channels (usually the info channel)
2751our %CHANNEL = (
2752 "c/identify" => {
2753 id => "infobox",
2754 title => "Identify",
2755 reply => undef,
2756 tooltip => "Items recently identified",
2757 },
2758 "c/examine" => {
2759 id => "infobox",
2760 title => "Examine",
2761 reply => undef,
2762 tooltip => "Signs and other items you examined",
2763 },
2764 "c/book" => {
2765 id => "infobox",
2766 title => "Book",
2767 reply => undef,
2768 tooltip => "The contents of a note or book",
2769 },
2770 "c/lookat" => {
2771 id => "infobox",
2772 title => "Look",
2773 reply => undef,
2774 tooltip => "What you saw there",
2775 },
2776 "c/who" => {
2777 id => "infobox",
2778 title => "Players",
2779 reply => undef,
2780 tooltip => "Shows players who are currently online",
2781 },
2782 "c/body" => {
2783 id => "infobox",
2784 title => "Body Parts",
2785 reply => undef,
2786 tooltip => "Shows which body parts you posess and are available",
2787 },
2788 "c/statistics" => {
2789 id => "infobox",
2790 title => "Statistics",
2791 reply => undef,
2792 tooltip => "Shows your primary statistics",
2793 },
2794 "c/skills" => {
2795 id => "infobox",
2796 title => "Skills",
2797 reply => undef,
2798 tooltip => "Shows your experience per skill and item power",
2799 },
2800 "c/shopitems" => {
2801 id => "infobox",
2802 title => "Shop Items",
2803 reply => undef,
2804 tooltip => "Shows the items currently for sale in this shop",
2805 },
2806 "c/resistances" => {
2807 id => "infobox",
2808 title => "Resistances",
2809 reply => undef,
2810 tooltip => "Shows your resistances",
2811 },
2812 "c/pets" => {
2813 id => "infobox",
2814 title => "Pets",
2815 reply => undef,
2816 tooltip => "Shows information abotu your pets/a specific pet",
2817 },
2818 "c/perceiveself" => {
2819 id => "infobox",
2820 title => "Perceive Self",
2821 reply => undef,
2822 tooltip => "You gained detailed knowledge about yourself",
2823 },
2824 "c/uptime" => {
2825 id => "infobox",
2826 title => "Uptime",
2827 reply => undef,
2828 tooltip => "How long the server has been running since last restart",
2829 },
2830 "c/mapinfo" => {
2831 id => "infobox",
2832 title => "Map Info",
2833 reply => undef,
2834 tooltip => "Information related to the maps",
2835 },
2836 "c/party" => {
2837 id => "party",
2838 title => "Party",
2839 reply => "gsay ",
2840 tooltip => "Messages and chat related to your party",
2841 },
2842 "c/death" => {
2843 id => "death",
2844 title => "Death",
2845 reply => undef,
2846 tooltip => "Reason for and more info about your most recent death",
2847 },
2848 "c/say" => $SAY_CHANNEL,
2849 "c/chat" => $CHAT_CHANNEL,
2850);
2851
2852sub cf::client::send_msg {
2853 my ($self, $channel, $msg, $color, @extra) = @_;
2854
2855 $msg = $self->pl->expand_cfpod ($msg)
2856 unless $color & cf::NDI_VERBATIM;
2857
2858 $color &= cf::NDI_CLIENT_MASK; # just in case...
2859
2860 # check predefined channels, for the benefit of C
2861 if ($CHANNEL{$channel}) {
2862 $channel = $CHANNEL{$channel};
2863
2864 $self->ext_msg (channel_info => $channel);
2865 $channel = $channel->{id};
2866
2867 } elsif (ref $channel) {
2868 # send meta info to client, if not yet sent
2869 unless (exists $self->{channel}{$channel->{id}}) {
2870 $self->{channel}{$channel->{id}} = $channel;
2871 $self->ext_msg (channel_info => $channel);
2872 }
2873
2874 $channel = $channel->{id};
2875 }
2876
2877 return unless @extra || length $msg;
2878
2879 # default colour, mask it out
2880 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2881 if $color & cf::NDI_DEF;
2882
2883 my $pkt = "msg "
2884 . $self->{json_coder}->encode (
2885 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2886 );
2887
2888 # try lzf for large packets
2889 $pkt = "lzf " . Compress::LZF::compress $pkt
2890 if 1024 <= length $pkt and $self->{can_lzf};
2891
2892 # split very large packets
2893 if (8192 < length $pkt and $self->{can_lzf}) {
2894 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2895 $pkt = "frag";
2896 }
2897
2898 $self->send_packet ($pkt);
2899}
2900
2901=item $client->ext_msg ($type, @msg)
2902
2903Sends an ext event to the client.
2904
2905=cut
2906
2907sub cf::client::ext_msg($$@) {
2908 my ($self, $type, @msg) = @_;
2909
2910 if ($self->extcmd == 2) {
2911 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2912 } elsif ($self->extcmd == 1) { # TODO: remove
2913 push @msg, msgtype => "event_$type";
2914 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2915 }
2916}
2917
2918=item $client->ext_reply ($msgid, @msg)
2919
2920Sends an ext reply to the client.
2921
2922=cut
2923
2924sub cf::client::ext_reply($$@) {
2925 my ($self, $id, @msg) = @_;
2926
2927 if ($self->extcmd == 2) {
2928 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2929 } elsif ($self->extcmd == 1) {
2930 #TODO: version 1, remove
2931 unshift @msg, msgtype => "reply", msgid => $id;
2932 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2933 }
2934}
1902 2935
1903=item $success = $client->query ($flags, "text", \&cb) 2936=item $success = $client->query ($flags, "text", \&cb)
1904 2937
1905Queues a query to the client, calling the given callback with 2938Queues a query to the client, calling the given callback with
1906the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2939the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1907C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2940C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1908 2941
1909Queries can fail, so check the return code. Or don't, as queries will become 2942Queries can fail, so check the return code. Or don't, as queries will
1910reliable at some point in the future. 2943become reliable at some point in the future.
1911 2944
1912=cut 2945=cut
1913 2946
1914sub cf::client::query { 2947sub cf::client::query {
1915 my ($self, $flags, $text, $cb) = @_; 2948 my ($self, $flags, $text, $cb) = @_;
1923 utf8::encode $text; 2956 utf8::encode $text;
1924 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2957 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1925 2958
1926 $self->send_packet ($self->{query_queue}[0][0]) 2959 $self->send_packet ($self->{query_queue}[0][0])
1927 if @{ $self->{query_queue} } == 1; 2960 if @{ $self->{query_queue} } == 1;
2961
2962 1
1928} 2963}
1929 2964
1930cf::client->attach ( 2965cf::client->attach (
2966 on_connect => sub {
2967 my ($ns) = @_;
2968
2969 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2970 },
1931 on_reply => sub { 2971 on_reply => sub {
1932 my ($ns, $msg) = @_; 2972 my ($ns, $msg) = @_;
1933 2973
1934 # this weird shuffling is so that direct followup queries 2974 # this weird shuffling is so that direct followup queries
1935 # get handled first 2975 # get handled first
1936 my $queue = delete $ns->{query_queue} 2976 my $queue = delete $ns->{query_queue}
1937 or return; # be conservative, not sure how that can happen, but we saw a crash here 2977 or return; # be conservative, not sure how that can happen, but we saw a crash here
1938 2978
1939 (shift @$queue)->[1]->($msg); 2979 (shift @$queue)->[1]->($msg);
2980 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1940 2981
1941 push @{ $ns->{query_queue} }, @$queue; 2982 push @{ $ns->{query_queue} }, @$queue;
1942 2983
1943 if (@{ $ns->{query_queue} } == @$queue) { 2984 if (@{ $ns->{query_queue} } == @$queue) {
1944 if (@$queue) { 2985 if (@$queue) {
1946 } else { 2987 } else {
1947 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2988 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1948 } 2989 }
1949 } 2990 }
1950 }, 2991 },
2992 on_exticmd => sub {
2993 my ($ns, $buf) = @_;
2994
2995 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2996
2997 if (ref $msg) {
2998 my ($type, $reply, @payload) =
2999 "ARRAY" eq ref $msg
3000 ? @$msg
3001 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3002
3003 my @reply;
3004
3005 if (my $cb = $EXTICMD{$type}) {
3006 @reply = $cb->($ns, @payload);
3007 }
3008
3009 $ns->ext_reply ($reply, @reply)
3010 if $reply;
3011
3012 } else {
3013 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3014 }
3015
3016 cf::override;
3017 },
1951); 3018);
1952 3019
1953=item $client->async (\&cb) 3020=item $client->async (\&cb)
1954 3021
1955Create a new coroutine, running the specified callback. The coroutine will 3022Create a new coroutine, running the specified callback. The coroutine will
1996our $safe = new Safe "safe"; 3063our $safe = new Safe "safe";
1997our $safe_hole = new Safe::Hole; 3064our $safe_hole = new Safe::Hole;
1998 3065
1999$SIG{FPE} = 'IGNORE'; 3066$SIG{FPE} = 'IGNORE';
2000 3067
2001$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3068$safe->permit_only (Opcode::opset qw(
3069 :base_core :base_mem :base_orig :base_math
3070 grepstart grepwhile mapstart mapwhile
3071 sort time
3072));
2002 3073
2003# here we export the classes and methods available to script code 3074# here we export the classes and methods available to script code
2004 3075
2005=pod 3076=pod
2006 3077
2007The following fucntions and emthods are available within a safe environment: 3078The following functions and methods are available within a safe environment:
2008 3079
2009 cf::object contr pay_amount pay_player map 3080 cf::object
3081 contr pay_amount pay_player map x y force_find force_add destroy
3082 insert remove name archname title slaying race decrease split
3083 value
3084
2010 cf::object::player player 3085 cf::object::player
2011 cf::player peaceful 3086 player
2012 cf::map trigger 3087
3088 cf::player
3089 peaceful
3090
3091 cf::map
3092 trigger
2013 3093
2014=cut 3094=cut
2015 3095
2016for ( 3096for (
2017 ["cf::object" => qw(contr pay_amount pay_player map)], 3097 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3098 insert remove inv nrof name archname title slaying race
3099 decrease split destroy change_exp value msg lore send_msg)],
2018 ["cf::object::player" => qw(player)], 3100 ["cf::object::player" => qw(player)],
2019 ["cf::player" => qw(peaceful)], 3101 ["cf::player" => qw(peaceful send_msg)],
2020 ["cf::map" => qw(trigger)], 3102 ["cf::map" => qw(trigger)],
2021) { 3103) {
2022 no strict 'refs'; 3104 no strict 'refs';
2023 my ($pkg, @funs) = @$_; 3105 my ($pkg, @funs) = @$_;
2024 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3106 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2041 my ($code, %vars) = @_; 3123 my ($code, %vars) = @_;
2042 3124
2043 my $qcode = $code; 3125 my $qcode = $code;
2044 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3126 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2045 $qcode =~ s/\n/\\n/g; 3127 $qcode =~ s/\n/\\n/g;
3128
3129 %vars = (_dummy => 0) unless %vars;
2046 3130
2047 local $_; 3131 local $_;
2048 local @safe::cf::_safe_eval_args = values %vars; 3132 local @safe::cf::_safe_eval_args = values %vars;
2049 3133
2050 my $eval = 3134 my $eval =
2093=back 3177=back
2094 3178
2095=cut 3179=cut
2096 3180
2097############################################################################# 3181#############################################################################
3182# the server's init and main functions
2098 3183
2099=head2 EXTENSION DATABASE SUPPORT 3184sub load_facedata($) {
3185 my ($path) = @_;
2100 3186
2101Crossfire maintains a very simple database for extension use. It can 3187 # HACK to clear player env face cache, we need some signal framework
2102currently store anything that can be serialised using Storable, which 3188 # for this (global event?)
2103excludes objects. 3189 %ext::player_env::MUSIC_FACE_CACHE = ();
2104 3190
2105The parameter C<$family> should best start with the name of the extension 3191 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2106using it, it should be unique.
2107 3192
2108=over 4 3193 warn "loading facedata from $path\n";
2109 3194
2110=item $hashref = cf::db_get $family 3195 my $facedata;
3196 0 < aio_load $path, $facedata
3197 or die "$path: $!";
2111 3198
2112Return a hashref for use by the extension C<$family>, which can be 3199 $facedata = Coro::Storable::thaw $facedata;
2113modified. After modifications, you have to call C<cf::db_dirty> or
2114C<cf::db_sync>.
2115 3200
2116=item $value = cf::db_get $family => $key 3201 $facedata->{version} == 2
3202 or cf::cleanup "$path: version mismatch, cannot proceed.";
2117 3203
2118Returns a single value from the database 3204 # patch in the exptable
2119 3205 $facedata->{resource}{"res/exp_table"} = {
2120=item cf::db_put $family => $hashref 3206 type => FT_RSRC,
2121 3207 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2122Stores the given family hashref into the database. Updates are delayed, if
2123you want the data to be synced to disk immediately, use C<cf::db_sync>.
2124
2125=item cf::db_put $family => $key => $value
2126
2127Stores the given C<$value> in the family hash. Updates are delayed, if you
2128want the data to be synced to disk immediately, use C<cf::db_sync>.
2129
2130=item cf::db_dirty
2131
2132Marks the database as dirty, to be updated at a later time.
2133
2134=item cf::db_sync
2135
2136Immediately write the database to disk I<if it is dirty>.
2137
2138=cut
2139
2140our $DB;
2141
2142{
2143 my $path = cf::localdir . "/database.pst";
2144
2145 sub db_load() {
2146 $DB = stat $path ? Storable::retrieve $path : { };
2147 }
2148
2149 my $pid;
2150
2151 sub db_save() {
2152 waitpid $pid, 0 if $pid;
2153 if (0 == ($pid = fork)) {
2154 $DB->{_meta}{version} = 1;
2155 Storable::nstore $DB, "$path~";
2156 rename "$path~", $path;
2157 cf::_exit 0 if defined $pid;
2158 }
2159 }
2160
2161 my $dirty;
2162
2163 sub db_sync() {
2164 db_save if $dirty;
2165 undef $dirty;
2166 }
2167
2168 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2169 db_sync;
2170 }); 3208 };
3209 cf::cede_to_tick;
2171 3210
2172 sub db_dirty() {
2173 $dirty = 1;
2174 $idle->start;
2175 } 3211 {
3212 my $faces = $facedata->{faceinfo};
2176 3213
2177 sub db_get($;$) { 3214 while (my ($face, $info) = each %$faces) {
2178 @_ >= 2 3215 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2179 ? $DB->{$_[0]}{$_[1]}
2180 : ($DB->{$_[0]} ||= { })
2181 }
2182 3216
2183 sub db_put($$;$) { 3217 cf::face::set_visibility $idx, $info->{visibility};
2184 if (@_ >= 3) { 3218 cf::face::set_magicmap $idx, $info->{magicmap};
2185 $DB->{$_[0]}{$_[1]} = $_[2]; 3219 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2186 } else { 3220 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2187 $DB->{$_[0]} = $_[1];
2188 }
2189 db_dirty;
2190 }
2191 3221
2192 cf::global->attach ( 3222 cf::cede_to_tick;
2193 prio => 10000,
2194 on_cleanup => sub {
2195 db_sync;
2196 }, 3223 }
2197 );
2198}
2199 3224
2200############################################################################# 3225 while (my ($face, $info) = each %$faces) {
2201# the server's main() 3226 next unless $info->{smooth};
2202 3227
2203sub cfg_load { 3228 my $idx = cf::face::find $face
3229 or next;
3230
3231 if (my $smooth = cf::face::find $info->{smooth}) {
3232 cf::face::set_smooth $idx, $smooth;
3233 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3234 } else {
3235 warn "smooth face '$info->{smooth}' not found for face '$face'";
3236 }
3237
3238 cf::cede_to_tick;
3239 }
3240 }
3241
3242 {
3243 my $anims = $facedata->{animinfo};
3244
3245 while (my ($anim, $info) = each %$anims) {
3246 cf::anim::set $anim, $info->{frames}, $info->{facings};
3247 cf::cede_to_tick;
3248 }
3249
3250 cf::anim::invalidate_all; # d'oh
3251 }
3252
3253 {
3254 # TODO: for gcfclient pleasure, we should give resources
3255 # that gcfclient doesn't grok a >10000 face index.
3256 my $res = $facedata->{resource};
3257
3258 while (my ($name, $info) = each %$res) {
3259 if (defined $info->{type}) {
3260 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3261 my $data;
3262
3263 if ($info->{type} & 1) {
3264 # prepend meta info
3265
3266 my $meta = $enc->encode ({
3267 name => $name,
3268 %{ $info->{meta} || {} },
3269 });
3270
3271 $data = pack "(w/a*)*", $meta, $info->{data};
3272 } else {
3273 $data = $info->{data};
3274 }
3275
3276 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3277 cf::face::set_type $idx, $info->{type};
3278 } else {
3279 $RESOURCE{$name} = $info;
3280 }
3281
3282 cf::cede_to_tick;
3283 }
3284 }
3285
3286 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3287
3288 1
3289}
3290
3291cf::global->attach (on_resource_update => sub {
3292 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3293 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3294
3295 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3296 my $sound = $soundconf->{compat}[$_]
3297 or next;
3298
3299 my $face = cf::face::find "sound/$sound->[1]";
3300 cf::sound::set $sound->[0] => $face;
3301 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3302 }
3303
3304 while (my ($k, $v) = each %{$soundconf->{event}}) {
3305 my $face = cf::face::find "sound/$v";
3306 cf::sound::set $k => $face;
3307 }
3308 }
3309});
3310
3311register_exticmd fx_want => sub {
3312 my ($ns, $want) = @_;
3313
3314 while (my ($k, $v) = each %$want) {
3315 $ns->fx_want ($k, $v);
3316 }
3317};
3318
3319sub load_resource_file($) {
3320 my $guard = lock_acquire "load_resource_file";
3321
3322 my $status = load_resource_file_ $_[0];
3323 get_slot 0.1, 100;
3324 cf::arch::commit_load;
3325
3326 $status
3327}
3328
3329sub reload_regions {
3330 # HACK to clear player env face cache, we need some signal framework
3331 # for this (global event?)
3332 %ext::player_env::MUSIC_FACE_CACHE = ();
3333
3334 load_resource_file "$MAPDIR/regions"
3335 or die "unable to load regions file\n";
3336
3337 for (cf::region::list) {
3338 $_->{match} = qr/$_->{match}/
3339 if exists $_->{match};
3340 }
3341}
3342
3343sub reload_facedata {
3344 load_facedata "$DATADIR/facedata"
3345 or die "unable to load facedata\n";
3346}
3347
3348sub reload_archetypes {
3349 load_resource_file "$DATADIR/archetypes"
3350 or die "unable to load archetypes\n";
3351}
3352
3353sub reload_treasures {
3354 load_resource_file "$DATADIR/treasures"
3355 or die "unable to load treasurelists\n";
3356}
3357
3358sub reload_resources {
3359 warn "reloading resource files...\n";
3360
3361 reload_facedata;
3362 reload_archetypes;
3363 reload_regions;
3364 reload_treasures;
3365
3366 warn "finished reloading resource files\n";
3367}
3368
3369sub reload_config {
2204 open my $fh, "<:utf8", cf::confdir . "/config" 3370 open my $fh, "<:utf8", "$CONFDIR/config"
2205 or return; 3371 or return;
2206 3372
2207 local $/; 3373 local $/;
2208 *CFG = YAML::Syck::Load <$fh>; 3374 *CFG = YAML::Load <$fh>;
2209 3375
2210 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3376 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2211 3377
2212 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3378 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2213 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3379 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2219 }; 3385 };
2220 warn $@ if $@; 3386 warn $@ if $@;
2221 } 3387 }
2222} 3388}
2223 3389
3390sub pidfile() {
3391 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3392 or die "$PIDFILE: $!";
3393 flock $fh, &Fcntl::LOCK_EX
3394 or die "$PIDFILE: flock: $!";
3395 $fh
3396}
3397
3398# make sure only one server instance is running at any one time
3399sub atomic {
3400 my $fh = pidfile;
3401
3402 my $pid = <$fh>;
3403 kill 9, $pid if $pid > 0;
3404
3405 seek $fh, 0, 0;
3406 print $fh $$;
3407}
3408
3409sub main_loop {
3410 warn "EV::loop starting\n";
3411 if (1) {
3412 EV::loop;
3413 }
3414 warn "EV::loop returned\n";
3415 goto &main_loop unless $REALLY_UNLOOP;
3416}
3417
2224sub main { 3418sub main {
3419 cf::init_globals; # initialise logging
3420
3421 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3422 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3423 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3424 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3425
3426 cf::init_experience;
3427 cf::init_anim;
3428 cf::init_attackmess;
3429 cf::init_dynamic;
3430
3431 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3432
2225 # we must not ever block the main coroutine 3433 # we must not ever block the main coroutine
2226 local $Coro::idle = sub { 3434 local $Coro::idle = sub {
2227 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3435 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2228 async { Event::one_event }; 3436 (async {
3437 $Coro::current->{desc} = "IDLE BUG HANDLER";
3438 EV::loop EV::LOOP_ONESHOT;
3439 })->prio (Coro::PRIO_MAX);
2229 }; 3440 };
2230 3441
2231 cfg_load; 3442 evthread_start IO::AIO::poll_fileno;
2232 db_load; 3443
3444 cf::sync_job {
3445 reload_resources;
3446 reload_config;
3447 db_init;
3448
3449 cf::load_settings;
3450 cf::load_materials;
3451 cf::init_uuid;
3452 cf::init_signals;
3453 cf::init_commands;
3454 cf::init_skills;
3455
3456 cf::init_beforeplay;
3457
3458 atomic;
3459
2233 load_extensions; 3460 load_extensions;
2234 Event::loop; 3461
3462 utime time, time, $RUNTIMEFILE;
3463
3464 # no (long-running) fork's whatsoever before this point(!)
3465 use POSIX ();
3466 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3467
3468 (pop @POST_INIT)->(0) while @POST_INIT;
3469 };
3470
3471 main_loop;
2235} 3472}
2236 3473
2237############################################################################# 3474#############################################################################
2238# initialisation and cleanup 3475# initialisation and cleanup
2239 3476
2240# install some emergency cleanup handlers 3477# install some emergency cleanup handlers
2241BEGIN { 3478BEGIN {
3479 our %SIGWATCHER = ();
2242 for my $signal (qw(INT HUP TERM)) { 3480 for my $signal (qw(INT HUP TERM)) {
2243 Event->signal ( 3481 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2244 data => WF_AUTOCANCEL,
2245 signal => $signal,
2246 cb => sub {
2247 cf::cleanup "SIG$signal"; 3482 cf::cleanup "SIG$signal";
2248 },
2249 ); 3483 };
3484 }
3485}
3486
3487sub write_runtime_sync {
3488 # first touch the runtime file to show we are still running:
3489 # the fsync below can take a very very long time.
3490
3491 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3492
3493 my $guard = cf::lock_acquire "write_runtime";
3494
3495 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3496 or return;
3497
3498 my $value = $cf::RUNTIME + 90 + 10;
3499 # 10 is the runtime save interval, for a monotonic clock
3500 # 60 allows for the watchdog to kill the server.
3501
3502 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3503 and return;
3504
3505 # always fsync - this file is important
3506 aio_fsync $fh
3507 and return;
3508
3509 # touch it again to show we are up-to-date
3510 aio_utime $fh, undef, undef;
3511
3512 close $fh
3513 or return;
3514
3515 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3516 and return;
3517
3518 warn "runtime file written.\n";
3519
2250 } 3520 1
3521}
3522
3523our $uuid_lock;
3524our $uuid_skip;
3525
3526sub write_uuid_sync($) {
3527 $uuid_skip ||= $_[0];
3528
3529 return if $uuid_lock;
3530 local $uuid_lock = 1;
3531
3532 my $uuid = "$LOCALDIR/uuid";
3533
3534 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3535 or return;
3536
3537 my $value = uuid_seq uuid_cur;
3538
3539 unless ($value) {
3540 warn "cowardly refusing to write zero uuid value!\n";
3541 return;
3542 }
3543
3544 my $value = uuid_str $value + $uuid_skip;
3545 $uuid_skip = 0;
3546
3547 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3548 and return;
3549
3550 # always fsync - this file is important
3551 aio_fsync $fh
3552 and return;
3553
3554 close $fh
3555 or return;
3556
3557 aio_rename "$uuid~", $uuid
3558 and return;
3559
3560 warn "uuid file written ($value).\n";
3561
3562 1
3563
3564}
3565
3566sub write_uuid($$) {
3567 my ($skip, $sync) = @_;
3568
3569 $sync ? write_uuid_sync $skip
3570 : async { write_uuid_sync $skip };
2251} 3571}
2252 3572
2253sub emergency_save() { 3573sub emergency_save() {
2254 my $freeze_guard = cf::freeze_mainloop; 3574 my $freeze_guard = cf::freeze_mainloop;
2255 3575
2256 warn "enter emergency perl save\n"; 3576 warn "emergency_perl_save: enter\n";
2257 3577
2258 cf::sync_job { 3578 cf::sync_job {
3579 # this is a trade-off: we want to be very quick here, so
3580 # save all maps without fsync, and later call a global sync
3581 # (which in turn might be very very slow)
3582 local $USE_FSYNC = 0;
3583
2259 # use a peculiar iteration method to avoid tripping on perl 3584 # use a peculiar iteration method to avoid tripping on perl
2260 # refcount bugs in for. also avoids problems with players 3585 # refcount bugs in for. also avoids problems with players
2261 # and maps saved/Destroyed asynchronously. 3586 # and maps saved/destroyed asynchronously.
2262 warn "begin emergency player save\n"; 3587 warn "emergency_perl_save: begin player save\n";
2263 for my $login (keys %cf::PLAYER) { 3588 for my $login (keys %cf::PLAYER) {
2264 my $pl = $cf::PLAYER{$login} or next; 3589 my $pl = $cf::PLAYER{$login} or next;
2265 $pl->valid or next; 3590 $pl->valid or next;
3591 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2266 $pl->save; 3592 $pl->save;
2267 } 3593 }
2268 warn "end emergency player save\n"; 3594 warn "emergency_perl_save: end player save\n";
2269 3595
2270 warn "begin emergency map save\n"; 3596 warn "emergency_perl_save: begin map save\n";
2271 for my $path (keys %cf::MAP) { 3597 for my $path (keys %cf::MAP) {
2272 my $map = $cf::MAP{$path} or next; 3598 my $map = $cf::MAP{$path} or next;
2273 $map->valid or next; 3599 $map->valid or next;
2274 $map->save; 3600 $map->save;
2275 } 3601 }
2276 warn "end emergency map save\n"; 3602 warn "emergency_perl_save: end map save\n";
3603
3604 warn "emergency_perl_save: begin database checkpoint\n";
3605 BDB::db_env_txn_checkpoint $DB_ENV;
3606 warn "emergency_perl_save: end database checkpoint\n";
3607
3608 warn "emergency_perl_save: begin write uuid\n";
3609 write_uuid_sync 1;
3610 warn "emergency_perl_save: end write uuid\n";
2277 }; 3611 };
2278 3612
3613 warn "emergency_perl_save: starting sync()\n";
3614 IO::AIO::aio_sync sub {
3615 warn "emergency_perl_save: finished sync()\n";
3616 };
3617
2279 warn "leave emergency perl save\n"; 3618 warn "emergency_perl_save: leave\n";
2280} 3619}
2281 3620
3621sub post_cleanup {
3622 my ($make_core) = @_;
3623
3624 warn Carp::longmess "post_cleanup backtrace"
3625 if $make_core;
3626
3627 my $fh = pidfile;
3628 unlink $PIDFILE if <$fh> == $$;
3629}
3630
3631# a safer delete_package, copied from Symbol
3632sub clear_package($) {
3633 my $pkg = shift;
3634
3635 # expand to full symbol table name if needed
3636 unless ($pkg =~ /^main::.*::$/) {
3637 $pkg = "main$pkg" if $pkg =~ /^::/;
3638 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3639 $pkg .= '::' unless $pkg =~ /::$/;
3640 }
3641
3642 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3643 my $stem_symtab = *{$stem}{HASH};
3644
3645 defined $stem_symtab and exists $stem_symtab->{$leaf}
3646 or return;
3647
3648 # clear all symbols
3649 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3650 for my $name (keys %$leaf_symtab) {
3651 _gv_clear *{"$pkg$name"};
3652# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3653 }
3654 warn "cleared package $pkg\n";#d#
3655}
3656
2282sub reload() { 3657sub do_reload_perl() {
2283 # can/must only be called in main 3658 # can/must only be called in main
2284 if ($Coro::current != $Coro::main) { 3659 if ($Coro::current != $Coro::main) {
2285 warn "can only reload from main coroutine\n"; 3660 warn "can only reload from main coroutine";
2286 return; 3661 return;
2287 } 3662 }
2288 3663
3664 return if $RELOAD++;
3665
3666 my $t1 = EV::time;
3667
3668 while ($RELOAD) {
2289 warn "reloading..."; 3669 warn "reloading...";
2290 3670
2291 warn "freezing server"; 3671 warn "entering sync_job";
2292 my $guard = freeze_mainloop; 3672
3673 cf::sync_job {
3674 cf::write_runtime_sync; # external watchdog should not bark
2293 cf::emergency_save; 3675 cf::emergency_save;
3676 cf::write_runtime_sync; # external watchdog should not bark
2294 3677
2295 warn "sync database to disk"; 3678 warn "syncing database to disk";
2296 cf::db_sync; 3679 BDB::db_env_txn_checkpoint $DB_ENV;
2297 IO::AIO::flush;
2298 3680
2299 eval {
2300 # if anything goes wrong in here, we should simply crash as we already saved 3681 # if anything goes wrong in here, we should simply crash as we already saved
2301 3682
2302 warn "cancel all watchers"; 3683 warn "flushing outstanding aio requests";
2303 for (Event::all_watchers) { 3684 while (IO::AIO::nreqs || BDB::nreqs) {
2304 $_->cancel if $_->data & WF_AUTOCANCEL; 3685 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2305 }
2306
2307 warn "cancel all extension coros";
2308 $_->cancel for values %EXT_CORO;
2309 %EXT_CORO = ();
2310
2311 warn "remove commands";
2312 %COMMAND = ();
2313
2314 warn "remove ext commands";
2315 %EXTCMD = ();
2316
2317 warn "unload/nuke all extensions";
2318 for my $pkg (@EXTS) {
2319 warn "unloading <$pkg>";
2320
2321 if (my $cb = $pkg->can ("unload")) {
2322 eval {
2323 $cb->($pkg);
2324 1
2325 } or warn "$pkg unloaded, but with errors: $@";
2326 } 3686 }
2327 3687
2328 Symbol::delete_package $pkg; 3688 warn "cancelling all extension coros";
2329 } 3689 $_->cancel for values %EXT_CORO;
3690 %EXT_CORO = ();
2330 3691
2331 warn "unload all perl modules loaded from $LIBDIR";
2332 while (my ($k, $v) = each %INC) {
2333 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2334
2335 warn "removing <$k>"; 3692 warn "removing commands";
2336 delete $INC{$k}; 3693 %COMMAND = ();
2337 3694
2338 $k =~ s/\.pm$//; 3695 warn "removing ext/exti commands";
2339 $k =~ s/\//::/g; 3696 %EXTCMD = ();
3697 %EXTICMD = ();
2340 3698
3699 warn "unloading/nuking all extensions";
3700 for my $pkg (@EXTS) {
3701 warn "... unloading $pkg";
3702
2341 if (my $cb = $k->can ("unload_module")) { 3703 if (my $cb = $pkg->can ("unload")) {
3704 eval {
2342 $cb->(); 3705 $cb->($pkg);
3706 1
3707 } or warn "$pkg unloaded, but with errors: $@";
3708 }
3709
3710 warn "... clearing $pkg";
3711 clear_package $pkg;
2343 } 3712 }
2344 3713
2345 Symbol::delete_package $k; 3714 warn "unloading all perl modules loaded from $LIBDIR";
3715 while (my ($k, $v) = each %INC) {
3716 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3717
3718 warn "... unloading $k";
3719 delete $INC{$k};
3720
3721 $k =~ s/\.pm$//;
3722 $k =~ s/\//::/g;
3723
3724 if (my $cb = $k->can ("unload_module")) {
3725 $cb->();
3726 }
3727
3728 clear_package $k;
2346 } 3729 }
2347 3730
2348 warn "get rid of safe::, as good as possible"; 3731 warn "getting rid of safe::, as good as possible";
2349 Symbol::delete_package "safe::$_" 3732 clear_package "safe::$_"
2350 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3733 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2351 3734
2352 warn "unload cf.pm \"a bit\""; 3735 warn "unloading cf.pm \"a bit\"";
2353 delete $INC{"cf.pm"}; 3736 delete $INC{"cf.pm"};
3737 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2354 3738
2355 # don't, removes xs symbols, too, 3739 # don't, removes xs symbols, too,
2356 # and global variables created in xs 3740 # and global variables created in xs
2357 #Symbol::delete_package __PACKAGE__; 3741 #clear_package __PACKAGE__;
2358 3742
3743 warn "unload completed, starting to reload now";
3744
2359 warn "reloading cf.pm"; 3745 warn "reloading cf.pm";
2360 require cf; 3746 require cf;
2361 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3747 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2362 3748
2363 warn "load config and database again"; 3749 warn "loading config and database again";
2364 cf::cfg_load; 3750 cf::reload_config;
2365 cf::db_load;
2366 3751
2367 warn "load extensions"; 3752 warn "loading extensions";
2368 cf::load_extensions; 3753 cf::load_extensions;
2369 3754
3755 if ($REATTACH_ON_RELOAD) {
2370 warn "reattach attachments to objects/players"; 3756 warn "reattaching attachments to objects/players";
2371 _global_reattach; 3757 _global_reattach; # objects, sockets
2372 warn "reattach attachments to maps"; 3758 warn "reattaching attachments to maps";
2373 reattach $_ for values %MAP; 3759 reattach $_ for values %MAP;
3760 warn "reattaching attachments to players";
3761 reattach $_ for values %PLAYER;
3762 }
3763
3764 warn "running post_init jobs";
3765 (pop @POST_INIT)->(1) while @POST_INIT;
3766
3767 warn "leaving sync_job";
3768
3769 1
3770 } or do {
3771 warn $@;
3772 cf::cleanup "error while reloading, exiting.";
3773 };
3774
3775 warn "reloaded";
3776 --$RELOAD;
3777 }
3778
3779 $t1 = EV::time - $t1;
3780 warn "reload completed in ${t1}s\n";
3781};
3782
3783our $RELOAD_WATCHER; # used only during reload
3784
3785sub reload_perl() {
3786 # doing reload synchronously and two reloads happen back-to-back,
3787 # coro crashes during coro_state_free->destroy here.
3788
3789 $RELOAD_WATCHER ||= cf::async {
3790 Coro::AIO::aio_wait cache_extensions;
3791
3792 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3793 do_reload_perl;
3794 undef $RELOAD_WATCHER;
3795 };
2374 }; 3796 };
2375
2376 if ($@) {
2377 warn $@;
2378 warn "error while reloading, exiting.";
2379 exit 1;
2380 }
2381
2382 warn "reloaded";
2383};
2384
2385#############################################################################
2386
2387unless ($LINK_MAP) {
2388 $LINK_MAP = cf::map::new;
2389
2390 $LINK_MAP->width (41);
2391 $LINK_MAP->height (41);
2392 $LINK_MAP->alloc;
2393 $LINK_MAP->path ("{link}");
2394 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2395 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2396
2397 # dirty hack because... archetypes are not yet loaded
2398 Event->timer (
2399 after => 10,
2400 cb => sub {
2401 $_[0]->w->cancel;
2402
2403 # provide some exits "home"
2404 my $exit = cf::object::new "exit";
2405
2406 $exit->slaying ($EMERGENCY_POSITION->[0]);
2407 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2408 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2409
2410 $LINK_MAP->insert ($exit->clone, 19, 19);
2411 $LINK_MAP->insert ($exit->clone, 19, 20);
2412 $LINK_MAP->insert ($exit->clone, 19, 21);
2413 $LINK_MAP->insert ($exit->clone, 20, 19);
2414 $LINK_MAP->insert ($exit->clone, 20, 21);
2415 $LINK_MAP->insert ($exit->clone, 21, 19);
2416 $LINK_MAP->insert ($exit->clone, 21, 20);
2417 $LINK_MAP->insert ($exit->clone, 21, 21);
2418
2419 $exit->destroy;
2420 });
2421
2422 $LINK_MAP->{deny_save} = 1;
2423 $LINK_MAP->{deny_reset} = 1;
2424
2425 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2426} 3797}
2427 3798
2428register_command "reload" => sub { 3799register_command "reload" => sub {
2429 my ($who, $arg) = @_; 3800 my ($who, $arg) = @_;
2430 3801
2431 if ($who->flag (FLAG_WIZ)) { 3802 if ($who->flag (FLAG_WIZ)) {
2432 $who->message ("start of reload.");
2433 reload;
2434 $who->message ("end of reload."); 3803 $who->message ("reloading server.");
3804 async {
3805 $Coro::current->{desc} = "perl_reload";
3806 reload_perl;
3807 };
2435 } 3808 }
2436}; 3809};
2437 3810
2438unshift @INC, $LIBDIR; 3811unshift @INC, $LIBDIR;
2439 3812
2440$TICK_WATCHER = Event->timer ( 3813my $bug_warning = 0;
2441 reentrant => 0, 3814
2442 prio => 0, 3815our @WAIT_FOR_TICK;
2443 at => $NEXT_TICK || $TICK, 3816our @WAIT_FOR_TICK_BEGIN;
2444 data => WF_AUTOCANCEL, 3817
2445 cb => sub { 3818sub wait_for_tick {
3819 return if tick_inhibit || $Coro::current == $Coro::main;
3820
3821 my $signal = new Coro::Signal;
3822 push @WAIT_FOR_TICK, $signal;
3823 $signal->wait;
3824}
3825
3826sub wait_for_tick_begin {
3827 return if tick_inhibit || $Coro::current == $Coro::main;
3828
3829 my $signal = new Coro::Signal;
3830 push @WAIT_FOR_TICK_BEGIN, $signal;
3831 $signal->wait;
3832}
3833
3834sub tick {
3835 if ($Coro::current != $Coro::main) {
3836 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3837 unless ++$bug_warning > 10;
3838 return;
3839 }
3840
2446 cf::server_tick; # one server iteration 3841 cf::server_tick; # one server iteration
2447 $RUNTIME += $TICK;
2448 $NEXT_TICK += $TICK;
2449 3842
2450 $WAIT_FOR_TICK->broadcast; 3843 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2451 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3844 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2452 3845 Coro::async_pool {
2453 # if we are delayed by four ticks or more, skip them all 3846 $Coro::current->{desc} = "runtime saver";
2454 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2455
2456 $TICK_WATCHER->at ($NEXT_TICK);
2457 $TICK_WATCHER->start;
2458 },
2459);
2460
2461IO::AIO::max_poll_time $TICK * 0.2;
2462
2463Event->io (
2464 fd => IO::AIO::poll_fileno,
2465 poll => 'r',
2466 prio => 5,
2467 data => WF_AUTOCANCEL,
2468 cb => \&IO::AIO::poll_cb,
2469);
2470
2471Event->timer (
2472 data => WF_AUTOCANCEL,
2473 after => 0,
2474 interval => 10,
2475 cb => sub {
2476 (Coro::unblock_sub {
2477 write_runtime 3847 write_runtime_sync
2478 or warn "ERROR: unable to write runtime file: $!"; 3848 or warn "ERROR: unable to write runtime file: $!";
2479 })->(); 3849 };
2480 }, 3850 }
2481); 3851
3852 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3853 $sig->send;
3854 }
3855 while (my $sig = shift @WAIT_FOR_TICK) {
3856 $sig->send;
3857 }
3858
3859 $LOAD = ($NOW - $TICK_START) / $TICK;
3860 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3861
3862 if (0) {
3863 if ($NEXT_TICK) {
3864 my $jitter = $TICK_START - $NEXT_TICK;
3865 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3866 warn "jitter $JITTER\n";#d#
3867 }
3868 }
3869}
3870
3871{
3872 # configure BDB
3873
3874 BDB::min_parallel 8;
3875 BDB::max_poll_reqs $TICK * 0.1;
3876 $AnyEvent::BDB::WATCHER->priority (1);
3877
3878 unless ($DB_ENV) {
3879 $DB_ENV = BDB::db_env_create;
3880 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3881 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3882 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3883 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3884 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3885
3886 cf::sync_job {
3887 eval {
3888 BDB::db_env_open
3889 $DB_ENV,
3890 $BDBDIR,
3891 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3892 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3893 0666;
3894
3895 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3896 };
3897
3898 cf::cleanup "db_env_open(db): $@" if $@;
3899 };
3900 }
3901
3902 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3903 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3904 };
3905 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3906 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3907 };
3908 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3909 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3910 };
3911}
3912
3913{
3914 # configure IO::AIO
3915
3916 IO::AIO::min_parallel 8;
3917 IO::AIO::max_poll_time $TICK * 0.1;
3918 undef $AnyEvent::AIO::WATCHER;
3919}
3920
3921my $_log_backtrace;
3922
3923sub _log_backtrace {
3924 my ($msg, @addr) = @_;
3925
3926 $msg =~ s/\n//;
3927
3928 # limit the # of concurrent backtraces
3929 if ($_log_backtrace < 2) {
3930 ++$_log_backtrace;
3931 my $perl_bt = Carp::longmess $msg;
3932 async {
3933 $Coro::current->{desc} = "abt $msg";
3934
3935 my @bt = fork_call {
3936 @addr = map { sprintf "%x", $_ } @addr;
3937 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3938 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3939 or die "addr2line: $!";
3940
3941 my @funcs;
3942 my @res = <$fh>;
3943 chomp for @res;
3944 while (@res) {
3945 my ($func, $line) = splice @res, 0, 2, ();
3946 push @funcs, "[$func] $line";
3947 }
3948
3949 @funcs
3950 };
3951
3952 LOG llevInfo, "[ABT] $perl_bt\n";
3953 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3954 LOG llevInfo, "[ABT] $_\n" for @bt;
3955 --$_log_backtrace;
3956 };
3957 } else {
3958 LOG llevInfo, "[ABT] $msg\n";
3959 LOG llevInfo, "[ABT] [suppressed]\n";
3960 }
3961}
3962
3963# load additional modules
3964require "cf/$_.pm" for @EXTRA_MODULES;
2482 3965
2483END { cf::emergency_save } 3966END { cf::emergency_save }
2484 3967
24851 39681
2486 3969

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines