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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines