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.157 by root, Wed Jan 10 01:16:54 2007 UTC vs.
Revision 1.477 by root, Wed Sep 2 22:52:36 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines