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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines