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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines