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.54 by root, Tue Aug 29 14:49:28 2006 UTC vs.
Revision 1.220 by root, Sat Feb 17 23:54:35 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines