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.160 by root, Wed Jan 10 22:54:06 2007 UTC vs.
Revision 1.483 by root, Mon Oct 12 04:02:17 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines