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.65 by root, Tue Sep 12 22:18:55 2006 UTC vs.
Revision 1.269 by root, Tue May 22 21:35:26 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
8use Socket;
5use Storable; 9use Storable;
10use Event;
6use Opcode; 11use Opcode;
7use Safe; 12use Safe;
8use Safe::Hole; 13use Safe::Hole;
9 14
15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::Event;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
24
25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
28use Fcntl;
29use YAML::Syck ();
30use IO::AIO 2.32 ();
10use Time::HiRes; 31use Time::HiRes;
11use Event; 32use Compress::LZF;
33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
12$Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
13 41
14use strict; 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
43$YAML::Syck::ImplicitUnicode = 1;
15 44
16_init_vars; 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
17 46
47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
48
18our %COMMAND = (); 49our %COMMAND = ();
50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
56
57our $RELOAD; # number of reloads so far
19our @EVENT; 58our @EVENT;
20our $LIBDIR = maps_directory "perl";
21 59
22our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
23our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
24our $NEXT_TICK; 76our $NEXT_TICK;
77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
82
83our %CFG;
84
85our $UPTIME; $UPTIME ||= time;
86our $RUNTIME;
87
88our %PLAYER; # all users
89our %MAP; # all maps
90our $LINK_MAP; # the special {link} map, which is always available
91
92# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
98
99binmode STDOUT;
100binmode STDERR;
101
102# read virtual server time, if available
103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
104 open my $fh, "<", "$LOCALDIR/runtime"
105 or die "unable to read runtime file: $!";
106 $RUNTIME = <$fh> + 0.;
107}
108
109mkdir $_
110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
111
112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
115
116#############################################################################
117
118=head2 GLOBAL VARIABLES
119
120=over 4
121
122=item $cf::UPTIME
123
124The timestamp of the server start (so not actually an uptime).
125
126=item $cf::RUNTIME
127
128The time this server has run, starts at 0 and is increased by $cf::TICK on
129every server tick.
130
131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
134
135Various directories - "/etc", read-only install directory, perl-library
136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
139
140=item $cf::NOW
141
142The time of the last (current) server tick.
143
144=item $cf::TICK
145
146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
157
158=item %cf::CFG
159
160Configuration for the server, loaded from C</etc/crossfire/config>, or
161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168
169=back
170
171=cut
25 172
26BEGIN { 173BEGIN {
27 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
28 my $msg = join "", @_; 175 my $msg = join "", @_;
176
29 $msg .= "\n" 177 $msg .= "\n"
30 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
31 179
32 print STDERR "cfperl: $msg"; 180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
33 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
34 }; 184 };
35} 185}
36 186
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
37@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38 193
39# we bless all objects into (empty) derived classes to force a method lookup 194# we bless all objects into (empty) derived classes to force a method lookup
40# within the Safe compartment. 195# within the Safe compartment.
41for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 196for my $pkg (qw(
197 cf::global cf::attachable
198 cf::object cf::object::player
199 cf::client cf::player
200 cf::arch cf::living
201 cf::map cf::party cf::region
202)) {
42 no strict 'refs'; 203 no strict 'refs';
43 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 204 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44} 205}
45 206
46$Event::DIED = sub { 207$Event::DIED = sub {
47 warn "error in event callback: @_"; 208 warn "error in event callback: @_";
48}; 209};
49 210
50my %ext_pkg; 211=head2 UTILITY FUNCTIONS
51my @exts; 212
52my @hook; 213=over 4
53my %command; 214
54my %extcmd; 215=item dumpval $ref
216
217=cut
218
219sub dumpval {
220 eval {
221 local $SIG{__DIE__};
222 my $d;
223 if (1) {
224 $d = new Data::Dumper([$_[0]], ["*var"]);
225 $d->Terse(1);
226 $d->Indent(2);
227 $d->Quotekeys(0);
228 $d->Useqq(1);
229 #$d->Bless(...);
230 $d->Seen($_[1]) if @_ > 1;
231 $d = $d->Dump();
232 }
233 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234 $d
235 } || "[unable to dump $_[0]: '$@']";
236}
237
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240=item $ref = cf::from_json $json
241
242Converts a JSON string into the corresponding perl data structure.
243
244=item $json = cf::to_json $ref
245
246Converts a perl data structure into its JSON representation.
247
248=item cf::lock_wait $string
249
250Wait until the given lock is available. See cf::lock_acquire.
251
252=item my $lock = cf::lock_acquire $string
253
254Wait until the given lock is available and then acquires it and returns
255a Coro::guard object. If the guard object gets destroyed (goes out of scope,
256for example when the coroutine gets canceled), the lock is automatically
257returned.
258
259Lock names should begin with a unique identifier (for example, cf::map::find
260uses map_find and cf::map::load uses map_load).
261
262=item $locked = cf::lock_active $string
263
264Return true if the lock is currently active, i.e. somebody has locked it.
265
266=cut
267
268our %LOCK;
269
270sub lock_wait($) {
271 my ($key) = @_;
272
273 # wait for lock, if any
274 while ($LOCK{$key}) {
275 push @{ $LOCK{$key} }, $Coro::current;
276 Coro::schedule;
277 }
278}
279
280sub lock_acquire($) {
281 my ($key) = @_;
282
283 # wait, to be sure we are not locked
284 lock_wait $key;
285
286 $LOCK{$key} = [];
287
288 Coro::guard {
289 # wake up all waiters, to be on the safe side
290 $_->ready for @{ delete $LOCK{$key} };
291 }
292}
293
294sub lock_active($) {
295 my ($key) = @_;
296
297 ! ! $LOCK{$key}
298}
299
300sub freeze_mainloop {
301 return unless $TICK_WATCHER->is_active;
302
303 my $guard = Coro::guard {
304 $TICK_WATCHER->start;
305 };
306 $TICK_WATCHER->stop;
307 $guard
308}
309
310=item cf::async { BLOCK }
311
312Currently the same as Coro::async_pool, meaning you cannot use
313C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
314thing you are allowed to do is call C<prio> on it.
315
316=cut
317
318BEGIN { *async = \&Coro::async_pool }
319
320=item cf::sync_job { BLOCK }
321
322The design of crossfire+ requires that the main coro ($Coro::main) is
323always able to handle events or runnable, as crossfire+ is only partly
324reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
325
326If it must be done, put the blocking parts into C<sync_job>. This will run
327the given BLOCK in another coroutine while waiting for the result. The
328server will be frozen during this time, so the block should either finish
329fast or be very important.
330
331=cut
332
333sub sync_job(&) {
334 my ($job) = @_;
335
336 if ($Coro::current == $Coro::main) {
337 my $time = Event::time;
338
339 # this is the main coro, too bad, we have to block
340 # till the operation succeeds, freezing the server :/
341
342 # TODO: use suspend/resume instead
343 # (but this is cancel-safe)
344 my $freeze_guard = freeze_mainloop;
345
346 my $busy = 1;
347 my @res;
348
349 (async {
350 @res = eval { $job->() };
351 warn $@ if $@;
352 undef $busy;
353 })->prio (Coro::PRIO_MAX);
354
355 while ($busy) {
356 Coro::cede or Event::one_event;
357 }
358
359 $time = Event::time - $time;
360
361 LOG llevError | logBacktrace, Carp::longmess "long sync job"
362 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
363
364 $tick_start += $time; # do not account sync jobs to server load
365
366 wantarray ? @res : $res[0]
367 } else {
368 # we are in another coroutine, how wonderful, everything just works
369
370 $job->()
371 }
372}
373
374=item $coro = cf::async_ext { BLOCK }
375
376Like async, but this coro is automatically being canceled when the
377extension calling this is being unloaded.
378
379=cut
380
381sub async_ext(&) {
382 my $cb = shift;
383
384 my $coro = &Coro::async ($cb);
385
386 $coro->on_destroy (sub {
387 delete $EXT_CORO{$coro+0};
388 });
389 $EXT_CORO{$coro+0} = $coro;
390
391 $coro
392}
393
394sub write_runtime {
395 my $runtime = "$LOCALDIR/runtime";
396
397 # first touch the runtime file to show we are still running:
398 # the fsync below can take a very very long time.
399
400 if (my $fh = aio_open $runtime, O_WRONLY, 0) {
401 utime undef, undef, $fh;
402 }
403
404 my $guard = cf::lock_acquire "write_runtime";
405
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
407 or return;
408
409 my $value = $cf::RUNTIME + 90 + 10;
410 # 10 is the runtime save interval, for a monotonic clock
411 # 60 allows for the watchdog to kill the server.
412
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0
414 and return;
415
416 # always fsync - this file is important
417 aio_fsync $fh
418 and return;
419
420 # touch it again to show we are up-to-date
421 utime undef, undef, $fh;
422
423 close $fh
424 or return;
425
426 aio_rename "$runtime~", $runtime
427 and return;
428
429 warn "runtime file written.\n";#d#
430
431 1
432}
433
434=item cf::datalog type => key => value, ...
435
436Log a datalog packet of the given type with the given key-value pairs.
437
438=cut
439
440sub datalog($@) {
441 my ($type, %kv) = @_;
442 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
443}
444
445=back
446
447=cut
55 448
56############################################################################# 449#############################################################################
57# utility functions
58 450
59use JSON::Syck (); # TODO# replace by JSON::PC once working 451=head2 ATTACHABLE OBJECTS
60 452
61sub from_json($) { 453Many objects in crossfire are so-called attachable objects. That means you can
62 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 454attach callbacks/event handlers (a collection of which is called an "attachment")
63 JSON::Syck::Load $_[0] 455to it. All such attachable objects support the following methods.
64}
65 456
66sub to_json($) { 457In the following description, CLASS can be any of C<global>, C<object>
67 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 458C<player>, C<client> or C<map> (i.e. the attachable objects in
68 JSON::Syck::Dump $_[0] 459crossfire+).
69}
70
71#############################################################################
72# "new" plug-in system
73
74=head3 EVENTS AND OBJECT ATTACHMENTS
75 460
76=over 4 461=over 4
77 462
78=item $object->attach ($attachment, key => $value...)
79
80=item $object->detach ($attachment)
81
82Attach/detach a pre-registered attachment to an object.
83
84=item $player->attach ($attachment, key => $value...)
85
86=item $player->detach ($attachment)
87
88Attach/detach a pre-registered attachment to a player.
89
90=item $map->attach ($attachment, key => $value...) 463=item $attachable->attach ($attachment, key => $value...)
91 464
92=item $map->detach ($attachment) 465=item $attachable->detach ($attachment)
93 466
94Attach/detach a pre-registered attachment to a map. 467Attach/detach a pre-registered attachment to a specific object and give it
468the specified key/value pairs as arguments.
95 469
96=item $bool = $object->attached ($name) 470Example, attach a minesweeper attachment to the given object, making it a
47110x10 minesweeper game:
97 472
98=item $bool = $player->attached ($name) 473 $obj->attach (minesweeper => width => 10, height => 10);
99 474
100=item $bool = $map->attached ($name) 475=item $bool = $attachable->attached ($name)
101 476
102Checks wether the named attachment is currently attached to the object. 477Checks wether the named attachment is currently attached to the object.
103 478
104=item cf::attach_global ... 479=item cf::CLASS->attach ...
105 480
106Attach handlers for global events. 481=item cf::CLASS->detach ...
107 482
108This and all following C<attach_*>-functions expect any number of the 483Define an anonymous attachment and attach it to all objects of the given
109following handler/hook descriptions: 484CLASS. See the next function for an explanation of its arguments.
485
486You can attach to global events by using the C<cf::global> class.
487
488Example, log all player logins:
489
490 cf::player->attach (
491 on_login => sub {
492 my ($pl) = @_;
493 ...
494 },
495 );
496
497Example, attach to the jeweler skill:
498
499 cf::object->attach (
500 type => cf::SKILL,
501 subtype => cf::SK_JEWELER,
502 on_use_skill => sub {
503 my ($sk, $ob, $part, $dir, $msg) = @_;
504 ...
505 },
506 );
507
508=item cf::CLASS::attachment $name, ...
509
510Register an attachment by C<$name> through which attachable objects of the
511given CLASS can refer to this attachment.
512
513Some classes such as crossfire maps and objects can specify attachments
514that are attached at load/instantiate time, thus the need for a name.
515
516These calls expect any number of the following handler/hook descriptions:
110 517
111=over 4 518=over 4
112 519
113=item prio => $number 520=item prio => $number
114 521
116by another C<prio> setting). Lower priority handlers get executed 523by another C<prio> setting). Lower priority handlers get executed
117earlier. The default priority is C<0>, and many built-in handlers are 524earlier. The default priority is C<0>, and many built-in handlers are
118registered at priority C<-1000>, so lower priorities should not be used 525registered at priority C<-1000>, so lower priorities should not be used
119unless you know what you are doing. 526unless you know what you are doing.
120 527
528=item type => $type
529
530(Only for C<< cf::object->attach >> calls), limits the attachment to the
531given type of objects only (the additional parameter C<subtype> can be
532used to further limit to the given subtype).
533
121=item on_I<event> => \&cb 534=item on_I<event> => \&cb
122 535
123Call the given code reference whenever the named event happens (event is 536Call the given code reference whenever the named event happens (event is
124something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 537something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
125handlers are recognised generally depends on the type of object these 538handlers are recognised generally depends on the type of object these
134package and register them. Only handlers for eevents supported by the 547package and register them. Only handlers for eevents supported by the
135object/class are recognised. 548object/class are recognised.
136 549
137=back 550=back
138 551
139=item cf::attach_to_type $object_type, $subtype, ... 552Example, define an attachment called "sockpuppet" that calls the given
553event handler when a monster attacks:
140 554
141Attach handlers for a specific object type (e.g. TRANSPORT) and 555 cf::object::attachment sockpuppet =>
142subtype. If C<$subtype> is zero or undef, matches all objects of the given 556 on_skill_attack => sub {
143type. 557 my ($self, $victim) = @_;
144 558 ...
145=item cf::attach_to_objects ...
146
147Attach handlers to all objects. Do not use this except for debugging or
148very rare events, as handlers are (obviously) called for I<all> objects in
149the game.
150
151=item cf::attach_to_players ...
152
153Attach handlers to all players.
154
155=item cf::attach_to_maps ...
156
157Attach handlers to all maps.
158
159=item cf:register_attachment $name, ...
160
161Register an attachment by name through which objects can refer to this
162attachment.
163
164=item cf:register_player_attachment $name, ...
165
166Register an attachment by name through which players can refer to this
167attachment.
168
169=item cf:register_map_attachment $name, ...
170
171Register an attachment by name through which maps can refer to this
172attachment.
173
174=cut
175
176# the following variables are defined in .xs and must not be re-created
177our @CB_GLOBAL = (); # registry for all global events
178our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179our @CB_PLAYER = ();
180our @CB_TYPE = (); # registry for type (cf-object class) based events
181our @CB_MAP = ();
182
183my %attachment;
184
185sub _attach_cb($\%$$$) {
186 my ($registry, $undo, $event, $prio, $cb) = @_;
187
188 use sort 'stable';
189
190 $cb = [$prio, $cb];
191
192 @{$registry->[$event]} = sort
193 { $a->[0] cmp $b->[0] }
194 @{$registry->[$event] || []}, $cb;
195
196 push @{$undo->{cb}}, [$event, $cb];
197}
198
199# attach handles attaching event callbacks
200# the only thing the caller has to do is pass the correct
201# registry (== where the callback attaches to).
202sub _attach(\@$@) {
203 my ($registry, $klass, @arg) = @_;
204
205 my $prio = 0;
206
207 my %undo = (
208 registry => $registry,
209 cb => [],
210 );
211
212 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
213
214 while (@arg) {
215 my $type = shift @arg;
216
217 if ($type eq "prio") {
218 $prio = shift @arg;
219
220 } elsif ($type eq "package") {
221 my $pkg = shift @arg;
222
223 while (my ($name, $id) = each %cb_id) {
224 if (my $cb = $pkg->can ($name)) {
225 _attach_cb $registry, %undo, $id, $prio, $cb;
226 }
227 } 559 }
228
229 } elsif (exists $cb_id{$type}) {
230 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
231
232 } elsif (ref $type) {
233 warn "attaching objects not supported, ignoring.\n";
234
235 } else {
236 shift @arg;
237 warn "attach argument '$type' not supported, ignoring.\n";
238 }
239 }
240
241 \%undo
242}
243
244sub _attach_attachment {
245 my ($obj, $name, %arg) = @_;
246
247 return if exists $obj->{_attachment}{$name};
248
249 my $res;
250
251 if (my $attach = $attachment{$name}) {
252 my $registry = $obj->registry;
253
254 for (@$attach) {
255 my ($klass, @attach) = @$_;
256 $res = _attach @$registry, $klass, @attach;
257 }
258
259 $obj->{$name} = \%arg;
260 } else {
261 warn "object uses attachment '$name' that is not available, postponing.\n";
262 }
263
264 $obj->{_attachment}{$name} = undef;
265
266 $res->{attachment} = $name;
267 $res
268}
269
270*cf::object::attach =
271*cf::player::attach =
272*cf::map::attach = sub {
273 my ($obj, $name, %arg) = @_;
274
275 _attach_attachment $obj, $name, %arg;
276};
277
278# all those should be optimised
279*cf::object::detach =
280*cf::player::detach =
281*cf::map::detach = sub {
282 my ($obj, $name) = @_;
283
284 delete $obj->{_attachment}{$name};
285 reattach ($obj);
286};
287
288*cf::object::attached =
289*cf::player::attached =
290*cf::map::attached = sub {
291 my ($obj, $name) = @_;
292
293 exists $obj->{_attachment}{$name}
294};
295
296sub attach_global {
297 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
298}
299
300sub attach_to_type {
301 my $type = shift;
302 my $subtype = shift;
303
304 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
305}
306
307sub attach_to_objects {
308 _attach @CB_OBJECT, KLASS_OBJECT, @_
309}
310
311sub attach_to_players {
312 _attach @CB_PLAYER, KLASS_PLAYER, @_
313}
314
315sub attach_to_maps {
316 _attach @CB_MAP, KLASS_MAP, @_
317}
318
319sub register_attachment {
320 my $name = shift;
321
322 $attachment{$name} = [[KLASS_OBJECT, @_]];
323}
324
325sub register_player_attachment {
326 my $name = shift;
327
328 $attachment{$name} = [[KLASS_PLAYER, @_]];
329}
330
331sub register_map_attachment {
332 my $name = shift;
333
334 $attachment{$name} = [[KLASS_MAP, @_]];
335}
336
337our $override;
338our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
339
340sub override {
341 $override = 1;
342 @invoke_results = ();
343}
344
345sub do_invoke {
346 my $event = shift;
347 my $callbacks = shift;
348
349 @invoke_results = ();
350
351 local $override;
352
353 for (@$callbacks) {
354 eval { &{$_->[1]} };
355
356 if ($@) {
357 warn "$@";
358 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
359 override;
360 }
361
362 return 1 if $override;
363 }
364
365 0 560 }
366}
367 561
368=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 562=item $attachable->valid
369
370=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371
372=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373
374=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375
376Generate a global/object/player/map-specific event with the given arguments.
377
378This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379removed in future versions), and there is no public API to access override
380results (if you must, access C<@cf::invoke_results> directly).
381
382=back
383
384=head2 methods valid for all pointers
385
386=over 4
387
388=item $object->valid
389
390=item $player->valid
391
392=item $map->valid
393 563
394Just because you have a perl object does not mean that the corresponding 564Just because you have a perl object does not mean that the corresponding
395C-level object still exists. If you try to access an object that has no 565C-level object still exists. If you try to access an object that has no
396valid C counterpart anymore you get an exception at runtime. This method 566valid C counterpart anymore you get an exception at runtime. This method
397can be used to test for existence of the C object part without causing an 567can be used to test for existence of the C object part without causing an
398exception. 568exception.
399 569
570=cut
571
572# the following variables are defined in .xs and must not be re-created
573our @CB_GLOBAL = (); # registry for all global events
574our @CB_ATTACHABLE = (); # registry for all attachables
575our @CB_OBJECT = (); # all objects (should not be used except in emergency)
576our @CB_PLAYER = ();
577our @CB_CLIENT = ();
578our @CB_TYPE = (); # registry for type (cf-object class) based events
579our @CB_MAP = ();
580
581my %attachment;
582
583sub cf::attachable::thawer_merge {
584 # simply override everything except _meta
585 local $_[0]{_meta};
586 %{$_[0]} = %{$_[1]};
587}
588
589sub _attach_cb($$$$) {
590 my ($registry, $event, $prio, $cb) = @_;
591
592 use sort 'stable';
593
594 $cb = [$prio, $cb];
595
596 @{$registry->[$event]} = sort
597 { $a->[0] cmp $b->[0] }
598 @{$registry->[$event] || []}, $cb;
599}
600
601# hack
602my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
603
604# attach handles attaching event callbacks
605# the only thing the caller has to do is pass the correct
606# registry (== where the callback attaches to).
607sub _attach {
608 my ($registry, $klass, @arg) = @_;
609
610 my $object_type;
611 my $prio = 0;
612 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
613
614 #TODO: get rid of this hack
615 if ($attachable_klass{$klass}) {
616 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
617 }
618
619 while (@arg) {
620 my $type = shift @arg;
621
622 if ($type eq "prio") {
623 $prio = shift @arg;
624
625 } elsif ($type eq "type") {
626 $object_type = shift @arg;
627 $registry = $CB_TYPE[$object_type] ||= [];
628
629 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633
634 } elsif ($type eq "package") {
635 my $pkg = shift @arg;
636
637 while (my ($name, $id) = each %cb_id) {
638 if (my $cb = $pkg->can ($name)) {
639 _attach_cb $registry, $id, $prio, $cb;
640 }
641 }
642
643 } elsif (exists $cb_id{$type}) {
644 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
645
646 } elsif (ref $type) {
647 warn "attaching objects not supported, ignoring.\n";
648
649 } else {
650 shift @arg;
651 warn "attach argument '$type' not supported, ignoring.\n";
652 }
653 }
654}
655
656sub _object_attach {
657 my ($obj, $name, %arg) = @_;
658
659 return if exists $obj->{_attachment}{$name};
660
661 if (my $attach = $attachment{$name}) {
662 my $registry = $obj->registry;
663
664 for (@$attach) {
665 my ($klass, @attach) = @$_;
666 _attach $registry, $klass, @attach;
667 }
668
669 $obj->{$name} = \%arg;
670 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n";
672 }
673
674 $obj->{_attachment}{$name} = undef;
675}
676
677sub cf::attachable::attach {
678 if (ref $_[0]) {
679 _object_attach @_;
680 } else {
681 _attach shift->_attach_registry, @_;
682 }
683 _recalc_want;
684};
685
686# all those should be optimised
687sub cf::attachable::detach {
688 my ($obj, $name) = @_;
689
690 if (ref $obj) {
691 delete $obj->{_attachment}{$name};
692 reattach ($obj);
693 } else {
694 Carp::croak "cannot, currently, detach class attachments";
695 }
696 _recalc_want;
697};
698
699sub cf::attachable::attached {
700 my ($obj, $name) = @_;
701
702 exists $obj->{_attachment}{$name}
703}
704
705for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
706 eval "#line " . __LINE__ . " 'cf.pm'
707 sub cf::\L$klass\E::_attach_registry {
708 (\\\@CB_$klass, KLASS_$klass)
709 }
710
711 sub cf::\L$klass\E::attachment {
712 my \$name = shift;
713
714 \$attachment{\$name} = [[KLASS_$klass, \@_]];
715 }
716 ";
717 die if $@;
718}
719
720our $override;
721our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722
723sub override {
724 $override = 1;
725 @invoke_results = ();
726}
727
728sub do_invoke {
729 my $event = shift;
730 my $callbacks = shift;
731
732 @invoke_results = ();
733
734 local $override;
735
736 for (@$callbacks) {
737 eval { &{$_->[1]} };
738
739 if ($@) {
740 warn "$@";
741 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
742 override;
743 }
744
745 return 1 if $override;
746 }
747
748 0
749}
750
751=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
752
753=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
754
755Generate an object-specific event with the given arguments.
756
757This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
758removed in future versions), and there is no public API to access override
759results (if you must, access C<@cf::invoke_results> directly).
760
400=back 761=back
401 762
402=cut 763=cut
403
404*cf::object::valid =
405*cf::player::valid =
406*cf::map::valid = \&cf::_valid;
407 764
408############################################################################# 765#############################################################################
409# object support 766# object support
410 767
411sub instantiate {
412 my ($obj, $data) = @_;
413
414 $data = from_json $data;
415
416 for (@$data) {
417 my ($name, $args) = @$_;
418
419 $obj->attach ($name, %{$args || {} });
420 }
421}
422
423# basically do the same as instantiate, without calling instantiate
424sub reattach { 768sub reattach {
769 # basically do the same as instantiate, without calling instantiate
425 my ($obj) = @_; 770 my ($obj) = @_;
771
772 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
773
426 my $registry = $obj->registry; 774 my $registry = $obj->registry;
427 775
428 @$registry = (); 776 @$registry = ();
429 777
430 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 778 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
431 779
432 for my $name (keys %{ $obj->{_attachment} || {} }) { 780 for my $name (keys %{ $obj->{_attachment} || {} }) {
433 if (my $attach = $attachment{$name}) { 781 if (my $attach = $attachment{$name}) {
434 for (@$attach) { 782 for (@$attach) {
435 my ($klass, @attach) = @$_; 783 my ($klass, @attach) = @$_;
436 _attach @$registry, $klass, @attach; 784 _attach $registry, $klass, @attach;
437 } 785 }
438 } else { 786 } else {
439 warn "object uses attachment '$name' that is not available, postponing.\n"; 787 warn "object uses attachment '$name' that is not available, postponing.\n";
440 } 788 }
441 } 789 }
442} 790}
443 791
444sub object_freezer_save { 792cf::attachable->attach (
445 my ($filename, $rdata, $objs) = @_;
446
447 if (length $$rdata) {
448 warn sprintf "saving %s (%d,%d)\n",
449 $filename, length $$rdata, scalar @$objs;
450
451 if (open my $fh, ">:raw", "$filename~") {
452 chmod SAVE_MODE, $fh;
453 syswrite $fh, $$rdata;
454 close $fh;
455
456 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
457 chmod SAVE_MODE, $fh;
458 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
459 close $fh;
460 rename "$filename.pst~", "$filename.pst";
461 } else {
462 unlink "$filename.pst";
463 }
464
465 rename "$filename~", $filename;
466 } else {
467 warn "FATAL: $filename~: $!\n";
468 }
469 } else {
470 unlink $filename;
471 unlink "$filename.pst";
472 }
473}
474
475sub object_thawer_load {
476 my ($filename) = @_;
477
478 local $/;
479
480 my $av;
481
482 #TODO: use sysread etc.
483 if (open my $data, "<:raw:perlio", $filename) {
484 $data = <$data>;
485 if (open my $pst, "<:raw:perlio", "$filename.pst") {
486 $av = eval { (Storable::thaw <$pst>)->{objs} };
487 }
488 return ($data, $av);
489 }
490
491 ()
492}
493
494attach_to_objects
495 prio => -1000000, 793 prio => -1000000,
794 on_instantiate => sub {
795 my ($obj, $data) = @_;
796
797 $data = from_json $data;
798
799 for (@$data) {
800 my ($name, $args) = @$_;
801
802 $obj->attach ($name, %{$args || {} });
803 }
804 },
805 on_reattach => \&reattach,
496 on_clone => sub { 806 on_clone => sub {
497 my ($src, $dst) = @_; 807 my ($src, $dst) = @_;
498 808
499 @{$dst->registry} = @{$src->registry}; 809 @{$dst->registry} = @{$src->registry};
500 810
501 %$dst = %$src; 811 %$dst = %$src;
502 812
503 %{$dst->{_attachment}} = %{$src->{_attachment}} 813 %{$dst->{_attachment}} = %{$src->{_attachment}}
504 if exists $src->{_attachment}; 814 if exists $src->{_attachment};
505 }, 815 },
506; 816);
817
818sub object_freezer_save {
819 my ($filename, $rdata, $objs) = @_;
820
821 sync_job {
822 if (length $$rdata) {
823 warn sprintf "saving %s (%d,%d)\n",
824 $filename, length $$rdata, scalar @$objs;
825
826 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
827 chmod SAVE_MODE, $fh;
828 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
829 aio_fsync $fh if $cf::USE_FSYNC;
830 close $fh;
831
832 if (@$objs) {
833 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
834 chmod SAVE_MODE, $fh;
835 my $data = Storable::nfreeze { version => 1, objs => $objs };
836 aio_write $fh, 0, (length $data), $data, 0;
837 aio_fsync $fh if $cf::USE_FSYNC;
838 close $fh;
839 aio_rename "$filename.pst~", "$filename.pst";
840 }
841 } else {
842 aio_unlink "$filename.pst";
843 }
844
845 aio_rename "$filename~", $filename;
846 } else {
847 warn "FATAL: $filename~: $!\n";
848 }
849 } else {
850 aio_unlink $filename;
851 aio_unlink "$filename.pst";
852 }
853 }
854}
855
856sub object_freezer_as_string {
857 my ($rdata, $objs) = @_;
858
859 use Data::Dumper;
860
861 $$rdata . Dumper $objs
862}
863
864sub object_thawer_load {
865 my ($filename) = @_;
866
867 my ($data, $av);
868
869 (aio_load $filename, $data) >= 0
870 or return;
871
872 unless (aio_stat "$filename.pst") {
873 (aio_load "$filename.pst", $av) >= 0
874 or return;
875 $av = eval { (Storable::thaw $av)->{objs} };
876 }
877
878 warn sprintf "loading %s (%d)\n",
879 $filename, length $data, scalar @{$av || []};#d#
880 return ($data, $av);
881}
507 882
508############################################################################# 883#############################################################################
509# old plug-in events 884# command handling &c
510 885
511sub inject_event { 886=item cf::register_command $name => \&callback($ob,$args);
512 my $extension = shift;
513 my $event_code = shift;
514 887
515 my $cb = $hook[$event_code]{$extension} 888Register a callback for execution when the client sends the user command
516 or return; 889$name.
517 890
518 &$cb 891=cut
519}
520
521sub inject_global_event {
522 my $event = shift;
523
524 my $cb = $hook[$event]
525 or return;
526
527 List::Util::max map &$_, values %$cb
528}
529
530sub inject_command {
531 my ($name, $obj, $params) = @_;
532
533 for my $cmd (@{ $command{$name} }) {
534 $cmd->[1]->($obj, $params);
535 }
536
537 -1
538}
539 892
540sub register_command { 893sub register_command {
541 my ($name, $time, $cb) = @_; 894 my ($name, $cb) = @_;
542 895
543 my $caller = caller; 896 my $caller = caller;
544 #warn "registering command '$name/$time' to '$caller'"; 897 #warn "registering command '$name/$time' to '$caller'";
545 898
546 push @{ $command{$name} }, [$time, $cb, $caller]; 899 push @{ $COMMAND{$name} }, [$caller, $cb];
547 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548} 900}
901
902=item cf::register_extcmd $name => \&callback($pl,$packet);
903
904Register a callbackf ro execution when the client sends an extcmd packet.
905
906If the callback returns something, it is sent back as if reply was being
907called.
908
909=cut
549 910
550sub register_extcmd { 911sub register_extcmd {
551 my ($name, $cb) = @_; 912 my ($name, $cb) = @_;
552 913
553 my $caller = caller; 914 $EXTCMD{$name} = $cb;
554 #warn "registering extcmd '$name' to '$caller'";
555
556 $extcmd{$name} = [$cb, $caller];
557} 915}
558 916
559sub register { 917cf::player->attach (
560 my ($base, $pkg) = @_; 918 on_command => sub {
919 my ($pl, $name, $params) = @_;
561 920
562 #TODO 921 my $cb = $COMMAND{$name}
563} 922 or return;
923
924 for my $cmd (@$cb) {
925 $cmd->[1]->($pl->ob, $params);
926 }
927
928 cf::override;
929 },
930 on_extcmd => sub {
931 my ($pl, $buf) = @_;
932
933 my $msg = eval { from_json $buf };
934
935 if (ref $msg) {
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
937 if (my %reply = $cb->($pl, $msg)) {
938 $pl->ext_reply ($msg->{msgid}, %reply);
939 }
940 }
941 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 }
944
945 cf::override;
946 },
947);
564 948
565sub load_extension { 949sub load_extension {
566 my ($path) = @_; 950 my ($path) = @_;
567 951
568 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 952 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
569 my $base = $1; 953 my $base = $1;
570 my $pkg = $1; 954 my $pkg = $1;
571 $pkg =~ s/[^[:word:]]/_/g; 955 $pkg =~ s/[^[:word:]]/_/g;
572 $pkg = "ext::$pkg"; 956 $pkg = "ext::$pkg";
573 957
574 warn "loading '$path' into '$pkg'\n"; 958 warn "... loading '$path' into '$pkg'\n";
575 959
576 open my $fh, "<:utf8", $path 960 open my $fh, "<:utf8", $path
577 or die "$path: $!"; 961 or die "$path: $!";
578 962
579 my $source = 963 my $source =
580 "package $pkg; use strict; use utf8;\n" 964 "package $pkg; use strict; use utf8;\n"
581 . "#line 1 \"$path\"\n{\n" 965 . "#line 1 \"$path\"\n{\n"
582 . (do { local $/; <$fh> }) 966 . (do { local $/; <$fh> })
583 . "\n};\n1"; 967 . "\n};\n1";
584 968
585 eval $source 969 unless (eval $source) {
586 or die "$path: $@"; 970 my $msg = $@ ? "$path: $@\n"
587 971 : "extension disabled.\n";
588 push @exts, $pkg; 972 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
589 $ext_pkg{$base} = $pkg; 973 warn $@;
590 974 warn "mandatory extension failed to load, exiting.\n";
591# no strict 'refs'; 975 exit 1;
592# @{"$pkg\::ISA"} = ext::; 976 }
593 977 die $@;
594 register $base, $pkg;
595}
596
597sub unload_extension {
598 my ($pkg) = @_;
599
600 warn "removing extension $pkg\n";
601
602 # remove hooks
603 #TODO
604# for my $idx (0 .. $#PLUGIN_EVENT) {
605# delete $hook[$idx]{$pkg};
606# } 978 }
607 979
608 # remove commands 980 push @EXTS, $pkg;
609 for my $name (keys %command) {
610 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
611
612 if (@cb) {
613 $command{$name} = \@cb;
614 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615 } else {
616 delete $command{$name};
617 delete $COMMAND{"$name\000"};
618 }
619 }
620
621 # remove extcmds
622 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
623 delete $extcmd{$name};
624 }
625
626 if (my $cb = $pkg->can ("unload")) {
627 eval {
628 $cb->($pkg);
629 1
630 } or warn "$pkg unloaded, but with errors: $@";
631 }
632
633 Symbol::delete_package $pkg;
634} 981}
635 982
636sub load_extensions { 983sub load_extensions {
637 my $LIBDIR = maps_directory "perl";
638
639 for my $ext (<$LIBDIR/*.ext>) { 984 for my $ext (<$LIBDIR/*.ext>) {
640 next unless -r $ext; 985 next unless -r $ext;
641 eval { 986 eval {
642 load_extension $ext; 987 load_extension $ext;
643 1 988 1
644 } or warn "$ext not loaded: $@"; 989 } or warn "$ext not loaded: $@";
645 } 990 }
646} 991}
647 992
648############################################################################# 993#############################################################################
649# extcmd framework, basically convert ext <msg>
650# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651 994
652attach_to_players 995=head2 CORE EXTENSIONS
653 on_extcmd => sub { 996
997Functions and methods that extend core crossfire objects.
998
999=cut
1000
1001package cf::player;
1002
1003use Coro::AIO;
1004
1005=head3 cf::player
1006
1007=over 4
1008
1009=item cf::player::find $login
1010
1011Returns the given player object, loading it if necessary (might block).
1012
1013=cut
1014
1015sub playerdir($) {
1016 "$PLAYERDIR/"
1017 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1018}
1019
1020sub path($) {
1021 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1022
1023 (playerdir $login) . "/playerdata"
1024}
1025
1026sub find_active($) {
1027 $cf::PLAYER{$_[0]}
1028 and $cf::PLAYER{$_[0]}->active
1029 and $cf::PLAYER{$_[0]}
1030}
1031
1032sub exists($) {
1033 my ($login) = @_;
1034
1035 $cf::PLAYER{$login}
1036 or cf::sync_job { !aio_stat path $login }
1037}
1038
1039sub find($) {
1040 return $cf::PLAYER{$_[0]} || do {
1041 my $login = $_[0];
1042
1043 my $guard = cf::lock_acquire "user_find:$login";
1044
1045 $cf::PLAYER{$_[0]} || do {
1046 # rename old playerfiles to new ones
1047 #TODO: remove when no longer required
1048 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1049 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1050 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1051 aio_unlink +(playerdir $login) . "/$login.pl";
1052
1053 my $pl = load_pl path $login
1054 or return;
1055 $cf::PLAYER{$login} = $pl
1056 }
1057 }
1058}
1059
1060sub save($) {
654 my ($pl, $buf) = @_; 1061 my ($pl) = @_;
655 1062
656 my $msg = eval { from_json $buf }; 1063 return if $pl->{deny_save};
657 1064
658 if (ref $msg) { 1065 my $path = path $pl;
659 if (my $cb = $extcmd{$msg->{msgtype}}) { 1066 my $guard = cf::lock_acquire "user_save:$path";
660 if (my %reply = $cb->[0]->($pl, $msg)) { 1067
661 $pl->ext_reply ($msg->{msgid}, %reply); 1068 return if $pl->{deny_save};
662 } 1069
1070 aio_mkdir playerdir $pl, 0770;
1071 $pl->{last_save} = $cf::RUNTIME;
1072
1073 $pl->save_pl ($path);
1074 Coro::cede;
1075}
1076
1077sub new($) {
1078 my ($login) = @_;
1079
1080 my $self = create;
1081
1082 $self->ob->name ($login);
1083 $self->{deny_save} = 1;
1084
1085 $cf::PLAYER{$login} = $self;
1086
1087 $self
1088}
1089
1090=item $pl->quit_character
1091
1092Nukes the player without looking back. If logged in, the connection will
1093be destroyed. May block for a long time.
1094
1095=cut
1096
1097sub quit_character {
1098 my ($pl) = @_;
1099
1100 my $name = $pl->ob->name;
1101
1102 $pl->{deny_save} = 1;
1103 $pl->password ("*"); # this should lock out the player until we nuked the dir
1104
1105 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1106 $pl->deactivate;
1107 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1108 $pl->ns->destroy if $pl->ns;
1109
1110 my $path = playerdir $pl;
1111 my $temp = "$path~$cf::RUNTIME~deleting~";
1112 aio_rename $path, $temp;
1113 delete $cf::PLAYER{$pl->ob->name};
1114 $pl->destroy;
1115
1116 my $prefix = qr<^~\Q$name\E/>;
1117
1118 # nuke player maps
1119 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1120
1121 IO::AIO::aio_rmtree $temp;
1122}
1123
1124=item $pl->kick
1125
1126Kicks a player out of the game. This destroys the connection.
1127
1128=cut
1129
1130sub kick {
1131 my ($pl, $kicker) = @_;
1132
1133 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1134 $pl->killer ("kicked");
1135 $pl->ns->destroy;
1136}
1137
1138=item cf::player::list_logins
1139
1140Returns am arrayref of all valid playernames in the system, can take a
1141while and may block, so not sync_job-capable, ever.
1142
1143=cut
1144
1145sub list_logins {
1146 my $dirs = aio_readdir $PLAYERDIR
1147 or return [];
1148
1149 my @logins;
1150
1151 for my $login (@$dirs) {
1152 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1153 aio_read $fh, 0, 512, my $buf, 0 or next;
1154 $buf !~ /^password -------------$/m or next; # official not-valid tag
1155
1156 utf8::decode $login;
1157 push @logins, $login;
1158 }
1159
1160 \@logins
1161}
1162
1163=item $player->maps
1164
1165Returns an arrayref of map paths that are private for this
1166player. May block.
1167
1168=cut
1169
1170sub maps($) {
1171 my ($pl) = @_;
1172
1173 $pl = ref $pl ? $pl->ob->name : $pl;
1174
1175 my $files = aio_readdir playerdir $pl
1176 or return;
1177
1178 my @paths;
1179
1180 for (@$files) {
1181 utf8::decode $_;
1182 next if /\.(?:pl|pst)$/;
1183 next unless /^$PATH_SEP/o;
1184
1185 push @paths, cf::map::normalise "~$pl/$_";
1186 }
1187
1188 \@paths
1189}
1190
1191=item $player->ext_reply ($msgid, %msg)
1192
1193Sends an ext reply to the player.
1194
1195=cut
1196
1197sub ext_reply($$%) {
1198 my ($self, $id, %msg) = @_;
1199
1200 $msg{msgid} = $id;
1201
1202 $self->send ("ext " . cf::to_json \%msg);
1203}
1204
1205=item $player->ext_event ($type, %msg)
1206
1207Sends an ext event to the client.
1208
1209=cut
1210
1211sub ext_event($$%) {
1212 my ($self, $type, %msg) = @_;
1213
1214 $self->ns->ext_event ($type, %msg);
1215}
1216
1217=head3 cf::region
1218
1219=over 4
1220
1221=cut
1222
1223package cf::region;
1224
1225=item cf::region::find_by_path $path
1226
1227Tries to decuce the probable region for a map knowing only its path.
1228
1229=cut
1230
1231sub find_by_path($) {
1232 my ($path) = @_;
1233
1234 my ($match, $specificity);
1235
1236 for my $region (list) {
1237 if ($region->match && $path =~ $region->match) {
1238 ($match, $specificity) = ($region, $region->specificity)
1239 if $region->specificity > $specificity;
1240 }
1241 }
1242
1243 $match
1244}
1245
1246=back
1247
1248=head3 cf::map
1249
1250=over 4
1251
1252=cut
1253
1254package cf::map;
1255
1256use Fcntl;
1257use Coro::AIO;
1258
1259use overload
1260 '""' => \&as_string,
1261 fallback => 1;
1262
1263our $MAX_RESET = 3600;
1264our $DEFAULT_RESET = 3000;
1265
1266sub generate_random_map {
1267 my ($self, $rmp) = @_;
1268 # mit "rum" bekleckern, nicht
1269 $self->_create_random_map (
1270 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1271 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1272 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1273 $rmp->{exit_on_final_map},
1274 $rmp->{xsize}, $rmp->{ysize},
1275 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1276 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1277 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1278 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1279 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1280 (cf::region::find $rmp->{region}), $rmp->{custom}
1281 )
1282}
1283
1284=item cf::map->register ($regex, $prio)
1285
1286Register a handler for the map path matching the given regex at the
1287givne priority (higher is better, built-in handlers have priority 0, the
1288default).
1289
1290=cut
1291
1292sub register {
1293 my (undef, $regex, $prio) = @_;
1294 my $pkg = caller;
1295
1296 no strict;
1297 push @{"$pkg\::ISA"}, __PACKAGE__;
1298
1299 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1300}
1301
1302# also paths starting with '/'
1303$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1304
1305sub thawer_merge {
1306 my ($self, $merge) = @_;
1307
1308 # we have to keep some variables in memory intact
1309 local $self->{path};
1310 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313
1314 $self->SUPER::thawer_merge ($merge);
1315}
1316
1317sub normalise {
1318 my ($path, $base) = @_;
1319
1320 $path = "$path"; # make sure its a string
1321
1322 $path =~ s/\.map$//;
1323
1324 # map plan:
1325 #
1326 # /! non-realised random map exit (special hack!)
1327 # {... are special paths that are not being touched
1328 # ?xxx/... are special absolute paths
1329 # ?random/... random maps
1330 # /... normal maps
1331 # ~user/... per-player map of a specific user
1332
1333 $path =~ s/$PATH_SEP/\//go;
1334
1335 # treat it as relative path if it starts with
1336 # something that looks reasonable
1337 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1338 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1339
1340 $base =~ s{[^/]+/?$}{};
1341 $path = "$base/$path";
1342 }
1343
1344 for ($path) {
1345 redo if s{//}{/};
1346 redo if s{/\.?/}{/};
1347 redo if s{/[^/]+/\.\./}{/};
1348 }
1349
1350 $path
1351}
1352
1353sub new_from_path {
1354 my (undef, $path, $base) = @_;
1355
1356 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1357
1358 $path = normalise $path, $base;
1359
1360 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1361 if ($path =~ $EXT_MAP{$pkg}[1]) {
1362 my $self = bless cf::map::new, $pkg;
1363 $self->{path} = $path; $self->path ($path);
1364 $self->init; # pass $1 etc.
1365 return $self;
1366 }
1367 }
1368
1369 Carp::carp "unable to resolve path '$path' (base '$base').";
1370 ()
1371}
1372
1373sub init {
1374 my ($self) = @_;
1375
1376 $self
1377}
1378
1379sub as_string {
1380 my ($self) = @_;
1381
1382 "$self->{path}"
1383}
1384
1385# the displayed name, this is a one way mapping
1386sub visible_name {
1387 &as_string
1388}
1389
1390# the original (read-only) location
1391sub load_path {
1392 my ($self) = @_;
1393
1394 "$MAPDIR/$self->{path}.map"
1395}
1396
1397# the temporary/swap location
1398sub save_path {
1399 my ($self) = @_;
1400
1401 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1402 "$TMPDIR/$path.map"
1403}
1404
1405# the unique path, undef == no special unique path
1406sub uniq_path {
1407 my ($self) = @_;
1408
1409 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1410 "$UNIQUEDIR/$path"
1411}
1412
1413# and all this just because we cannot iterate over
1414# all maps in C++...
1415sub change_all_map_light {
1416 my ($change) = @_;
1417
1418 $_->change_map_light ($change)
1419 for grep $_->outdoor, values %cf::MAP;
1420}
1421
1422sub unlink_save {
1423 my ($self) = @_;
1424
1425 utf8::encode (my $save = $self->save_path);
1426 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1427 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1428}
1429
1430sub load_header_from($) {
1431 my ($self, $path) = @_;
1432
1433 utf8::encode $path;
1434 #aio_open $path, O_RDONLY, 0
1435 # or return;
1436
1437 $self->_load_header ($path)
1438 or return;
1439
1440 $self->{load_path} = $path;
1441
1442 1
1443}
1444
1445sub load_header_orig {
1446 my ($self) = @_;
1447
1448 $self->load_header_from ($self->load_path)
1449}
1450
1451sub load_header_temp {
1452 my ($self) = @_;
1453
1454 $self->load_header_from ($self->save_path)
1455}
1456
1457sub prepare_temp {
1458 my ($self) = @_;
1459
1460 $self->last_access ((delete $self->{last_access})
1461 || $cf::RUNTIME); #d#
1462 # safety
1463 $self->{instantiate_time} = $cf::RUNTIME
1464 if $self->{instantiate_time} > $cf::RUNTIME;
1465}
1466
1467sub prepare_orig {
1468 my ($self) = @_;
1469
1470 $self->{load_original} = 1;
1471 $self->{instantiate_time} = $cf::RUNTIME;
1472 $self->last_access ($cf::RUNTIME);
1473 $self->instantiate;
1474}
1475
1476sub load_header {
1477 my ($self) = @_;
1478
1479 if ($self->load_header_temp) {
1480 $self->prepare_temp;
1481 } else {
1482 $self->load_header_orig
1483 or return;
1484 $self->prepare_orig;
1485 }
1486
1487 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region;
1489
1490 1
1491}
1492
1493sub find;
1494sub find {
1495 my ($path, $origin) = @_;
1496
1497 $path = normalise $path, $origin && $origin->path;
1498
1499 cf::lock_wait "map_find:$path";
1500
1501 $cf::MAP{$path} || do {
1502 my $guard = cf::lock_acquire "map_find:$path";
1503 my $map = new_from_path cf::map $path
1504 or return;
1505
1506 $map->{last_save} = $cf::RUNTIME;
1507
1508 $map->load_header
1509 or return;
1510
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait;
1514 $map->reset;
1515 undef $guard;
1516 return find $path;
1517 }
1518
1519 $cf::MAP{$path} = $map
1520 }
1521}
1522
1523sub pre_load { }
1524sub post_load { }
1525
1526sub load {
1527 my ($self) = @_;
1528
1529 local $self->{deny_reset} = 1; # loading can take a long time
1530
1531 my $path = $self->{path};
1532
1533 {
1534 my $guard = cf::lock_acquire "map_load:$path";
1535
1536 return if $self->in_memory != cf::MAP_SWAPPED;
1537
1538 $self->in_memory (cf::MAP_LOADING);
1539
1540 $self->alloc;
1541
1542 $self->pre_load;
1543 Coro::cede;
1544
1545 $self->_load_objects ($self->{load_path}, 1)
1546 or return;
1547
1548 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1549 if delete $self->{load_original};
1550
1551 if (my $uniq = $self->uniq_path) {
1552 utf8::encode $uniq;
1553 if (aio_open $uniq, O_RDONLY, 0) {
1554 $self->clear_unique_items;
1555 $self->_load_objects ($uniq, 0);
663 } 1556 }
664 } else {
665 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666 } 1557 }
667 1558
668 cf::override; 1559 Coro::cede;
1560 # now do the right thing for maps
1561 $self->link_multipart_objects;
1562 $self->difficulty ($self->estimate_difficulty)
1563 unless $self->difficulty;
1564 Coro::cede;
1565
1566 unless ($self->{deny_activate}) {
1567 $self->decay_objects;
1568 $self->fix_auto_apply;
1569 $self->update_buttons;
1570 Coro::cede;
1571 $self->set_darkness_map;
1572 Coro::cede;
1573 $self->activate;
1574 }
1575
1576 $self->in_memory (cf::MAP_IN_MEMORY);
669 }, 1577 }
670;
671 1578
672############################################################################# 1579 $self->post_load;
673# load/save/clean perl data associated with a map 1580}
674 1581
675*cf::mapsupport::on_clean = sub { 1582sub customise_for {
1583 my ($self, $ob) = @_;
1584
1585 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player;
1587
1588 $self
1589}
1590
1591# find and load all maps in the 3x3 area around a map
1592sub load_diag {
676 my ($map) = @_; 1593 my ($map) = @_;
677 1594
678 my $path = $map->tmpname; 1595 my @diag; # diagonal neighbours
679 defined $path or return;
680 1596
681 unlink "$path.pst"; 1597 for (0 .. 3) {
682}; 1598 my $neigh = $map->tile_path ($_)
1599 or next;
1600 $neigh = find $neigh, $map
1601 or next;
1602 $neigh->load;
683 1603
684attach_to_maps prio => -10000, package => cf::mapsupport::; 1604 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1605 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1606 }
685 1607
686############################################################################# 1608 for (@diag) {
687# load/save perl data associated with player->ob objects 1609 my $neigh = find @$_
688 1610 or next;
689sub all_objects(@) { 1611 $neigh->load;
690 @_, map all_objects ($_->inv), @_ 1612 }
691} 1613}
692 1614
693# TODO: compatibility cruft, remove when no longer needed 1615sub find_sync {
694attach_to_players 1616 my ($path, $origin) = @_;
695 on_load => sub {
696 my ($pl, $path) = @_;
697 1617
698 for my $o (all_objects $pl->ob) { 1618 cf::sync_job { find $path, $origin }
699 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1619}
700 $o->set_ob_key_value ("_perl_data");
701 1620
702 %$o = %{ Storable::thaw pack "H*", $value }; 1621sub do_load_sync {
1622 my ($map) = @_;
1623
1624 cf::sync_job { $map->load };
1625}
1626
1627our %MAP_PREFETCH;
1628our $MAP_PREFETCHER = undef;
1629
1630sub find_async {
1631 my ($path, $origin) = @_;
1632
1633 $path = normalise $path, $origin && $origin->{path};
1634
1635 if (my $map = $cf::MAP{$path}) {
1636 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1637 }
1638
1639 undef $MAP_PREFETCH{$path};
1640 $MAP_PREFETCHER ||= cf::async {
1641 while (%MAP_PREFETCH) {
1642 for my $path (keys %MAP_PREFETCH) {
1643 my $map = find $path
1644 or next;
1645 $map->load;
1646
1647 delete $MAP_PREFETCH{$path};
703 } 1648 }
704 } 1649 }
1650 undef $MAP_PREFETCHER;
1651 };
1652 $MAP_PREFETCHER->prio (6);
1653
1654 ()
1655}
1656
1657sub save {
1658 my ($self) = @_;
1659
1660 my $lock = cf::lock_acquire "map_data:" . $self->path;
1661
1662 $self->{last_save} = $cf::RUNTIME;
1663
1664 return unless $self->dirty;
1665
1666 my $save = $self->save_path; utf8::encode $save;
1667 my $uniq = $self->uniq_path; utf8::encode $uniq;
1668
1669 $self->{load_path} = $save;
1670
1671 return if $self->{deny_save};
1672
1673 local $self->{last_access} = $self->last_access;#d#
1674
1675 cf::async {
1676 $_->contr->save for $self->players;
1677 };
1678
1679 if ($uniq) {
1680 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1681 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1682 } else {
1683 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
705 }, 1684 }
706;
707
708#############################################################################
709# core extensions - in perl
710
711=item cf::player::exists $login
712
713Returns true when the given account exists.
714
715=cut
716
717sub cf::player::exists($) {
718 cf::player::find $_[0]
719 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
720} 1685}
721 1686
1687sub swap_out {
1688 my ($self) = @_;
1689
1690 # save first because save cedes
1691 $self->save;
1692
1693 my $lock = cf::lock_acquire "map_data:" . $self->path;
1694
1695 return if $self->players;
1696 return if $self->in_memory != cf::MAP_IN_MEMORY;
1697 return if $self->{deny_save};
1698
1699 $self->clear;
1700 $self->in_memory (cf::MAP_SWAPPED);
1701}
1702
1703sub reset_at {
1704 my ($self) = @_;
1705
1706 # TODO: safety, remove and allow resettable per-player maps
1707 return 1e99 if $self->isa ("ext::map_per_player");#d#
1708 return 1e99 if $self->{deny_reset};
1709
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712
1713 $time + $to
1714}
1715
1716sub should_reset {
1717 my ($self) = @_;
1718
1719 $self->reset_at <= $cf::RUNTIME
1720}
1721
1722sub reset {
1723 my ($self) = @_;
1724
1725 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726
1727 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729
1730 warn "resetting map ", $self->path;#d#
1731
1732 $self->in_memory (cf::MAP_SWAPPED);
1733
1734 # need to save uniques path
1735 unless ($self->{deny_save}) {
1736 my $uniq = $self->uniq_path; utf8::encode $uniq;
1737
1738 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1739 if $uniq;
1740 }
1741
1742 delete $cf::MAP{$self->path};
1743
1744 $self->clear;
1745
1746 $_->clear_links_to ($self) for values %cf::MAP;
1747
1748 $self->unlink_save;
1749 $self->destroy;
1750}
1751
1752my $nuke_counter = "aaaa";
1753
1754sub nuke {
1755 my ($self) = @_;
1756
1757 delete $cf::MAP{$self->path};
1758
1759 $self->unlink_save;
1760
1761 bless $self, "cf::map";
1762 delete $self->{deny_reset};
1763 $self->{deny_save} = 1;
1764 $self->reset_timeout (1);
1765 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1766
1767 $cf::MAP{$self->path} = $self;
1768
1769 $self->reset; # polite request, might not happen
1770}
1771
1772=item cf::map::unique_maps
1773
1774Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block.
1776
1777=cut
1778
1779sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR
1781 or return;
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_;
1787 next if /\.pst$/;
1788 next unless /^$PATH_SEP/o;
1789
1790 push @paths, cf::map::normalise $_;
1791 }
1792
1793 \@paths
1794}
1795
1796package cf;
1797
1798=back
1799
1800=head3 cf::object
1801
1802=cut
1803
1804package cf::object;
1805
1806=over 4
1807
1808=item $ob->inv_recursive
1809
1810Returns the inventory of the object _and_ their inventories, recursively.
1811
1812=cut
1813
1814sub inv_recursive_;
1815sub inv_recursive_ {
1816 map { $_, inv_recursive_ $_->inv } @_
1817}
1818
1819sub inv_recursive {
1820 inv_recursive_ inv $_[0]
1821}
1822
1823package cf;
1824
1825=back
1826
1827=head3 cf::object::player
1828
1829=over 4
1830
722=item $player->reply ($npc, $msg[, $flags]) 1831=item $player_object->reply ($npc, $msg[, $flags])
723 1832
724Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1833Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
725can be C<undef>. Does the right thing when the player is currently in a 1834can be C<undef>. Does the right thing when the player is currently in a
726dialogue with the given NPC character. 1835dialogue with the given NPC character.
727 1836
728=cut 1837=cut
729 1838
730# rough implementation of a future "reply" method that works 1839# rough implementation of a future "reply" method that works
731# with dialog boxes. 1840# with dialog boxes.
1841#TODO: the first argument must go, split into a $npc->reply_to ( method
732sub cf::object::player::reply($$$;$) { 1842sub cf::object::player::reply($$$;$) {
733 my ($self, $npc, $msg, $flags) = @_; 1843 my ($self, $npc, $msg, $flags) = @_;
734 1844
735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
736 1846
740 $msg = $npc->name . " says: $msg" if $npc; 1850 $msg = $npc->name . " says: $msg" if $npc;
741 $self->message ($msg, $flags); 1851 $self->message ($msg, $flags);
742 } 1852 }
743} 1853}
744 1854
745=item $player->ext_reply ($msgid, $msgtype, %msg) 1855=item $player_object->may ("access")
746 1856
747Sends an ext reply to the player. 1857Returns wether the given player is authorized to access resource "access"
1858(e.g. "command_wizcast").
748 1859
749=cut 1860=cut
750 1861
751sub cf::player::ext_reply($$$%) { 1862sub cf::object::player::may {
1863 my ($self, $access) = @_;
1864
1865 $self->flag (cf::FLAG_WIZ) ||
1866 (ref $cf::CFG{"may_$access"}
1867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1868 : $cf::CFG{"may_$access"})
1869}
1870
1871=item $player_object->enter_link
1872
1873Freezes the player and moves him/her to a special map (C<{link}>).
1874
1875The player should be reasonably safe there for short amounts of time. You
1876I<MUST> call C<leave_link> as soon as possible, though.
1877
1878Will never block.
1879
1880=item $player_object->leave_link ($map, $x, $y)
1881
1882Moves the player out of the special C<{link}> map onto the specified
1883map. If the map is not valid (or omitted), the player will be moved back
1884to the location he/she was before the call to C<enter_link>, or, if that
1885fails, to the emergency map position.
1886
1887Might block.
1888
1889=cut
1890
1891sub link_map {
1892 unless ($LINK_MAP) {
1893 $LINK_MAP = cf::map::find "{link}"
1894 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1895 $LINK_MAP->load;
1896 }
1897
1898 $LINK_MAP
1899}
1900
1901sub cf::object::player::enter_link {
1902 my ($self) = @_;
1903
1904 $self->deactivate_recursive;
1905
1906 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map;
1910
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1912}
1913
1914sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_;
1916
1917 my $link_pos = delete $self->{_link_pos};
1918
1919 unless ($map) {
1920 # restore original map position
1921 ($map, $x, $y) = @{ $link_pos || [] };
1922 $map = cf::map::find $map;
1923
1924 unless ($map) {
1925 ($map, $x, $y) = @$EMERGENCY_POSITION;
1926 $map = cf::map::find $map
1927 or die "FATAL: cannot load emergency map\n";
1928 }
1929 }
1930
1931 ($x, $y) = (-1, -1)
1932 unless (defined $x) && (defined $y);
1933
1934 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0;
1937
1938 $map->load;
1939 $map->load_diag;
1940
1941 return unless $self->contr->active;
1942 $self->activate_recursive;
1943
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y);
1946}
1947
1948cf::player->attach (
1949 on_logout => sub {
1950 my ($pl) = @_;
1951
1952 # abort map switching before logout
1953 if ($pl->ob->{_link_pos}) {
1954 cf::sync_job {
1955 $pl->ob->leave_link
1956 };
1957 }
1958 },
1959 on_login => sub {
1960 my ($pl) = @_;
1961
1962 # try to abort aborted map switching on player login :)
1963 # should happen only on crashes
1964 if ($pl->ob->{_link_pos}) {
1965 $pl->ob->enter_link;
1966 (async {
1967 $pl->ob->reply (undef,
1968 "There was an internal problem at your last logout, "
1969 . "the server will try to bring you to your intended destination in a second.",
1970 cf::NDI_RED);
1971 # we need this sleep as the login has a concurrent enter_exit running
1972 # and this sleep increases chances of the player not ending up in scorn
1973 Coro::Timer::sleep 1;
1974 $pl->ob->leave_link;
1975 })->prio (2);
1976 }
1977 },
1978);
1979
1980=item $player_object->goto ($path, $x, $y[, $check->($map)])
1981
1982Moves the player to the given map-path and coordinates by first freezing
1983her, loading and preparing them map, calling the provided $check callback
1984that has to return the map if sucecssful, and then unfreezes the player on
1985the new (success) or old (failed) map position.
1986
1987=cut
1988
1989sub cf::object::player::goto {
1990 my ($self, $path, $x, $y, $check) = @_;
1991
1992 $self->enter_link;
1993
1994 (async {
1995 my $map = eval {
1996 my $map = cf::map::find $path;
1997
1998 if ($map) {
1999 $map = $map->customise_for ($self);
2000 $map = $check->($map) if $check && $map;
2001 } else {
2002 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2003 }
2004
2005 $map
2006 };
2007
2008 if ($@) {
2009 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010 LOG llevError | logBacktrace, Carp::longmess $@;
2011 }
2012
2013 $self->leave_link ($map, $x, $y);
2014 })->prio (1);
2015}
2016
2017=item $player_object->enter_exit ($exit_object)
2018
2019=cut
2020
2021sub parse_random_map_params {
2022 my ($spec) = @_;
2023
2024 my $rmp = { # defaults
2025 xsize => (cf::rndm 15, 40),
2026 ysize => (cf::rndm 15, 40),
2027 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2028 #layout => string,
2029 };
2030
2031 for (split /\n/, $spec) {
2032 my ($k, $v) = split /\s+/, $_, 2;
2033
2034 $rmp->{lc $k} = $v if (length $k) && (length $v);
2035 }
2036
2037 $rmp
2038}
2039
2040sub prepare_random_map {
2041 my ($exit) = @_;
2042
2043 my $guard = cf::lock_acquire "exit_prepare:$exit";
2044
2045 # all this does is basically replace the /! path by
2046 # a new random map path (?random/...) with a seed
2047 # that depends on the exit object
2048
2049 my $rmp = parse_random_map_params $exit->msg;
2050
2051 if ($exit->map) {
2052 $rmp->{region} = $exit->region->name;
2053 $rmp->{origin_map} = $exit->map->path;
2054 $rmp->{origin_x} = $exit->x;
2055 $rmp->{origin_y} = $exit->y;
2056 }
2057
2058 $rmp->{random_seed} ||= $exit->random_seed;
2059
2060 my $data = cf::to_json $rmp;
2061 my $md5 = Digest::MD5::md5_hex $data;
2062 my $meta = "$RANDOMDIR/$md5.meta";
2063
2064 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2065 aio_write $fh, 0, (length $data), $data, 0;
2066 undef $fh;
2067 aio_rename "$meta~", $meta;
2068
2069 $exit->slaying ("?random/$md5");
2070 $exit->msg (undef);
2071 }
2072}
2073
2074sub cf::object::player::enter_exit {
2075 my ($self, $exit) = @_;
2076
2077 return unless $self->type == cf::PLAYER;
2078
2079 if ($exit->slaying eq "/!") {
2080 #TODO: this should de-fi-ni-te-ly not be a sync-job
2081 # the problem is that $exit might not survive long enough
2082 # so it needs to be done right now, right here
2083 cf::sync_job { prepare_random_map $exit };
2084 }
2085
2086 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2087 my $hp = $exit->stats->hp;
2088 my $sp = $exit->stats->sp;
2089
2090 $self->enter_link;
2091
2092 (async {
2093 $self->deactivate_recursive; # just to be sure
2094 unless (eval {
2095 $self->goto ($slaying, $hp, $sp);
2096
2097 1;
2098 }) {
2099 $self->message ("Something went wrong deep within the crossfire server. "
2100 . "I'll try to bring you back to the map you were before. "
2101 . "Please report this to the dungeon master!",
2102 cf::NDI_UNIQUE | cf::NDI_RED);
2103
2104 warn "ERROR in enter_exit: $@";
2105 $self->leave_link;
2106 }
2107 })->prio (1);
2108}
2109
2110=head3 cf::client
2111
2112=over 4
2113
2114=item $client->send_drawinfo ($text, $flags)
2115
2116Sends a drawinfo packet to the client. Circumvents output buffering so
2117should not be used under normal circumstances.
2118
2119=cut
2120
2121sub cf::client::send_drawinfo {
2122 my ($self, $text, $flags) = @_;
2123
2124 utf8::encode $text;
2125 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2126}
2127
2128=item $client->ext_event ($type, %msg)
2129
2130Sends an exti event to the client.
2131
2132=cut
2133
2134sub cf::client::ext_event($$%) {
752 my ($self, $id, %msg) = @_; 2135 my ($self, $type, %msg) = @_;
753 2136
754 $msg{msgid} = $id; 2137 $msg{msgtype} = "event_$type";
755
756 $self->send ("ext " . to_json \%msg); 2138 $self->send_packet ("ext " . cf::to_json \%msg);
757} 2139}
758 2140
759############################################################################# 2141=item $success = $client->query ($flags, "text", \&cb)
760# map scripting support 2142
2143Queues a query to the client, calling the given callback with
2144the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2145C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2146
2147Queries can fail, so check the return code. Or don't, as queries will become
2148reliable at some point in the future.
2149
2150=cut
2151
2152sub cf::client::query {
2153 my ($self, $flags, $text, $cb) = @_;
2154
2155 return unless $self->state == ST_PLAYING
2156 || $self->state == ST_SETUP
2157 || $self->state == ST_CUSTOM;
2158
2159 $self->state (ST_CUSTOM);
2160
2161 utf8::encode $text;
2162 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163
2164 $self->send_packet ($self->{query_queue}[0][0])
2165 if @{ $self->{query_queue} } == 1;
2166}
2167
2168cf::client->attach (
2169 on_reply => sub {
2170 my ($ns, $msg) = @_;
2171
2172 # this weird shuffling is so that direct followup queries
2173 # get handled first
2174 my $queue = delete $ns->{query_queue}
2175 or return; # be conservative, not sure how that can happen, but we saw a crash here
2176
2177 (shift @$queue)->[1]->($msg);
2178 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2179
2180 push @{ $ns->{query_queue} }, @$queue;
2181
2182 if (@{ $ns->{query_queue} } == @$queue) {
2183 if (@$queue) {
2184 $ns->send_packet ($ns->{query_queue}[0][0]);
2185 } else {
2186 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187 }
2188 }
2189 },
2190);
2191
2192=item $client->async (\&cb)
2193
2194Create a new coroutine, running the specified callback. The coroutine will
2195be automatically cancelled when the client gets destroyed (e.g. on logout,
2196or loss of connection).
2197
2198=cut
2199
2200sub cf::client::async {
2201 my ($self, $cb) = @_;
2202
2203 my $coro = &Coro::async ($cb);
2204
2205 $coro->on_destroy (sub {
2206 delete $self->{_coro}{$coro+0};
2207 });
2208
2209 $self->{_coro}{$coro+0} = $coro;
2210
2211 $coro
2212}
2213
2214cf::client->attach (
2215 on_destroy => sub {
2216 my ($ns) = @_;
2217
2218 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2219 },
2220);
2221
2222=back
2223
2224
2225=head2 SAFE SCRIPTING
2226
2227Functions that provide a safe environment to compile and execute
2228snippets of perl code without them endangering the safety of the server
2229itself. Looping constructs, I/O operators and other built-in functionality
2230is not available in the safe scripting environment, and the number of
2231functions and methods that can be called is greatly reduced.
2232
2233=cut
761 2234
762our $safe = new Safe "safe"; 2235our $safe = new Safe "safe";
763our $safe_hole = new Safe::Hole; 2236our $safe_hole = new Safe::Hole;
764 2237
765$SIG{FPE} = 'IGNORE'; 2238$SIG{FPE} = 'IGNORE';
766 2239
767$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2240$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
768 2241
769# here we export the classes and methods available to script code 2242# here we export the classes and methods available to script code
770 2243
2244=pod
2245
2246The following functions and methods are available within a safe environment:
2247
2248 cf::object contr pay_amount pay_player map
2249 cf::object::player player
2250 cf::player peaceful
2251 cf::map trigger
2252
2253=cut
2254
771for ( 2255for (
772 ["cf::object" => qw(contr pay_amount pay_player)], 2256 ["cf::object" => qw(contr pay_amount pay_player map)],
773 ["cf::object::player" => qw(player)], 2257 ["cf::object::player" => qw(player)],
774 ["cf::player" => qw(peaceful)], 2258 ["cf::player" => qw(peaceful)],
2259 ["cf::map" => qw(trigger)],
775) { 2260) {
776 no strict 'refs'; 2261 no strict 'refs';
777 my ($pkg, @funs) = @$_; 2262 my ($pkg, @funs) = @$_;
778 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2263 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779 for @funs; 2264 for @funs;
780} 2265}
2266
2267=over 4
2268
2269=item @retval = safe_eval $code, [var => value, ...]
2270
2271Compiled and executes the given perl code snippet. additional var/value
2272pairs result in temporary local (my) scalar variables of the given name
2273that are available in the code snippet. Example:
2274
2275 my $five = safe_eval '$first + $second', first => 1, second => 4;
2276
2277=cut
781 2278
782sub safe_eval($;@) { 2279sub safe_eval($;@) {
783 my ($code, %vars) = @_; 2280 my ($code, %vars) = @_;
784 2281
785 my $qcode = $code; 2282 my $qcode = $code;
808 } 2305 }
809 2306
810 wantarray ? @res : $res[0] 2307 wantarray ? @res : $res[0]
811} 2308}
812 2309
2310=item cf::register_script_function $function => $cb
2311
2312Register a function that can be called from within map/npc scripts. The
2313function should be reasonably secure and should be put into a package name
2314like the extension.
2315
2316Example: register a function that gets called whenever a map script calls
2317C<rent::overview>, as used by the C<rent> extension.
2318
2319 cf::register_script_function "rent::overview" => sub {
2320 ...
2321 };
2322
2323=cut
2324
813sub register_script_function { 2325sub register_script_function {
814 my ($fun, $cb) = @_; 2326 my ($fun, $cb) = @_;
815 2327
816 no strict 'refs'; 2328 no strict 'refs';
817 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2329 *{"safe::$fun"} = $safe_hole->wrap ($cb);
818} 2330}
819 2331
2332=back
2333
2334=cut
2335
820############################################################################# 2336#############################################################################
821 2337
822=head2 EXTENSION DATABASE SUPPORT 2338=head2 EXTENSION DATABASE SUPPORT
823 2339
824Crossfire maintains a very simple database for extension use. It can 2340Crossfire maintains a very simple database for extension use. It can
825currently store anything that can be serialised using Storable, which 2341currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
826excludes objects. 2342convert to/from binary).
827 2343
828The parameter C<$family> should best start with the name of the extension 2344The parameter C<$family> should best start with the name of the extension
829using it, it should be unique. 2345using it, it should be unique.
830 2346
831=over 4 2347=over 4
832 2348
833=item $hashref = cf::db_get $family
834
835Return a hashref for use by the extension C<$family>, which can be
836modified. After modifications, you have to call C<cf::db_dirty> or
837C<cf::db_sync>.
838
839=item $value = cf::db_get $family => $key 2349=item $value = cf::db_get $family => $key
840 2350
841Returns a single value from the database 2351Returns a single value from the database.
842
843=item cf::db_put $family => $hashref
844
845Stores the given family hashref into the database. Updates are delayed, if
846you want the data to be synced to disk immediately, use C<cf::db_sync>.
847 2352
848=item cf::db_put $family => $key => $value 2353=item cf::db_put $family => $key => $value
849 2354
850Stores the given C<$value> in the family hash. Updates are delayed, if you 2355Stores the given C<$value> in the family.
851want the data to be synced to disk immediately, use C<cf::db_sync>.
852 2356
853=item cf::db_dirty
854
855Marks the database as dirty, to be updated at a later time.
856
857=item cf::db_sync
858
859Immediately write the database to disk I<if it is dirty>.
860
861=cut 2357=cut
862 2358
863{ 2359our $DB;
864 my $db;
865 my $path = cf::datadir . "/database.pst";
866 2360
867 sub db_load() { 2361sub db_init {
868 warn "loading database $path\n";#d# remove later 2362 unless ($DB) {
869 $db = stat $path ? Storable::retrieve $path : { }; 2363 $DB = BDB::db_create $DB_ENV;
870 }
871 2364
872 my $pid; 2365 cf::sync_job {
2366 eval {
2367 $DB->set_flags (BDB::CHKSUM);
873 2368
874 sub db_save() { 2369 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
875 warn "saving database $path\n";#d# remove later 2370 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
876 waitpid $pid, 0 if $pid; 2371 cf::cleanup "db_open(db): $!" if $!;
877 unless ($pid = fork) { 2372 };
878 $db->{_meta}{version} = 1; 2373 cf::cleanup "db_open(db): $@" if $@;
879 Storable::nstore $db, "$path~";
880 rename "$path~", $path;
881 cf::_exit 0 if defined $pid;
882 } 2374 };
883 }
884
885 my $dirty;
886
887 sub db_sync() {
888 db_save if $dirty;
889 undef $dirty;
890 }
891
892 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
893 db_sync;
894 }); 2375 }
2376}
895 2377
896 sub db_dirty() {
897 $dirty = 1;
898 $idle->start;
899 }
900
901 sub db_get($;$) { 2378sub db_get($$) {
902 @_ >= 2 2379 my $key = "$_[0]/$_[1]";
903 ? $db->{$_[0]}{$_[1]}
904 : ($db->{$_[0]} ||= { })
905 }
906 2380
2381 cf::sync_job {
2382 BDB::db_get $DB, undef, $key, my $data;
2383
2384 $! ? ()
2385 : $data
2386 }
2387}
2388
907 sub db_put($$;$) { 2389sub db_put($$$) {
2390 BDB::dbreq_pri 4;
2391 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2392}
2393
2394=item cf::cache $id => [$paths...], $processversion => $process
2395
2396Generic caching function that returns the value of the resource $id,
2397caching and regenerating as required.
2398
2399This function can block.
2400
2401=cut
2402
2403sub cache {
2404 my ($id, $src, $processversion, $process) = @_;
2405
2406 my $meta =
2407 join "\x00",
2408 $processversion,
2409 map {
2410 aio_stat $_
2411 and Carp::croak "$_: $!";
2412
2413 ($_, (stat _)[7,9])
2414 } @$src;
2415
2416 my $dbmeta = db_get cache => "$id/meta";
2417 if ($dbmeta ne $meta) {
2418 # changed, we may need to process
2419
2420 my @data;
2421 my $md5;
2422
2423 for (0 .. $#$src) {
2424 0 <= aio_load $src->[$_], $data[$_]
2425 or Carp::croak "$src->[$_]: $!";
2426 }
2427
2428 # if processing is expensive, check
2429 # checksum first
908 if (@_ >= 3) { 2430 if (1) {
909 $db->{$_[0]}{$_[1]} = $_[2]; 2431 $md5 =
2432 join "\x00",
2433 $processversion,
2434 map {
2435 Coro::cede;
2436 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2437 } 0.. $#$src;
2438
2439
2440 my $dbmd5 = db_get cache => "$id/md5";
2441 if ($dbmd5 eq $md5) {
2442 db_put cache => "$id/meta", $meta;
2443
2444 return db_get cache => "$id/data";
2445 }
2446 }
2447
2448 my $t1 = Time::HiRes::time;
2449 my $data = $process->(\@data);
2450 my $t2 = Time::HiRes::time;
2451
2452 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2453
2454 db_put cache => "$id/data", $data;
2455 db_put cache => "$id/md5" , $md5;
2456 db_put cache => "$id/meta", $meta;
2457
2458 return $data;
2459 }
2460
2461 db_get cache => "$id/data"
2462}
2463
2464=item fork_call { }, $args
2465
2466Executes the given code block with the given arguments in a seperate
2467process, returning the results. Everything must be serialisable with
2468Coro::Storable. May, of course, block. Note that the executed sub may
2469never block itself or use any form of Event handling.
2470
2471=cut
2472
2473sub fork_call(&@) {
2474 my ($cb, @args) = @_;
2475
2476# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2477# or die "socketpair: $!";
2478 pipe my $fh1, my $fh2
2479 or die "pipe: $!";
2480
2481 if (my $pid = fork) {
2482 close $fh2;
2483
2484 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2485 $res = Coro::Storable::thaw $res;
2486
2487 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2488
2489 die $$res unless "ARRAY" eq ref $res;
2490
2491 return wantarray ? @$res : $res->[-1];
910 } else { 2492 } else {
911 $db->{$_[0]} = $_[1]; 2493 reset_signals;
2494 local $SIG{__WARN__};
2495 local $SIG{__DIE__};
2496 eval {
2497 close $fh1;
2498
2499 my @res = eval { $cb->(@args) };
2500 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
912 } 2501 };
913 db_dirty; 2502
2503 warn $@ if $@;
2504 _exit 0;
914 } 2505 }
915} 2506}
2507
2508
916 2509
917############################################################################# 2510#############################################################################
918# the server's main() 2511# the server's init and main functions
2512
2513sub load_facedata($) {
2514 my ($path) = @_;
2515
2516 warn "loading facedata from $path\n";
2517
2518 my $facedata;
2519 0 < aio_load $path, $facedata
2520 or die "$path: $!";
2521
2522 $facedata = Coro::Storable::thaw $facedata;
2523
2524 $facedata->{version} == 2
2525 or cf::cleanup "$path: version mismatch, cannot proceed.";
2526
2527 {
2528 my $faces = $facedata->{faceinfo};
2529
2530 while (my ($face, $info) = each %$faces) {
2531 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2532 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2533 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2534 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2535 Coro::cede;
2536 }
2537
2538 while (my ($face, $info) = each %$faces) {
2539 next unless $info->{smooth};
2540 my $idx = cf::face::find $face
2541 or next;
2542 if (my $smooth = cf::face::find $info->{smooth}) {
2543 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2544 } else {
2545 warn "smooth face '$info->{smooth}' not found for face '$face'";
2546 }
2547 Coro::cede;
2548 }
2549 }
2550
2551 {
2552 my $anims = $facedata->{animinfo};
2553
2554 while (my ($anim, $info) = each %$anims) {
2555 cf::anim::set $anim, $info->{frames}, $info->{facings};
2556 Coro::cede;
2557 }
2558
2559 cf::anim::invalidate_all; # d'oh
2560 }
2561
2562 1
2563}
2564
2565sub reload_regions {
2566 load_resource_file "$MAPDIR/regions"
2567 or die "unable to load regions file\n";
2568}
2569
2570sub reload_facedata {
2571 load_facedata "$DATADIR/facedata"
2572 or die "unable to load facedata\n";
2573}
2574
2575sub reload_archetypes {
2576 load_resource_file "$DATADIR/archetypes"
2577 or die "unable to load archetypes\n";
2578}
2579
2580sub reload_treasures {
2581 load_resource_file "$DATADIR/treasures"
2582 or die "unable to load treasurelists\n";
2583}
2584
2585sub reload_resources {
2586 warn "reloading resource files...\n";
2587
2588 reload_regions;
2589 reload_facedata;
2590 reload_archetypes;
2591 reload_treasures;
2592
2593 warn "finished reloading resource files\n";
2594}
2595
2596sub init {
2597 reload_resources;
2598}
2599
2600sub cfg_load {
2601 open my $fh, "<:utf8", "$CONFDIR/config"
2602 or return;
2603
2604 local $/;
2605 *CFG = YAML::Syck::Load <$fh>;
2606
2607 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2608
2609 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2610 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2611
2612 if (exists $CFG{mlockall}) {
2613 eval {
2614 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2615 and die "WARNING: m(un)lockall failed: $!\n";
2616 };
2617 warn $@ if $@;
2618 }
2619}
919 2620
920sub main { 2621sub main {
2622 # we must not ever block the main coroutine
2623 local $Coro::idle = sub {
2624 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2625 (async {
2626 Event::one_event;
2627 })->prio (Coro::PRIO_MAX);
2628 };
2629
921 db_load; 2630 cfg_load;
2631 db_init;
922 load_extensions; 2632 load_extensions;
2633
2634 $TICK_WATCHER->start;
923 Event::loop; 2635 Event::loop;
924} 2636}
925 2637
926############################################################################# 2638#############################################################################
927# initialisation 2639# initialisation and cleanup
928 2640
929sub _perl_reload(&) { 2641# install some emergency cleanup handlers
2642BEGIN {
2643 for my $signal (qw(INT HUP TERM)) {
2644 Event->signal (
2645 reentrant => 0,
2646 data => WF_AUTOCANCEL,
2647 signal => $signal,
2648 prio => 0,
2649 cb => sub {
2650 cf::cleanup "SIG$signal";
2651 },
2652 );
2653 }
2654}
2655
2656sub emergency_save() {
2657 my $freeze_guard = cf::freeze_mainloop;
2658
2659 warn "enter emergency perl save\n";
2660
2661 cf::sync_job {
2662 # use a peculiar iteration method to avoid tripping on perl
2663 # refcount bugs in for. also avoids problems with players
2664 # and maps saved/destroyed asynchronously.
2665 warn "begin emergency player save\n";
2666 for my $login (keys %cf::PLAYER) {
2667 my $pl = $cf::PLAYER{$login} or next;
2668 $pl->valid or next;
2669 $pl->save;
2670 }
2671 warn "end emergency player save\n";
2672
2673 warn "begin emergency map save\n";
2674 for my $path (keys %cf::MAP) {
2675 my $map = $cf::MAP{$path} or next;
2676 $map->valid or next;
2677 $map->save;
2678 }
2679 warn "end emergency map save\n";
2680
2681 warn "begin emergency database checkpoint\n";
2682 BDB::db_env_txn_checkpoint $DB_ENV;
2683 warn "end emergency database checkpoint\n";
2684 };
2685
2686 warn "leave emergency perl save\n";
2687}
2688
2689sub post_cleanup {
930 my ($msg) = @_; 2690 my ($make_core) = @_;
931 2691
932 $msg->("reloading..."); 2692 warn Carp::longmess "post_cleanup backtrace"
2693 if $make_core;
2694}
933 2695
934 eval { 2696sub do_reload_perl() {
935 # cancel all watchers 2697 # can/must only be called in main
2698 if ($Coro::current != $Coro::main) {
2699 warn "can only reload from main coroutine";
2700 return;
2701 }
2702
2703 warn "reloading...";
2704
2705 warn "entering sync_job";
2706
2707 cf::sync_job {
2708 cf::write_runtime; # external watchdog should not bark
2709 cf::emergency_save;
2710 cf::write_runtime; # external watchdog should not bark
2711
2712 warn "syncing database to disk";
2713 BDB::db_env_txn_checkpoint $DB_ENV;
2714
2715 # if anything goes wrong in here, we should simply crash as we already saved
2716
2717 warn "cancelling all WF_AUTOCANCEL watchers";
936 $_->cancel for Event::all_watchers; 2718 for (Event::all_watchers) {
2719 $_->cancel if $_->data & WF_AUTOCANCEL;
2720 }
937 2721
938 # unload all extensions 2722 warn "flushing outstanding aio requests";
939 for (@exts) { 2723 for (;;) {
940 $msg->("unloading <$_>"); 2724 BDB::flush;
941 unload_extension $_; 2725 IO::AIO::flush;
2726 Coro::cede;
2727 last unless IO::AIO::nreqs || BDB::nreqs;
2728 warn "iterate...";
2729 }
2730
2731 ++$RELOAD;
2732
2733 warn "cancelling all extension coros";
2734 $_->cancel for values %EXT_CORO;
2735 %EXT_CORO = ();
2736
2737 warn "removing commands";
2738 %COMMAND = ();
2739
2740 warn "removing ext commands";
2741 %EXTCMD = ();
2742
2743 warn "unloading/nuking all extensions";
2744 for my $pkg (@EXTS) {
2745 warn "... unloading $pkg";
2746
2747 if (my $cb = $pkg->can ("unload")) {
2748 eval {
2749 $cb->($pkg);
2750 1
2751 } or warn "$pkg unloaded, but with errors: $@";
942 } 2752 }
943 2753
2754 warn "... nuking $pkg";
2755 Symbol::delete_package $pkg;
2756 }
2757
944 # unload all modules loaded from $LIBDIR 2758 warn "unloading all perl modules loaded from $LIBDIR";
945 while (my ($k, $v) = each %INC) { 2759 while (my ($k, $v) = each %INC) {
946 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2760 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
947 2761
948 $msg->("removing <$k>"); 2762 warn "... unloading $k";
949 delete $INC{$k}; 2763 delete $INC{$k};
950 2764
951 $k =~ s/\.pm$//; 2765 $k =~ s/\.pm$//;
952 $k =~ s/\//::/g; 2766 $k =~ s/\//::/g;
953 2767
956 } 2770 }
957 2771
958 Symbol::delete_package $k; 2772 Symbol::delete_package $k;
959 } 2773 }
960 2774
961 # sync database to disk
962 cf::db_sync;
963
964 # get rid of safe::, as good as possible 2775 warn "getting rid of safe::, as good as possible";
965 Symbol::delete_package "safe::$_" 2776 Symbol::delete_package "safe::$_"
966 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2777 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
967 2778
968 # remove register_script_function callbacks
969 # TODO
970
971 # unload cf.pm "a bit" 2779 warn "unloading cf.pm \"a bit\"";
972 delete $INC{"cf.pm"}; 2780 delete $INC{"cf.pm"};
2781 delete $INC{"cf/pod.pm"};
973 2782
974 # don't, removes xs symbols, too, 2783 # don't, removes xs symbols, too,
975 # and global variables created in xs 2784 # and global variables created in xs
976 #Symbol::delete_package __PACKAGE__; 2785 #Symbol::delete_package __PACKAGE__;
977 2786
978 # reload cf.pm 2787 warn "unload completed, starting to reload now";
2788
979 $msg->("reloading cf.pm"); 2789 warn "reloading cf.pm";
980 require cf; 2790 require cf;
2791 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
981 2792
982 # load database again 2793 warn "loading config and database again";
983 cf::db_load; 2794 cf::cfg_load;
984 2795
985 # load extensions 2796 warn "loading extensions";
986 $msg->("load extensions");
987 cf::load_extensions; 2797 cf::load_extensions;
988 2798
989 # reattach attachments to objects 2799 warn "reattaching attachments to objects/players";
990 $msg->("reattach"); 2800 _global_reattach; # objects, sockets
991 _global_reattach; 2801 warn "reattaching attachments to maps";
2802 reattach $_ for values %MAP;
2803 warn "reattaching attachments to players";
2804 reattach $_ for values %PLAYER;
2805
2806 warn "leaving sync_job";
2807
2808 1
2809 } or do {
2810 warn $@;
2811 warn "error while reloading, exiting.";
2812 exit 1;
992 }; 2813 };
993 $msg->($@) if $@;
994 2814
995 $msg->("reloaded"); 2815 warn "reloaded";
996}; 2816};
997 2817
998sub perl_reload() { 2818our $RELOAD_WATCHER; # used only during reload
999 _perl_reload { 2819
1000 warn $_[0]; 2820sub reload_perl() {
1001 print "$_[0]\n"; 2821 # doing reload synchronously and two reloads happen back-to-back,
2822 # coro crashes during coro_state_free->destroy here.
2823
2824 $RELOAD_WATCHER ||= Event->timer (
2825 reentrant => 0,
2826 after => 0,
2827 data => WF_AUTOCANCEL,
2828 cb => sub {
2829 do_reload_perl;
2830 undef $RELOAD_WATCHER;
2831 },
1002 }; 2832 );
1003} 2833}
1004 2834
1005register_command "perl-reload", 0, sub { 2835register_command "reload" => sub {
1006 my ($who, $arg) = @_; 2836 my ($who, $arg) = @_;
1007 2837
1008 if ($who->flag (FLAG_WIZ)) { 2838 if ($who->flag (FLAG_WIZ)) {
1009 _perl_reload { 2839 $who->message ("reloading server.");
1010 warn $_[0]; 2840 async { reload_perl };
1011 $who->message ($_[0]); 2841 }
2842};
2843
2844unshift @INC, $LIBDIR;
2845
2846my $bug_warning = 0;
2847
2848our @WAIT_FOR_TICK;
2849our @WAIT_FOR_TICK_BEGIN;
2850
2851sub wait_for_tick {
2852 return unless $TICK_WATCHER->is_active;
2853 return if $Coro::current == $Coro::main;
2854
2855 my $signal = new Coro::Signal;
2856 push @WAIT_FOR_TICK, $signal;
2857 $signal->wait;
2858}
2859
2860sub wait_for_tick_begin {
2861 return unless $TICK_WATCHER->is_active;
2862 return if $Coro::current == $Coro::main;
2863
2864 my $signal = new Coro::Signal;
2865 push @WAIT_FOR_TICK_BEGIN, $signal;
2866 $signal->wait;
2867}
2868
2869 my $min = 1e6;#d#
2870 my $avg = 10;
2871$TICK_WATCHER = Event->timer (
2872 reentrant => 0,
2873 parked => 1,
2874 prio => 0,
2875 at => $NEXT_TICK || $TICK,
2876 data => WF_AUTOCANCEL,
2877 cb => sub {
2878 if ($Coro::current != $Coro::main) {
2879 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2880 unless ++$bug_warning > 10;
2881 return;
2882 }
2883
2884 $NOW = $tick_start = Event::time;
2885
2886 cf::server_tick; # one server iteration
2887
2888 0 && sync_job {#d#
2889 for(1..10) {
2890 my $t = Event::time;
2891 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2892 or die;
2893
2894 $map->width (50);
2895 $map->height (50);
2896 $map->alloc;
2897 $map->_load_objects ("/tmp/x.map", 1);
2898 my $t = Event::time - $t;
2899
2900 #next unless $t < 0.0013;#d#
2901 if ($t < $min) {
2902 $min = $t;
2903 }
2904 $avg = $avg * 0.99 + $t * 0.01;
2905 }
2906 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2907 exit 0;
2908 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1012 }; 2909 };
1013 }
1014};
1015 2910
1016register "<global>", __PACKAGE__; 2911 $RUNTIME += $TICK;
1017
1018unshift @INC, $LIBDIR;
1019
1020$TICK_WATCHER = Event->timer (
1021 prio => 1,
1022 at => $NEXT_TICK || 1,
1023 cb => sub {
1024 cf::server_tick; # one server iteration
1025
1026 my $NOW = Event::time;
1027 $NEXT_TICK += $TICK; 2912 $NEXT_TICK += $TICK;
1028 2913
2914 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2915 $NEXT_RUNTIME_WRITE = $NOW + 10;
2916 Coro::async_pool {
2917 write_runtime
2918 or warn "ERROR: unable to write runtime file: $!";
2919 };
2920 }
2921
2922# my $AFTER = Event::time;
2923# warn $AFTER - $NOW;#d#
2924
2925 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2926 $sig->send;
2927 }
2928 while (my $sig = shift @WAIT_FOR_TICK) {
2929 $sig->send;
2930 }
2931
2932 $NOW = Event::time;
2933
1029 # if we are delayed by four ticks, skip them all 2934 # if we are delayed by four ticks or more, skip them all
1030 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2935 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1031 2936
1032 $TICK_WATCHER->at ($NEXT_TICK); 2937 $TICK_WATCHER->at ($NEXT_TICK);
1033 $TICK_WATCHER->start; 2938 $TICK_WATCHER->start;
2939
2940 $LOAD = ($NOW - $tick_start) / $TICK;
2941 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2942
2943 _post_tick;
2944
2945
1034 }, 2946 },
1035); 2947);
1036 2948
2949{
2950 BDB::max_poll_time $TICK * 0.1;
2951 $BDB_POLL_WATCHER = Event->io (
2952 reentrant => 0,
2953 fd => BDB::poll_fileno,
2954 poll => 'r',
2955 prio => 0,
2956 data => WF_AUTOCANCEL,
2957 cb => \&BDB::poll_cb,
2958 );
2959 BDB::min_parallel 8;
2960
2961 BDB::set_sync_prepare {
2962 my $status;
2963 my $current = $Coro::current;
2964 (
2965 sub {
2966 $status = $!;
2967 $current->ready; undef $current;
2968 },
2969 sub {
2970 Coro::schedule while defined $current;
2971 $! = $status;
2972 },
2973 )
2974 };
2975
2976 unless ($DB_ENV) {
2977 $DB_ENV = BDB::db_env_create;
2978
2979 cf::sync_job {
2980 eval {
2981 BDB::db_env_open
2982 $DB_ENV,
2983 $BDBDIR,
2984 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2985 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2986 0666;
2987
2988 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2989
2990 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2991 $DB_ENV->set_lk_detect;
2992 };
2993
2994 cf::cleanup "db_env_open(db): $@" if $@;
2995 };
2996 }
2997}
2998
2999{
3000 IO::AIO::min_parallel 8;
3001
3002 undef $Coro::AIO::WATCHER;
3003 IO::AIO::max_poll_time $TICK * 0.1;
3004 $AIO_POLL_WATCHER = Event->io (
3005 reentrant => 0,
3006 data => WF_AUTOCANCEL,
3007 fd => IO::AIO::poll_fileno,
3008 poll => 'r',
3009 prio => 6,
3010 cb => \&IO::AIO::poll_cb,
3011 );
3012}
3013
3014my $_log_backtrace;
3015
3016sub _log_backtrace {
3017 my ($msg, @addr) = @_;
3018
3019 $msg =~ s/\n//;
3020
3021 # limit the # of concurrent backtraces
3022 if ($_log_backtrace < 2) {
3023 ++$_log_backtrace;
3024 async {
3025 my @bt = fork_call {
3026 @addr = map { sprintf "%x", $_ } @addr;
3027 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3028 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3029 or die "addr2line: $!";
3030
3031 my @funcs;
3032 my @res = <$fh>;
3033 chomp for @res;
3034 while (@res) {
3035 my ($func, $line) = splice @res, 0, 2, ();
3036 push @funcs, "[$func] $line";
3037 }
3038
3039 @funcs
3040 };
3041
3042 LOG llevInfo, "[ABT] $msg\n";
3043 LOG llevInfo, "[ABT] $_\n" for @bt;
3044 --$_log_backtrace;
3045 };
3046 } else {
3047 LOG llevInfo, "[ABT] $msg\n";
3048 LOG llevInfo, "[ABT] [suppressed]\n";
3049 }
3050}
3051
3052# load additional modules
3053use cf::pod;
3054
3055END { cf::emergency_save }
3056
10371 30571
1038 3058

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines