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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines