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.49 by root, Sun Aug 27 17:59:26 2006 UTC vs.
Revision 1.188 by root, Sat Jan 20 23:30:16 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.4 ();
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)) { 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 push @{$obj->{_attachment}}, $name; 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 @{ $obj->{_attachment} || [] }; 704 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
374 705
375 for my $name (@{ $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
718cf::attachable->attach (
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,
732 on_clone => sub {
733 my ($src, $dst) = @_;
734
735 @{$dst->registry} = @{$src->registry};
736
737 %$dst = %$src;
738
739 %{$dst->{_attachment}} = %{$src->{_attachment}}
740 if exists $src->{_attachment};
741 },
742);
743
387sub object_freezer_save { 744sub object_freezer_save {
388 my ($filename, $objs) = @_; 745 my ($filename, $rdata, $objs) = @_;
389 746
390 $filename .= ".pst"; 747 sync_job {
748 if (length $$rdata) {
749 warn sprintf "saving %s (%d,%d)\n",
750 $filename, length $$rdata, scalar @$objs;
391 751
392 if (@$objs) { 752 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
393 open my $fh, ">:raw", "$filename~"; 753 chmod SAVE_MODE, $fh;
394 chmod $fh, SAVE_MODE; 754 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
395 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 755 aio_fsync $fh;
396 close $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
397 rename "$filename~", $filename; 771 aio_rename "$filename~", $filename;
772 } else {
773 warn "FATAL: $filename~: $!\n";
774 }
398 } else { 775 } else {
399 unlink $filename; 776 aio_unlink $filename;
777 aio_unlink "$filename.pst";
778 }
400 } 779 }
780}
781
782sub object_freezer_as_string {
783 my ($rdata, $objs) = @_;
784
785 use Data::Dumper;
786
787 $$rdata . Dumper $objs
401} 788}
402 789
403sub object_thawer_load { 790sub object_thawer_load {
404 my ($filename) = @_; 791 my ($filename) = @_;
405 792
406 open my $fh, "<:raw:perlio", "$filename.pst" 793 my ($data, $av);
794
795 (aio_load $filename, $data) >= 0
407 or return; 796 or return;
408 797
409 eval { local $/; (Storable::thaw <$fh>)->{objs} } 798 unless (aio_stat "$filename.pst") {
410} 799 (aio_load "$filename.pst", $av) >= 0
411 800 or return;
412attach_to_objects 801 $av = eval { (Storable::thaw $av)->{objs} };
413 prio => -1000000,
414 on_clone => sub {
415 my ($src, $dst) = @_;
416
417 @{$dst->registry} = @{$src->registry};
418
419 %$dst = %$src;
420
421 $dst->{_attachment} = [@{ $src->{_attachment} }]
422 if exists $src->{_attachment};
423 }, 802 }
424; 803
804 warn sprintf "loading %s (%d)\n",
805 $filename, length $data, scalar @{$av || []};#d#
806 return ($data, $av);
807}
425 808
426############################################################################# 809#############################################################################
427# old plug-in events 810# command handling &c
428 811
429sub inject_event { 812=item cf::register_command $name => \&callback($ob,$args);
430 my $extension = shift;
431 my $event_code = shift;
432 813
433 my $cb = $hook[$event_code]{$extension} 814Register a callback for execution when the client sends the user command
434 or return; 815$name.
435 816
436 &$cb 817=cut
437}
438
439sub inject_global_event {
440 my $event = shift;
441
442 my $cb = $hook[$event]
443 or return;
444
445 List::Util::max map &$_, values %$cb
446}
447
448sub inject_command {
449 my ($name, $obj, $params) = @_;
450
451 for my $cmd (@{ $command{$name} }) {
452 $cmd->[1]->($obj, $params);
453 }
454
455 -1
456}
457 818
458sub register_command { 819sub register_command {
459 my ($name, $time, $cb) = @_; 820 my ($name, $cb) = @_;
460 821
461 my $caller = caller; 822 my $caller = caller;
462 #warn "registering command '$name/$time' to '$caller'"; 823 #warn "registering command '$name/$time' to '$caller'";
463 824
464 push @{ $command{$name} }, [$time, $cb, $caller]; 825 push @{ $COMMAND{$name} }, [$caller, $cb];
465 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
466} 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
467 836
468sub register_extcmd { 837sub register_extcmd {
469 my ($name, $cb) = @_; 838 my ($name, $cb) = @_;
470 839
471 my $caller = caller; 840 $EXTCMD{$name} = $cb;
472 #warn "registering extcmd '$name' to '$caller'";
473
474 $extcmd{$name} = [$cb, $caller];
475} 841}
476 842
477sub register { 843cf::player->attach (
478 my ($base, $pkg) = @_; 844 on_command => sub {
845 my ($pl, $name, $params) = @_;
479 846
480 #TODO 847 my $cb = $COMMAND{$name}
481} 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);
482 874
483sub load_extension { 875sub load_extension {
484 my ($path) = @_; 876 my ($path) = @_;
485 877
486 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
487 my $base = $1; 879 my $base = $1;
488 my $pkg = $1; 880 my $pkg = $1;
489 $pkg =~ s/[^[:word:]]/_/g; 881 $pkg =~ s/[^[:word:]]/_/g;
490 $pkg = "ext::$pkg"; 882 $pkg = "ext::$pkg";
491 883
492 warn "loading '$path' into '$pkg'\n"; 884 warn "... loading '$path' into '$pkg'\n";
493 885
494 open my $fh, "<:utf8", $path 886 open my $fh, "<:utf8", $path
495 or die "$path: $!"; 887 or die "$path: $!";
496 888
497 my $source = 889 my $source =
498 "package $pkg; use strict; use utf8;\n" 890 "package $pkg; use strict; use utf8;\n"
499 . "#line 1 \"$path\"\n{\n" 891 . "#line 1 \"$path\"\n{\n"
500 . (do { local $/; <$fh> }) 892 . (do { local $/; <$fh> })
501 . "\n};\n1"; 893 . "\n};\n1";
502 894
503 eval $source 895 unless (eval $source) {
504 or die "$path: $@"; 896 my $msg = $@ ? "$path: $@\n"
505 897 : "extension disabled.\n";
506 push @exts, $pkg; 898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
507 $ext_pkg{$base} = $pkg; 899 warn $@;
508 900 warn "mandatory extension failed to load, exiting.\n";
509# no strict 'refs'; 901 exit 1;
510# @{"$pkg\::ISA"} = ext::; 902 }
511 903 die $@;
512 register $base, $pkg;
513}
514
515sub unload_extension {
516 my ($pkg) = @_;
517
518 warn "removing extension $pkg\n";
519
520 # remove hooks
521 #TODO
522# for my $idx (0 .. $#PLUGIN_EVENT) {
523# delete $hook[$idx]{$pkg};
524# } 904 }
525 905
526 # remove commands 906 push @EXTS, $pkg;
527 for my $name (keys %command) {
528 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
529
530 if (@cb) {
531 $command{$name} = \@cb;
532 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
533 } else {
534 delete $command{$name};
535 delete $COMMAND{"$name\000"};
536 }
537 }
538
539 # remove extcmds
540 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
541 delete $extcmd{$name};
542 }
543
544 if (my $cb = $pkg->can ("unload")) {
545 eval {
546 $cb->($pkg);
547 1
548 } or warn "$pkg unloaded, but with errors: $@";
549 }
550
551 Symbol::delete_package $pkg;
552} 907}
553 908
554sub load_extensions { 909sub load_extensions {
555 my $LIBDIR = maps_directory "perl";
556
557 for my $ext (<$LIBDIR/*.ext>) { 910 for my $ext (<$LIBDIR/*.ext>) {
558 next unless -r $ext; 911 next unless -r $ext;
559 eval { 912 eval {
560 load_extension $ext; 913 load_extension $ext;
561 1 914 1
562 } or warn "$ext not loaded: $@"; 915 } or warn "$ext not loaded: $@";
563 } 916 }
564} 917}
565 918
566sub _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 # map plan:
1182 #
1183 # /! non-realised random map exit (special hack!)
1184 # {... are special paths that are not being touched
1185 # ?xxx/... are special absolute paths
1186 # ?random/... random maps
1187 # /... normal maps
1188 # ~user/... per-player map of a specific user
1189
1190 $path =~ s/$PATH_SEP/\//go;
1191
1192 # treat it as relative path if it starts with
1193 # something that looks reasonable
1194 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1195 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1196
1197 $base =~ s{[^/]+/?$}{};
1198 $path = "$base/$path";
1199 }
1200
1201 for ($path) {
1202 redo if s{//}{/};
1203 redo if s{/\.?/}{/};
1204 redo if s{/[^/]+/\.\./}{/};
1205 }
1206
1207 $path
1208}
1209
1210sub new_from_path {
1211 my (undef, $path, $base) = @_;
1212
1213 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1214
1215 $path = normalise $path, $base;
1216
1217 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1218 if ($path =~ $EXT_MAP{$pkg}[1]) {
1219 my $self = bless cf::map::new, $pkg;
1220 $self->{path} = $path; $self->path ($path);
1221 $self->init; # pass $1 etc.
1222 return $self;
1223 }
1224 }
1225
1226 Carp::carp "unable to resolve path '$path'.";
1227 ()
1228}
1229
1230sub init {
1231 my ($self) = @_;
1232
1233 $self
1234}
1235
1236sub as_string {
1237 my ($self) = @_;
1238
1239 "$self->{path}"
1240}
1241
1242# the displayed name, this is a one way mapping
1243sub visible_name {
1244 &as_string
1245}
1246
1247# the original (read-only) location
1248sub load_path {
1249 my ($self) = @_;
1250
1251 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1252}
1253
1254# the temporary/swap location
1255sub save_path {
1256 my ($self) = @_;
1257
1258 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1259 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1260}
1261
1262# the unique path, undef == no special unique path
1263sub uniq_path {
1264 my ($self) = @_;
1265
1266 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1267 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1268}
1269
1270# and all this just because we cannot iterate over
1271# all maps in C++...
1272sub change_all_map_light {
1273 my ($change) = @_;
1274
1275 $_->change_map_light ($change)
1276 for grep $_->outdoor, values %cf::MAP;
1277}
1278
1279sub unlink_save {
1280 my ($self) = @_;
1281
1282 utf8::encode (my $save = $self->save_path);
1283 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1284 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1285}
1286
1287sub load_header_from($) {
1288 my ($self, $path) = @_;
1289
1290 utf8::encode $path;
1291 aio_open $path, O_RDONLY, 0
1292 or return;
1293
1294 $self->_load_header ($path)
1295 or return;
1296
1297 $self->{load_path} = $path;
1298
1299 1
1300}
1301
1302sub load_header_orig {
1303 my ($self) = @_;
1304
1305 $self->load_header_from ($self->load_path)
1306}
1307
1308sub load_header_temp {
1309 my ($self) = @_;
1310
1311 $self->load_header_from ($self->save_path)
1312}
1313
1314sub prepare_temp {
1315 my ($self) = @_;
1316
1317 $self->last_access ((delete $self->{last_access})
1318 || $cf::RUNTIME); #d#
1319 # safety
1320 $self->{instantiate_time} = $cf::RUNTIME
1321 if $self->{instantiate_time} > $cf::RUNTIME;
1322}
1323
1324sub prepare_orig {
1325 my ($self) = @_;
1326
1327 $self->{load_original} = 1;
1328 $self->{instantiate_time} = $cf::RUNTIME;
1329 $self->last_access ($cf::RUNTIME);
1330 $self->instantiate;
1331}
1332
1333sub load_header {
1334 my ($self) = @_;
1335
1336 if ($self->load_header_temp) {
1337 $self->prepare_temp;
1338 } else {
1339 $self->load_header_orig
1340 or return;
1341 $self->prepare_orig;
1342 }
1343
1344 1
1345}
1346
1347sub find;
1348sub find {
1349 my ($path, $origin) = @_;
1350
1351 $path = normalise $path, $origin && $origin->path;
1352
1353 cf::lock_wait "map_find:$path";
1354
1355 $cf::MAP{$path} || do {
1356 my $guard = cf::lock_acquire "map_find:$path";
1357 my $map = new_from_path cf::map $path
1358 or return;
1359
1360 $map->{last_save} = $cf::RUNTIME;
1361
1362 $map->load_header
1363 or return;
1364
1365 if ($map->should_reset) {
1366 # doing this can freeze the server in a sync job, obviously
1367 #$cf::WAIT_FOR_TICK->wait;
1368 $map->reset;
1369 undef $guard;
1370 $map = find $path
1371 or return;
1372 }
1373
1374 $cf::MAP{$path} = $map
1375 }
1376}
1377
1378sub pre_load { }
1379sub post_load { }
1380
1381sub load {
1382 my ($self) = @_;
1383
1384 my $path = $self->{path};
1385 my $guard = cf::lock_acquire "map_load:$path";
1386
1387 return if $self->in_memory != cf::MAP_SWAPPED;
1388
1389 $self->in_memory (cf::MAP_LOADING);
1390
1391 $self->alloc;
1392
1393 $self->pre_load;
1394
1395 $self->_load_objects ($self->{load_path}, 1)
1396 or return;
1397
1398 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1399 if delete $self->{load_original};
1400
1401 if (my $uniq = $self->uniq_path) {
1402 utf8::encode $uniq;
1403 if (aio_open $uniq, O_RDONLY, 0) {
1404 $self->clear_unique_items;
1405 $self->_load_objects ($uniq, 0);
1406 }
1407 }
1408
1409 Coro::cede;
1410
1411 # now do the right thing for maps
1412 $self->link_multipart_objects;
1413
1414 unless ($self->{deny_activate}) {
1415 $self->decay_objects;
1416 $self->fix_auto_apply;
1417 $self->update_buttons;
1418 Coro::cede;
1419 $self->set_darkness_map;
1420 $self->difficulty ($self->estimate_difficulty)
1421 unless $self->difficulty;
1422 Coro::cede;
1423 $self->activate;
1424 }
1425
1426 $self->post_load;
1427
1428 $self->in_memory (cf::MAP_IN_MEMORY);
1429}
1430
1431sub customise_for {
1432 my ($self, $ob) = @_;
1433
1434 return find "~" . $ob->name . "/" . $self->{path}
1435 if $self->per_player;
1436
1437 $self
1438}
1439
1440# find and load all maps in the 3x3 area around a map
1441sub load_diag {
567 my ($msg) = @_; 1442 my ($map) = @_;
568 1443
569 $msg->("reloading..."); 1444 my @diag; # diagonal neighbours
570 1445
571 eval { 1446 for (0 .. 3) {
572 # 1. cancel all watchers 1447 my $neigh = $map->tile_path ($_)
573 $_->cancel for Event::all_watchers; 1448 or next;
1449 $neigh = find $neigh, $map
1450 or next;
1451 $neigh->load;
574 1452
575 # 2. unload all extensions 1453 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
576 for (@exts) { 1454 [$neigh->tile_path (($_ + 1) % 4), $neigh];
577 $msg->("unloading <$_>"); 1455 }
578 unload_extension $_;
579 }
580 1456
581 # 3. unload all modules loaded from $LIBDIR 1457 for (@diag) {
582 while (my ($k, $v) = each %INC) { 1458 my $neigh = find @$_
583 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1459 or next;
1460 $neigh->load;
1461 }
1462}
584 1463
585 $msg->("removing <$k>"); 1464sub find_sync {
586 delete $INC{$k}; 1465 my ($path, $origin) = @_;
587 1466
588 $k =~ s/\.pm$//; 1467 cf::sync_job { find $path, $origin }
589 $k =~ s/\//::/g; 1468}
590 1469
591 if (my $cb = $k->can ("unload_module")) { 1470sub do_load_sync {
592 $cb->(); 1471 my ($map) = @_;
1472
1473 cf::sync_job { $map->load };
1474}
1475
1476our %MAP_PREFETCH;
1477our $MAP_PREFETCHER = undef;
1478
1479sub find_async {
1480 my ($path, $origin) = @_;
1481
1482 $path = normalise $path, $origin && $origin->{path};
1483
1484 if (my $map = $cf::MAP{$path}) {
1485 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1486 }
1487
1488 undef $MAP_PREFETCH{$path};
1489 $MAP_PREFETCHER ||= cf::async {
1490 while (%MAP_PREFETCH) {
1491 for my $path (keys %MAP_PREFETCH) {
1492 my $map = find $path
1493 or next;
1494 $map->load;
1495
1496 delete $MAP_PREFETCH{$path};
593 } 1497 }
594
595 Symbol::delete_package $k;
596 }
597
598 # 4. get rid of safe::, as good as possible
599 Symbol::delete_package "safe::$_"
600 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
601
602 # 5. remove register_script_function callbacks
603 # TODO
604 1498 }
605 # 6. unload cf.pm "a bit" 1499 undef $MAP_PREFETCHER;
606 delete $INC{"cf.pm"};
607
608 # don't, removes xs symbols, too,
609 # and global variables created in xs
610 #Symbol::delete_package __PACKAGE__;
611
612 # 7. reload cf.pm
613 $msg->("reloading cf.pm");
614 require cf;
615 }; 1500 };
616 $msg->($@) if $@;
617 1501
618 $msg->("reloaded"); 1502 ()
619}; 1503}
620 1504
621sub perl_reload() { 1505sub save {
622 _perl_reload { 1506 my ($self) = @_;
623 warn $_[0]; 1507
624 print "$_[0]\n"; 1508 my $lock = cf::lock_acquire "map_data:" . $self->path;
1509
1510 $self->{last_save} = $cf::RUNTIME;
1511
1512 return unless $self->dirty;
1513
1514 my $save = $self->save_path; utf8::encode $save;
1515 my $uniq = $self->uniq_path; utf8::encode $uniq;
1516
1517 $self->{load_path} = $save;
1518
1519 return if $self->{deny_save};
1520
1521 local $self->{last_access} = $self->last_access;#d#
1522
1523 cf::async {
1524 $_->contr->save for $self->players;
625 }; 1525 };
626}
627 1526
628register_command "perl-reload", 0, sub { 1527 if ($uniq) {
629 my ($who, $arg) = @_; 1528 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
630 1529 $self->_save_objects ($uniq, cf::IO_UNIQUES);
631 if ($who->flag (FLAG_WIZ)) {
632 _perl_reload {
633 warn $_[0];
634 $who->message ($_[0]);
635 };
636 }
637};
638
639#############################################################################
640# extcmd framework, basically convert ext <msg>
641# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
642
643attach_to_players
644 on_extcmd => sub {
645 my ($pl, $buf) = @_;
646
647 my $msg = eval { from_json $buf };
648
649 if (ref $msg) {
650 if (my $cb = $extcmd{$msg->{msgtype}}) {
651 if (my %reply = $cb->[0]->($pl, $msg)) {
652 $pl->ext_reply ($msg->{msgid}, %reply);
653 }
654 }
655 } else { 1530 } else {
656 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1531 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
657 }
658
659 cf::override;
660 }, 1532 }
661; 1533}
662 1534
663############################################################################# 1535sub swap_out {
664# load/save/clean perl data associated with a map
665
666*cf::mapsupport::on_clean = sub {
667 my ($map) = @_; 1536 my ($self) = @_;
668 1537
669 my $path = $map->tmpname; 1538 # save first because save cedes
670 defined $path or return; 1539 $self->save;
671 1540
672 unlink "$path.cfperl"; 1541 my $lock = cf::lock_acquire "map_data:" . $self->path;
673 unlink "$path.pst";
674};
675 1542
676*cf::mapsupport::on_swapin = 1543 return if $self->players;
677*cf::mapsupport::on_load = sub { 1544 return if $self->in_memory != cf::MAP_IN_MEMORY;
1545 return if $self->{deny_save};
1546
1547 $self->clear;
1548 $self->in_memory (cf::MAP_SWAPPED);
1549}
1550
1551sub reset_at {
678 my ($map) = @_; 1552 my ($self) = @_;
679 1553
680 my $path = $map->tmpname; 1554 # TODO: safety, remove and allow resettable per-player maps
681 $path = $map->path unless defined $path; 1555 return 1e99 if $self->isa ("ext::map_per_player");#d#
1556 return 1e99 if $self->{deny_reset};
682 1557
683 open my $fh, "<:raw", "$path.cfperl" 1558 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
684 or return; # no perl data 1559 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
685 1560
686 my $data = Storable::thaw do { local $/; <$fh> }; 1561 $time + $to
1562}
687 1563
688 $data->{version} <= 1 1564sub should_reset {
1565 my ($self) = @_;
1566
1567 $self->reset_at <= $cf::RUNTIME
1568}
1569
1570sub reset {
1571 my ($self) = @_;
1572
1573 my $lock = cf::lock_acquire "map_data:$self->{path}";
1574
1575 return if $self->players;
1576 return if $self->isa ("ext::map_per_player");#d#
1577
1578 warn "resetting map ", $self->path;#d#
1579
1580 delete $cf::MAP{$self->path};
1581
1582 $self->in_memory (cf::MAP_SWAPPED);
1583 $self->clear;
1584
1585 $_->clear_links_to ($self) for values %cf::MAP;
1586
1587 $self->unlink_save;
1588 $self->destroy;
1589}
1590
1591my $nuke_counter = "aaaa";
1592
1593sub nuke {
1594 my ($self) = @_;
1595
1596 delete $cf::MAP{$self->path};
1597
1598 $self->unlink_save;
1599
1600 bless $self, "cf::map";
1601 delete $self->{deny_reset};
1602 $self->{deny_save} = 1;
1603 $self->reset_timeout (1);
1604 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1605
1606 $cf::MAP{$self->path} = $self;
1607
1608 $self->reset; # polite request, might not happen
1609}
1610
1611=item cf::map::unique_maps
1612
1613Returns an arrayref of paths of all shared maps that have
1614instantiated unique items. May block.
1615
1616=cut
1617
1618sub unique_maps() {
1619 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
689 or return; # too new 1620 or return;
690 1621
691 $map->_set_obs ($data->{obs}); 1622 my @paths;
692};
693 1623
694attach_to_maps prio => -10000, package => cf::mapsupport::; 1624 for (@$files) {
1625 utf8::decode $_;
1626 next if /\.pst$/;
1627 next unless /^$PATH_SEP/o;
695 1628
696############################################################################# 1629 s/\.map$//;
697# load/save perl data associated with player->ob objects 1630 push @paths, $_;
698
699sub all_objects(@) {
700 @_, map all_objects ($_->inv), @_
701}
702
703attach_to_players
704 on_load => sub {
705 my ($pl, $path) = @_;
706
707 for my $o (all_objects $pl->ob) {
708 if (my $value = $o->get_ob_key_value ("_perl_data")) {
709 $o->set_ob_key_value ("_perl_data");
710
711 %$o = %{ Storable::thaw pack "H*", $value };
712 }
713 }
714 }, 1631 }
715;
716 1632
717############################################################################# 1633 \@paths
718# core extensions - in perl
719
720=item cf::player::exists $login
721
722Returns true when the given account exists.
723
724=cut
725
726sub cf::player::exists($) {
727 cf::player::find $_[0]
728 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
729} 1634}
730 1635
1636package cf;
1637
1638=back
1639
1640=head3 cf::object
1641
1642=cut
1643
1644package cf::object;
1645
1646=over 4
1647
1648=item $ob->inv_recursive
1649
1650Returns the inventory of the object _and_ their inventories, recursively.
1651
1652=cut
1653
1654sub inv_recursive_;
1655sub inv_recursive_ {
1656 map { $_, inv_recursive_ $_->inv } @_
1657}
1658
1659sub inv_recursive {
1660 inv_recursive_ inv $_[0]
1661}
1662
1663package cf;
1664
1665=back
1666
1667=head3 cf::object::player
1668
1669=over 4
1670
731=item $player->reply ($npc, $msg[, $flags]) 1671=item $player_object->reply ($npc, $msg[, $flags])
732 1672
733Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1673Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
734can be C<undef>. Does the right thing when the player is currently in a 1674can be C<undef>. Does the right thing when the player is currently in a
735dialogue with the given NPC character. 1675dialogue with the given NPC character.
736 1676
737=cut 1677=cut
738 1678
739# rough implementation of a future "reply" method that works 1679# rough implementation of a future "reply" method that works
740# with dialog boxes. 1680# with dialog boxes.
1681#TODO: the first argument must go, split into a $npc->reply_to ( method
741sub cf::object::player::reply($$$;$) { 1682sub cf::object::player::reply($$$;$) {
742 my ($self, $npc, $msg, $flags) = @_; 1683 my ($self, $npc, $msg, $flags) = @_;
743 1684
744 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1685 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
745 1686
749 $msg = $npc->name . " says: $msg" if $npc; 1690 $msg = $npc->name . " says: $msg" if $npc;
750 $self->message ($msg, $flags); 1691 $self->message ($msg, $flags);
751 } 1692 }
752} 1693}
753 1694
754=item $player->ext_reply ($msgid, $msgtype, %msg) 1695=item $player_object->may ("access")
755 1696
756Sends an ext reply to the player. 1697Returns wether the given player is authorized to access resource "access"
1698(e.g. "command_wizcast").
757 1699
758=cut 1700=cut
759 1701
760sub cf::player::ext_reply($$$%) { 1702sub cf::object::player::may {
1703 my ($self, $access) = @_;
1704
1705 $self->flag (cf::FLAG_WIZ) ||
1706 (ref $cf::CFG{"may_$access"}
1707 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1708 : $cf::CFG{"may_$access"})
1709}
1710
1711=item $player_object->enter_link
1712
1713Freezes the player and moves him/her to a special map (C<{link}>).
1714
1715The player should be reasonably safe there for short amounts of time. You
1716I<MUST> call C<leave_link> as soon as possible, though.
1717
1718Will never block.
1719
1720=item $player_object->leave_link ($map, $x, $y)
1721
1722Moves the player out of the special C<{link}> map onto the specified
1723map. If the map is not valid (or omitted), the player will be moved back
1724to the location he/she was before the call to C<enter_link>, or, if that
1725fails, to the emergency map position.
1726
1727Might block.
1728
1729=cut
1730
1731sub link_map {
1732 unless ($LINK_MAP) {
1733 $LINK_MAP = cf::map::find "{link}"
1734 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1735 $LINK_MAP->load;
1736 }
1737
1738 $LINK_MAP
1739}
1740
1741sub cf::object::player::enter_link {
1742 my ($self) = @_;
1743
1744 $self->deactivate_recursive;
1745
1746 return if UNIVERSAL::isa $self->map, "ext::map_link";
1747
1748 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1749 if $self->map;
1750
1751 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1752}
1753
1754sub cf::object::player::leave_link {
1755 my ($self, $map, $x, $y) = @_;
1756
1757 my $link_pos = delete $self->{_link_pos};
1758
1759 unless ($map) {
1760 # restore original map position
1761 ($map, $x, $y) = @{ $link_pos || [] };
1762 $map = cf::map::find $map;
1763
1764 unless ($map) {
1765 ($map, $x, $y) = @$EMERGENCY_POSITION;
1766 $map = cf::map::find $map
1767 or die "FATAL: cannot load emergency map\n";
1768 }
1769 }
1770
1771 ($x, $y) = (-1, -1)
1772 unless (defined $x) && (defined $y);
1773
1774 # use -1 or undef as default coordinates, not 0, 0
1775 ($x, $y) = ($map->enter_x, $map->enter_y)
1776 if $x <=0 && $y <= 0;
1777
1778 $map->load;
1779 $map->load_diag;
1780
1781 return unless $self->contr->active;
1782 $self->activate_recursive;
1783 $self->enter_map ($map, $x, $y);
1784}
1785
1786cf::player->attach (
1787 on_logout => sub {
1788 my ($pl) = @_;
1789
1790 # abort map switching before logout
1791 if ($pl->ob->{_link_pos}) {
1792 cf::sync_job {
1793 $pl->ob->leave_link
1794 };
1795 }
1796 },
1797 on_login => sub {
1798 my ($pl) = @_;
1799
1800 # try to abort aborted map switching on player login :)
1801 # should happen only on crashes
1802 if ($pl->ob->{_link_pos}) {
1803 $pl->ob->enter_link;
1804 (async {
1805 # we need this sleep as the login has a concurrent enter_exit running
1806 # and this sleep increases chances of the player not ending up in scorn
1807 $pl->ob->reply (undef,
1808 "There was an internal problem at your last logout, "
1809 . "the server will try to bring you to your intended destination in a second.",
1810 cf::NDI_RED);
1811 Coro::Timer::sleep 1;
1812 $pl->ob->leave_link;
1813 })->prio (2);
1814 }
1815 },
1816);
1817
1818=item $player_object->goto ($path, $x, $y)
1819
1820=cut
1821
1822sub cf::object::player::goto {
1823 my ($self, $path, $x, $y) = @_;
1824
1825 $self->enter_link;
1826
1827 (async {
1828 my $map = cf::map::find $path;
1829 $map = $map->customise_for ($self) if $map;
1830
1831# warn "entering ", $map->path, " at ($x, $y)\n"
1832# if $map;
1833
1834 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1835
1836 $self->leave_link ($map, $x, $y);
1837 })->prio (1);
1838}
1839
1840=item $player_object->enter_exit ($exit_object)
1841
1842=cut
1843
1844sub parse_random_map_params {
1845 my ($spec) = @_;
1846
1847 my $rmp = { # defaults
1848 xsize => (cf::rndm 15, 40),
1849 ysize => (cf::rndm 15, 40),
1850 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1851 #layout => string,
1852 };
1853
1854 for (split /\n/, $spec) {
1855 my ($k, $v) = split /\s+/, $_, 2;
1856
1857 $rmp->{lc $k} = $v if (length $k) && (length $v);
1858 }
1859
1860 $rmp
1861}
1862
1863sub prepare_random_map {
1864 my ($exit) = @_;
1865
1866 my $guard = cf::lock_acquire "exit_prepare:$exit";
1867
1868 # all this does is basically replace the /! path by
1869 # a new random map path (?random/...) with a seed
1870 # that depends on the exit object
1871
1872 my $rmp = parse_random_map_params $exit->msg;
1873
1874 if ($exit->map) {
1875 $rmp->{region} = $exit->map->region_name;
1876 $rmp->{origin_map} = $exit->map->path;
1877 $rmp->{origin_x} = $exit->x;
1878 $rmp->{origin_y} = $exit->y;
1879 }
1880
1881 $rmp->{random_seed} ||= $exit->random_seed;
1882
1883 my $data = cf::to_json $rmp;
1884 my $md5 = Digest::MD5::md5_hex $data;
1885 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1886
1887 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1888 aio_write $fh, 0, (length $data), $data, 0;
1889 undef $fh;
1890 aio_rename "$meta~", $meta;
1891
1892 $exit->slaying ("?random/$md5");
1893 $exit->msg (undef);
1894 }
1895}
1896
1897sub cf::object::player::enter_exit {
761 my ($self, $id, %msg) = @_; 1898 my ($self, $exit) = @_;
762 1899
763 $msg{msgid} = $id; 1900 return unless $self->type == cf::PLAYER;
764 1901
765 $self->send ("ext " . to_json \%msg); 1902 $self->enter_link;
766}
767 1903
768############################################################################# 1904 (async {
769# map scripting support 1905 $self->deactivate_recursive; # just to be sure
1906 unless (eval {
1907 prepare_random_map $exit
1908 if $exit->slaying eq "/!";
1909
1910 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1911 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1912
1913 1;
1914 }) {
1915 $self->message ("Something went wrong deep within the crossfire server. "
1916 . "I'll try to bring you back to the map you were before. "
1917 . "Please report this to the dungeon master!",
1918 cf::NDI_UNIQUE | cf::NDI_RED);
1919
1920 warn "ERROR in enter_exit: $@";
1921 $self->leave_link;
1922 }
1923 })->prio (1);
1924}
1925
1926=head3 cf::client
1927
1928=over 4
1929
1930=item $client->send_drawinfo ($text, $flags)
1931
1932Sends a drawinfo packet to the client. Circumvents output buffering so
1933should not be used under normal circumstances.
1934
1935=cut
1936
1937sub cf::client::send_drawinfo {
1938 my ($self, $text, $flags) = @_;
1939
1940 utf8::encode $text;
1941 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1942}
1943
1944
1945=item $success = $client->query ($flags, "text", \&cb)
1946
1947Queues a query to the client, calling the given callback with
1948the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1949C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1950
1951Queries can fail, so check the return code. Or don't, as queries will become
1952reliable at some point in the future.
1953
1954=cut
1955
1956sub cf::client::query {
1957 my ($self, $flags, $text, $cb) = @_;
1958
1959 return unless $self->state == ST_PLAYING
1960 || $self->state == ST_SETUP
1961 || $self->state == ST_CUSTOM;
1962
1963 $self->state (ST_CUSTOM);
1964
1965 utf8::encode $text;
1966 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1967
1968 $self->send_packet ($self->{query_queue}[0][0])
1969 if @{ $self->{query_queue} } == 1;
1970}
1971
1972cf::client->attach (
1973 on_reply => sub {
1974 my ($ns, $msg) = @_;
1975
1976 # this weird shuffling is so that direct followup queries
1977 # get handled first
1978 my $queue = delete $ns->{query_queue}
1979 or return; # be conservative, not sure how that can happen, but we saw a crash here
1980
1981 (shift @$queue)->[1]->($msg);
1982
1983 push @{ $ns->{query_queue} }, @$queue;
1984
1985 if (@{ $ns->{query_queue} } == @$queue) {
1986 if (@$queue) {
1987 $ns->send_packet ($ns->{query_queue}[0][0]);
1988 } else {
1989 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1990 }
1991 }
1992 },
1993);
1994
1995=item $client->async (\&cb)
1996
1997Create a new coroutine, running the specified callback. The coroutine will
1998be automatically cancelled when the client gets destroyed (e.g. on logout,
1999or loss of connection).
2000
2001=cut
2002
2003sub cf::client::async {
2004 my ($self, $cb) = @_;
2005
2006 my $coro = &Coro::async ($cb);
2007
2008 $coro->on_destroy (sub {
2009 delete $self->{_coro}{$coro+0};
2010 });
2011
2012 $self->{_coro}{$coro+0} = $coro;
2013
2014 $coro
2015}
2016
2017cf::client->attach (
2018 on_destroy => sub {
2019 my ($ns) = @_;
2020
2021 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2022 },
2023);
2024
2025=back
2026
2027
2028=head2 SAFE SCRIPTING
2029
2030Functions that provide a safe environment to compile and execute
2031snippets of perl code without them endangering the safety of the server
2032itself. Looping constructs, I/O operators and other built-in functionality
2033is not available in the safe scripting environment, and the number of
2034functions and methods that can be called is greatly reduced.
2035
2036=cut
770 2037
771our $safe = new Safe "safe"; 2038our $safe = new Safe "safe";
772our $safe_hole = new Safe::Hole; 2039our $safe_hole = new Safe::Hole;
773 2040
774$SIG{FPE} = 'IGNORE'; 2041$SIG{FPE} = 'IGNORE';
775 2042
776$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2043$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
777 2044
778# here we export the classes and methods available to script code 2045# here we export the classes and methods available to script code
779 2046
2047=pod
2048
2049The following fucntions and emthods are available within a safe environment:
2050
2051 cf::object contr pay_amount pay_player map
2052 cf::object::player player
2053 cf::player peaceful
2054 cf::map trigger
2055
2056=cut
2057
780for ( 2058for (
781 ["cf::object" => qw(contr pay_amount pay_player)], 2059 ["cf::object" => qw(contr pay_amount pay_player map)],
782 ["cf::object::player" => qw(player)], 2060 ["cf::object::player" => qw(player)],
783 ["cf::player" => qw(peaceful)], 2061 ["cf::player" => qw(peaceful)],
2062 ["cf::map" => qw(trigger)],
784) { 2063) {
785 no strict 'refs'; 2064 no strict 'refs';
786 my ($pkg, @funs) = @$_; 2065 my ($pkg, @funs) = @$_;
787 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2066 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
788 for @funs; 2067 for @funs;
789} 2068}
2069
2070=over 4
2071
2072=item @retval = safe_eval $code, [var => value, ...]
2073
2074Compiled and executes the given perl code snippet. additional var/value
2075pairs result in temporary local (my) scalar variables of the given name
2076that are available in the code snippet. Example:
2077
2078 my $five = safe_eval '$first + $second', first => 1, second => 4;
2079
2080=cut
790 2081
791sub safe_eval($;@) { 2082sub safe_eval($;@) {
792 my ($code, %vars) = @_; 2083 my ($code, %vars) = @_;
793 2084
794 my $qcode = $code; 2085 my $qcode = $code;
817 } 2108 }
818 2109
819 wantarray ? @res : $res[0] 2110 wantarray ? @res : $res[0]
820} 2111}
821 2112
2113=item cf::register_script_function $function => $cb
2114
2115Register a function that can be called from within map/npc scripts. The
2116function should be reasonably secure and should be put into a package name
2117like the extension.
2118
2119Example: register a function that gets called whenever a map script calls
2120C<rent::overview>, as used by the C<rent> extension.
2121
2122 cf::register_script_function "rent::overview" => sub {
2123 ...
2124 };
2125
2126=cut
2127
822sub register_script_function { 2128sub register_script_function {
823 my ($fun, $cb) = @_; 2129 my ($fun, $cb) = @_;
824 2130
825 no strict 'refs'; 2131 no strict 'refs';
826 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2132 *{"safe::$fun"} = $safe_hole->wrap ($cb);
827} 2133}
828 2134
2135=back
2136
2137=cut
2138
2139#############################################################################
2140
2141=head2 EXTENSION DATABASE SUPPORT
2142
2143Crossfire maintains a very simple database for extension use. It can
2144currently store anything that can be serialised using Storable, which
2145excludes objects.
2146
2147The parameter C<$family> should best start with the name of the extension
2148using it, it should be unique.
2149
2150=over 4
2151
2152=item $hashref = cf::db_get $family
2153
2154Return a hashref for use by the extension C<$family>, which can be
2155modified. After modifications, you have to call C<cf::db_dirty> or
2156C<cf::db_sync>.
2157
2158=item $value = cf::db_get $family => $key
2159
2160Returns a single value from the database
2161
2162=item cf::db_put $family => $hashref
2163
2164Stores the given family hashref into the database. Updates are delayed, if
2165you want the data to be synced to disk immediately, use C<cf::db_sync>.
2166
2167=item cf::db_put $family => $key => $value
2168
2169Stores the given C<$value> in the family hash. Updates are delayed, if you
2170want the data to be synced to disk immediately, use C<cf::db_sync>.
2171
2172=item cf::db_dirty
2173
2174Marks the database as dirty, to be updated at a later time.
2175
2176=item cf::db_sync
2177
2178Immediately write the database to disk I<if it is dirty>.
2179
2180=cut
2181
2182our $DB;
2183
2184{
2185 my $path = cf::localdir . "/database.pst";
2186
2187 sub db_load() {
2188 $DB = stat $path ? Storable::retrieve $path : { };
2189 }
2190
2191 my $pid;
2192
2193 sub db_save() {
2194 waitpid $pid, 0 if $pid;
2195 if (0 == ($pid = fork)) {
2196 $DB->{_meta}{version} = 1;
2197 Storable::nstore $DB, "$path~";
2198 rename "$path~", $path;
2199 cf::_exit 0 if defined $pid;
2200 }
2201 }
2202
2203 my $dirty;
2204
2205 sub db_sync() {
2206 db_save if $dirty;
2207 undef $dirty;
2208 }
2209
2210 my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2211 db_sync;
2212 });
2213
2214 sub db_dirty() {
2215 $dirty = 1;
2216 $idle->start;
2217 }
2218
2219 sub db_get($;$) {
2220 @_ >= 2
2221 ? $DB->{$_[0]}{$_[1]}
2222 : ($DB->{$_[0]} ||= { })
2223 }
2224
2225 sub db_put($$;$) {
2226 if (@_ >= 3) {
2227 $DB->{$_[0]}{$_[1]} = $_[2];
2228 } else {
2229 $DB->{$_[0]} = $_[1];
2230 }
2231 db_dirty;
2232 }
2233
2234 cf::global->attach (
2235 prio => 10000,
2236 on_cleanup => sub {
2237 db_sync;
2238 },
2239 );
2240}
2241
829############################################################################# 2242#############################################################################
830# the server's main() 2243# the server's main()
831 2244
2245sub cfg_load {
2246 open my $fh, "<:utf8", cf::confdir . "/config"
2247 or return;
2248
2249 local $/;
2250 *CFG = YAML::Syck::Load <$fh>;
2251
2252 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2253
2254 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2255 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2256
2257 if (exists $CFG{mlockall}) {
2258 eval {
2259 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2260 and die "WARNING: m(un)lockall failed: $!\n";
2261 };
2262 warn $@ if $@;
2263 }
2264}
2265
832sub main { 2266sub main {
2267 # we must not ever block the main coroutine
2268 local $Coro::idle = sub {
2269 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2270 (async {
2271 Event::one_event;
2272 })->prio (Coro::PRIO_MAX);
2273 };
2274
2275 cfg_load;
2276 db_load;
2277 load_extensions;
2278
2279 $TICK_WATCHER->start;
833 Event::loop; 2280 Event::loop;
834} 2281}
835 2282
836############################################################################# 2283#############################################################################
837# initialisation 2284# initialisation and cleanup
838 2285
839register "<global>", __PACKAGE__; 2286# install some emergency cleanup handlers
2287BEGIN {
2288 for my $signal (qw(INT HUP TERM)) {
2289 Event->signal (
2290 data => WF_AUTOCANCEL,
2291 signal => $signal,
2292 cb => sub {
2293 cf::cleanup "SIG$signal";
2294 },
2295 );
2296 }
2297}
2298
2299sub emergency_save() {
2300 my $freeze_guard = cf::freeze_mainloop;
2301
2302 warn "enter emergency perl save\n";
2303
2304 cf::sync_job {
2305 # use a peculiar iteration method to avoid tripping on perl
2306 # refcount bugs in for. also avoids problems with players
2307 # and maps saved/destroyed asynchronously.
2308 warn "begin emergency player save\n";
2309 for my $login (keys %cf::PLAYER) {
2310 my $pl = $cf::PLAYER{$login} or next;
2311 $pl->valid or next;
2312 $pl->save;
2313 }
2314 warn "end emergency player save\n";
2315
2316 warn "begin emergency map save\n";
2317 for my $path (keys %cf::MAP) {
2318 my $map = $cf::MAP{$path} or next;
2319 $map->valid or next;
2320 $map->save;
2321 }
2322 warn "end emergency map save\n";
2323 };
2324
2325 warn "leave emergency perl save\n";
2326}
2327
2328sub reload() {
2329 # can/must only be called in main
2330 if ($Coro::current != $Coro::main) {
2331 warn "can only reload from main coroutine";
2332 return;
2333 }
2334
2335 warn "reloading...";
2336
2337 warn "cancelling server ticker";
2338 $TICK_WATCHER->cancel;
2339
2340 cf::emergency_save;
2341
2342 eval {
2343 # if anything goes wrong in here, we should simply crash as we already saved
2344
2345 warn "syncing database to disk";
2346 cf::db_sync;
2347
2348 warn "cancelling all WF_AUTOCANCEL watchers";
2349 for (Event::all_watchers) {
2350 $_->cancel if $_->data & WF_AUTOCANCEL;
2351 }
2352
2353 warn "flushing outstanding aio requests";
2354 for (;;) {
2355 IO::AIO::flush;
2356 Coro::cede;
2357 last unless IO::AIO::nreqs;
2358 warn "iterate...";
2359 }
2360
2361 warn "cancelling all extension coros";
2362 $_->cancel for values %EXT_CORO;
2363 %EXT_CORO = ();
2364
2365 warn "removing commands";
2366 %COMMAND = ();
2367
2368 warn "removing ext commands";
2369 %EXTCMD = ();
2370
2371 warn "unloading/nuking all extensions";
2372 for my $pkg (@EXTS) {
2373 warn "... unloading $pkg";
2374
2375 if (my $cb = $pkg->can ("unload")) {
2376 eval {
2377 $cb->($pkg);
2378 1
2379 } or warn "$pkg unloaded, but with errors: $@";
2380 }
2381
2382 warn "... nuking $pkg";
2383 Symbol::delete_package $pkg;
2384 }
2385
2386 warn "unloading all perl modules loaded from $LIBDIR";
2387 while (my ($k, $v) = each %INC) {
2388 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2389
2390 warn "... unloading $k";
2391 delete $INC{$k};
2392
2393 $k =~ s/\.pm$//;
2394 $k =~ s/\//::/g;
2395
2396 if (my $cb = $k->can ("unload_module")) {
2397 $cb->();
2398 }
2399
2400 Symbol::delete_package $k;
2401 }
2402
2403 warn "getting rid of safe::, as good as possible";
2404 Symbol::delete_package "safe::$_"
2405 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2406
2407 warn "unloading cf.pm \"a bit\"";
2408 delete $INC{"cf.pm"};
2409
2410 # don't, removes xs symbols, too,
2411 # and global variables created in xs
2412 #Symbol::delete_package __PACKAGE__;
2413
2414 warn "unload completed, starting to reload now";
2415
2416 warn "reloading cf.pm";
2417 require cf;
2418 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2419
2420 warn "loading config and database again";
2421 cf::cfg_load;
2422 cf::db_load;
2423
2424 warn "loading extensions";
2425 cf::load_extensions;
2426
2427 warn "reattaching attachments to objects/players";
2428 _global_reattach;
2429 warn "reattaching attachments to maps";
2430 reattach $_ for values %MAP;
2431
2432 warn "restarting server ticker";
2433
2434 $TICK_WATCHER->start;
2435 };
2436
2437 if ($@) {
2438 warn $@;
2439 warn "error while reloading, exiting.";
2440 exit 1;
2441 }
2442
2443 warn "reloaded";
2444};
2445
2446our $RELOAD_WATCHER; # used only during reload
2447
2448register_command "reload" => sub {
2449 my ($who, $arg) = @_;
2450
2451 if ($who->flag (FLAG_WIZ)) {
2452 $who->message ("reloading server.");
2453
2454 # doing reload synchronously and two reloads happen back-to-back,
2455 # coro crashes during coro_state_free->destroy here.
2456
2457 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2458 reload;
2459 undef $RELOAD_WATCHER;
2460 });
2461 }
2462};
840 2463
841unshift @INC, $LIBDIR; 2464unshift @INC, $LIBDIR;
842 2465
843load_extensions; 2466my $bug_warning = 0;
844 2467
845$TICK_WATCHER = Event->timer ( 2468$TICK_WATCHER = Event->timer (
2469 reentrant => 0,
2470 parked => 1,
846 prio => 1, 2471 prio => 0,
847 at => $NEXT_TICK || 1, 2472 at => $NEXT_TICK || $TICK,
2473 data => WF_AUTOCANCEL,
848 cb => sub { 2474 cb => sub {
2475 if ($Coro::current != $Coro::main) {
2476 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2477 unless ++$bug_warning > 10;
2478 return;
2479 }
2480
2481 $NOW = Event::time;
2482
849 cf::server_tick; # one server iteration 2483 cf::server_tick; # one server iteration
850 2484 $RUNTIME += $TICK;
851 my $NOW = Event::time;
852 $NEXT_TICK += $TICK; 2485 $NEXT_TICK += $TICK;
853 2486
2487 $WAIT_FOR_TICK->broadcast;
2488 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2489
854 # if we are delayed by four ticks, skip them all 2490 # if we are delayed by four ticks or more, skip them all
855 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2491 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
856 2492
857 $TICK_WATCHER->at ($NEXT_TICK); 2493 $TICK_WATCHER->at ($NEXT_TICK);
858 $TICK_WATCHER->start; 2494 $TICK_WATCHER->start;
859 }, 2495 },
860); 2496);
861 2497
862_reload_2; 2498IO::AIO::max_poll_time $TICK * 0.2;
2499
2500$AIO_POLL_WATCHER = Event->io (
2501 fd => IO::AIO::poll_fileno,
2502 poll => 'r',
2503 prio => 5,
2504 data => WF_AUTOCANCEL,
2505 cb => \&IO::AIO::poll_cb,
2506);
2507
2508$WRITE_RUNTIME_WATCHER = Event->timer (
2509 data => WF_AUTOCANCEL,
2510 after => 1,
2511 interval => 10,
2512 prio => 6, # keep it lowest so it acts like a watchdog
2513 cb => Coro::unblock_sub {
2514 write_runtime
2515 or warn "ERROR: unable to write runtime file: $!";
2516 },
2517);
2518
2519END { cf::emergency_save }
863 2520
8641 25211
865 2522

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines