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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines