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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines