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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines