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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines