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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines