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.43 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.227 by root, Fri Mar 23 18:32:48 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines