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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines