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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines