ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.190 by root, Mon Jan 22 03:44:41 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 cf::living)) { 153for my $pkg (qw(
154 cf::global cf::attachable
155 cf::object cf::object::player
156 cf::client cf::player
157 cf::arch cf::living
158 cf::map cf::party cf::region
159)) {
78 no strict 'refs'; 160 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 161 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 162}
81 163
82$Event::DIED = sub { 164$Event::DIED = sub {
83 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
84}; 166};
85 167
86my %ext_pkg; 168=head2 UTILITY FUNCTIONS
87my @exts;
88my @hook;
89my %command;
90my %extcmd;
91 169
92############################################################################# 170=over 4
93# utility functions 171
172=item dumpval $ref
173
174=cut
175
176sub dumpval {
177 eval {
178 local $SIG{__DIE__};
179 my $d;
180 if (1) {
181 $d = new Data::Dumper([$_[0]], ["*var"]);
182 $d->Terse(1);
183 $d->Indent(2);
184 $d->Quotekeys(0);
185 $d->Useqq(1);
186 #$d->Bless(...);
187 $d->Seen($_[1]) if @_ > 1;
188 $d = $d->Dump();
189 }
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d
192 } || "[unable to dump $_[0]: '$@']";
193}
94 194
95use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json
198
199Converts a JSON string into the corresponding perl data structure.
200
201=cut
96 202
97sub from_json($) { 203sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 205 JSON::Syck::Load $_[0]
100} 206}
101 207
208=item $json = cf::to_json $ref
209
210Converts a perl data structure into its JSON representation.
211
212=cut
213
102sub to_json($) { 214sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 216 JSON::Syck::Dump $_[0]
105} 217}
106 218
219=item cf::lock_wait $string
220
221Wait until the given lock is available. See cf::lock_acquire.
222
223=item my $lock = cf::lock_acquire $string
224
225Wait until the given lock is available and then acquires it and returns
226a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227for example when the coroutine gets canceled), the lock is automatically
228returned.
229
230Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load).
232
233=cut
234
235our %LOCK;
236
237sub lock_wait($) {
238 my ($key) = @_;
239
240 # wait for lock, if any
241 while ($LOCK{$key}) {
242 push @{ $LOCK{$key} }, $Coro::current;
243 Coro::schedule;
244 }
245}
246
247sub lock_acquire($) {
248 my ($key) = @_;
249
250 # wait, to be sure we are not locked
251 lock_wait $key;
252
253 $LOCK{$key} = [];
254
255 Coro::guard {
256 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} };
258 }
259}
260
261sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active;
263
264 my $guard = Coro::guard {
265 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop;
270 $guard
271}
272
273=item cf::async { BLOCK }
274
275Currently the same as Coro::async_pool, meaning you cannot use
276C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
277thing you are allowed to do is call C<prio> on it.
278
279=cut
280
281BEGIN { *async = \&Coro::async_pool }
282
283=item cf::sync_job { BLOCK }
284
285The design of crossfire+ requires that the main coro ($Coro::main) is
286always able to handle events or runnable, as crossfire+ is only partly
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
288
289If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish
292fast or be very important.
293
294=cut
295
296sub sync_job(&) {
297 my ($job) = @_;
298
299 if ($Coro::current == $Coro::main) {
300 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/
302
303 # TODO: use suspend/resume instead
304 # (but this is cancel-safe)
305 my $freeze_guard = freeze_mainloop;
306
307 my $busy = 1;
308 my @res;
309
310 (async {
311 @res = eval { $job->() };
312 warn $@ if $@;
313 undef $busy;
314 })->prio (Coro::PRIO_MAX);
315
316 while ($busy) {
317 Coro::cede or Event::one_event;
318 }
319
320 wantarray ? @res : $res[0]
321 } else {
322 # we are in another coroutine, how wonderful, everything just works
323
324 $job->()
325 }
326}
327
328=item $coro = cf::async_ext { BLOCK }
329
330Like async, but this coro is automatically being canceled when the
331extension calling this is being unloaded.
332
333=cut
334
335sub async_ext(&) {
336 my $cb = shift;
337
338 my $coro = &Coro::async ($cb);
339
340 $coro->on_destroy (sub {
341 delete $EXT_CORO{$coro+0};
342 });
343 $EXT_CORO{$coro+0} = $coro;
344
345 $coro
346}
347
348sub write_runtime {
349 my $runtime = cf::localdir . "/runtime";
350
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
352 or return;
353
354 my $value = $cf::RUNTIME + 90 + 10;
355 # 10 is the runtime save interval, for a monotonic clock
356 # 60 allows for the watchdog to kill the server.
357
358 (aio_write $fh, 0, (length $value), $value, 0) <= 0
359 and return;
360
361 aio_fsync $fh
362 and return;
363
364 close $fh
365 or return;
366
367 aio_rename "$runtime~", $runtime
368 and return;
369
370 1
371}
372
373=back
374
375=cut
376
107############################################################################# 377#############################################################################
108# "new" plug-in system
109 378
110=item $object->attach ($attachment, key => $value...) 379=head2 ATTACHABLE OBJECTS
111 380
112=item $object->detach ($attachment) 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
114Attach/detach a pre-registered attachment to an object. 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
116=item $player->attach ($attachment, key => $value...) 389=over 4
117 390
118=item $player->detach ($attachment)
119
120Attach/detach a pre-registered attachment to a player.
121
122=item $map->attach ($attachment, key => $value...) 391=item $attachable->attach ($attachment, key => $value...)
123 392
124=item $map->detach ($attachment) 393=item $attachable->detach ($attachment)
125 394
126Attach/detach a pre-registered attachment to a map. 395Attach/detach a pre-registered attachment to a specific object and give it
396the specified key/value pairs as arguments.
127 397
128=item cf::attach_global ... 398Example, attach a minesweeper attachment to the given object, making it a
39910x10 minesweeper game:
129 400
130Attach handlers for global events. 401 $obj->attach (minesweeper => width => 10, height => 10);
131 402
132This and all following C<attach_*>-functions expect any number of the 403=item $bool = $attachable->attached ($name)
133following handler/hook descriptions: 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:
134 445
135=over 4 446=over 4
136 447
137=item prio => $number 448=item prio => $number
138 449
140by another C<prio> setting). Lower priority handlers get executed 451by another C<prio> setting). Lower priority handlers get executed
141earlier. 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
142registered at priority C<-1000>, so lower priorities should not be used 453registered at priority C<-1000>, so lower priorities should not be used
143unless you know what you are doing. 454unless you know what you are doing.
144 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
145=item on_I<event> => \&cb 462=item on_I<event> => \&cb
146 463
147Call the given code reference whenever the named event happens (event is 464Call the given code reference whenever the named event happens (event is
148something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 465something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
149handlers are recognised generally depends on the type of object these 466handlers are recognised generally depends on the type of object these
158package and register them. Only handlers for eevents supported by the 475package and register them. Only handlers for eevents supported by the
159object/class are recognised. 476object/class are recognised.
160 477
161=back 478=back
162 479
163=item cf::attach_to_type $object_type, $subtype, ... 480Example, define an attachment called "sockpuppet" that calls the given
481event handler when a monster attacks:
164 482
165Attach handlers for a specific object type (e.g. TRANSPORT) and 483 cf::object::attachment sockpuppet =>
166subtype. If C<$subtype> is zero or undef, matches all objects of the given 484 on_skill_attack => sub {
167type. 485 my ($self, $victim) = @_;
486 ...
487 }
488 }
168 489
169=item cf::attach_to_objects ... 490=item $attachable->valid
170 491
171Attach 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
172very 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
173the game. 494valid C counterpart anymore you get an exception at runtime. This method
174 495can be used to test for existence of the C object part without causing an
175=item cf::attach_to_players ... 496exception.
176
177Attach handlers to all players.
178
179=item cf::attach_to_maps ...
180
181Attach handlers to all maps.
182
183=item cf:register_attachment $name, ...
184
185Register an attachment by name through which objects can refer to this
186attachment.
187
188=item cf:register_map_attachment $name, ...
189
190Register an attachment by name through which maps can refer to this
191attachment.
192 497
193=cut 498=cut
194 499
195# 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
196our @CB_GLOBAL = (); # registry for all global events 501our @CB_GLOBAL = (); # registry for all global events
502our @CB_ATTACHABLE = (); # registry for all attachables
197our @CB_OBJECT = (); # all objects (should not be used except in emergency) 503our @CB_OBJECT = (); # all objects (should not be used except in emergency)
198our @CB_PLAYER = (); 504our @CB_PLAYER = ();
505our @CB_CLIENT = ();
199our @CB_TYPE = (); # registry for type (cf-object class) based events 506our @CB_TYPE = (); # registry for type (cf-object class) based events
200our @CB_MAP = (); 507our @CB_MAP = ();
201 508
202my %attachment; 509my %attachment;
203 510
511sub cf::attachable::thawer_merge {
512 # simply override everything except _meta
513 local $_[0]{_meta};
514 %{$_[0]} = %{$_[1]};
515}
516
204sub _attach_cb($\%$$$) { 517sub _attach_cb($$$$) {
205 my ($registry, $undo, $event, $prio, $cb) = @_; 518 my ($registry, $event, $prio, $cb) = @_;
206 519
207 use sort 'stable'; 520 use sort 'stable';
208 521
209 $cb = [$prio, $cb]; 522 $cb = [$prio, $cb];
210 523
211 @{$registry->[$event]} = sort 524 @{$registry->[$event]} = sort
212 { $a->[0] cmp $b->[0] } 525 { $a->[0] cmp $b->[0] }
213 @{$registry->[$event] || []}, $cb; 526 @{$registry->[$event] || []}, $cb;
214
215 push @{$undo->{cb}}, [$event, $cb];
216} 527}
528
529# hack
530my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
217 531
218# attach handles attaching event callbacks 532# attach handles attaching event callbacks
219# 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
220# registry (== where the callback attaches to). 534# registry (== where the callback attaches to).
221sub _attach(\@$@) { 535sub _attach {
222 my ($registry, $klass, @arg) = @_; 536 my ($registry, $klass, @arg) = @_;
223 537
538 my $object_type;
224 my $prio = 0; 539 my $prio = 0;
225
226 my %undo = (
227 registry => $registry,
228 cb => [],
229 );
230
231 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 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 }
232 546
233 while (@arg) { 547 while (@arg) {
234 my $type = shift @arg; 548 my $type = shift @arg;
235 549
236 if ($type eq "prio") { 550 if ($type eq "prio") {
237 $prio = shift @arg; 551 $prio = shift @arg;
238 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
239 } elsif ($type eq "package") { 562 } elsif ($type eq "package") {
240 my $pkg = shift @arg; 563 my $pkg = shift @arg;
241 564
242 while (my ($name, $id) = each %cb_id) { 565 while (my ($name, $id) = each %cb_id) {
243 if (my $cb = $pkg->can ($name)) { 566 if (my $cb = $pkg->can ($name)) {
244 _attach_cb $registry, %undo, $id, $prio, $cb; 567 _attach_cb $registry, $id, $prio, $cb;
245 } 568 }
246 } 569 }
247 570
248 } elsif (exists $cb_id{$type}) { 571 } elsif (exists $cb_id{$type}) {
249 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 572 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
250 573
251 } elsif (ref $type) { 574 } elsif (ref $type) {
252 warn "attaching objects not supported, ignoring.\n"; 575 warn "attaching objects not supported, ignoring.\n";
253 576
254 } else { 577 } else {
255 shift @arg; 578 shift @arg;
256 warn "attach argument '$type' not supported, ignoring.\n"; 579 warn "attach argument '$type' not supported, ignoring.\n";
257 } 580 }
258 } 581 }
259
260 \%undo
261} 582}
262 583
263sub _attach_attachment { 584sub _object_attach {
264 my ($obj, $name, %arg) = @_; 585 my ($obj, $name, %arg) = @_;
265 586
266 my $res; 587 return if exists $obj->{_attachment}{$name};
267 588
268 if (my $attach = $attachment{$name}) { 589 if (my $attach = $attachment{$name}) {
269 my $registry = $obj->registry; 590 my $registry = $obj->registry;
270 591
271 for (@$attach) { 592 for (@$attach) {
272 my ($klass, @attach) = @$_; 593 my ($klass, @attach) = @$_;
273 $res = _attach @$registry, $klass, @attach; 594 _attach $registry, $klass, @attach;
274 } 595 }
275 596
276 $obj->{$name} = \%arg; 597 $obj->{$name} = \%arg;
277 } else { 598 } else {
278 warn "object uses attachment '$name' that is not available, postponing.\n"; 599 warn "object uses attachment '$name' that is not available, postponing.\n";
279 } 600 }
280 601
281 $obj->{_attachment}{$name} = undef; 602 $obj->{_attachment}{$name} = undef;
282
283 $res->{attachment} = $name;
284 $res
285} 603}
286 604
287sub cf::object::attach { 605sub cf::attachable::attach {
288 my ($obj, $name, %arg) = @_; 606 if (ref $_[0]) {
607 _object_attach @_;
608 } else {
609 _attach shift->_attach_registry, @_;
610 }
611};
289 612
290 _attach_attachment $obj, $name, %arg; 613# all those should be optimised
291}
292
293sub cf::player::attach {
294 my ($obj, $name, %arg) = @_;
295
296 _attach_attachment $obj, $name, %arg;
297}
298
299sub cf::map::attach {
300 my ($obj, $name, %arg) = @_;
301
302 _attach_attachment $obj, $name, %arg;
303}
304
305sub cf::object::detach { 614sub cf::attachable::detach {
306 my ($obj, $name) = @_; 615 my ($obj, $name) = @_;
307 die;#d# 616
308} 617 if (ref $obj) {
309sub cf::player::detach { 618 delete $obj->{_attachment}{$name};
619 reattach ($obj);
620 } else {
621 Carp::croak "cannot, currently, detach class attachments";
622 }
623};
624
625sub cf::attachable::attached {
310 my ($obj, $name) = @_; 626 my ($obj, $name) = @_;
311 die;#d#
312}
313sub cf::map::detach {
314 my ($obj, $name) = @_;
315 die;#d#
316}
317 627
318sub attach_global { 628 exists $obj->{_attachment}{$name}
319 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
320} 629}
321 630
322sub attach_to_type { 631for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
323 my $type = shift; 632 eval "#line " . __LINE__ . " 'cf.pm'
324 my $subtype = shift; 633 sub cf::\L$klass\E::_attach_registry {
634 (\\\@CB_$klass, KLASS_$klass)
635 }
325 636
326 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ 637 sub cf::\L$klass\E::attachment {
327}
328
329sub attach_to_objects {
330 _attach @CB_OBJECT, KLASS_OBJECT, @_
331}
332
333sub attach_to_players {
334 _attach @CB_PLAYER, KLASS_PLAYER, @_
335}
336
337sub attach_to_maps {
338 _attach @CB_MAP, KLASS_MAP, @_
339}
340
341sub register_attachment {
342 my $name = shift; 638 my \$name = shift;
343 639
344 $attachment{$name} = [[KLASS_OBJECT, @_]];
345}
346
347sub register_map_attachment {
348 my $name = shift;
349
350 $attachment{$name} = [[KLASS_MAP, @_]]; 640 \$attachment{\$name} = [[KLASS_$klass, \@_]];
641 }
642 ";
643 die if $@;
351} 644}
352 645
353our $override; 646our $override;
354our @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?
355 648
369 for (@$callbacks) { 662 for (@$callbacks) {
370 eval { &{$_->[1]} }; 663 eval { &{$_->[1]} };
371 664
372 if ($@) { 665 if ($@) {
373 warn "$@"; 666 warn "$@";
374 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 667 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
375 override; 668 override;
376 } 669 }
377 670
378 return 1 if $override; 671 return 1 if $override;
379 } 672 }
380 673
381 0 674 0
382} 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
383 690
384############################################################################# 691#############################################################################
385# object support 692# object support
386 693
387sub instantiate {
388 my ($obj, $data) = @_;
389
390 $data = from_json $data;
391
392 for (@$data) {
393 my ($name, $args) = @$_;
394
395 $obj->attach ($name, %{$args || {} });
396 }
397}
398
399# basically do the same as instantiate, without calling instantiate
400sub reattach { 694sub reattach {
695 # basically do the same as instantiate, without calling instantiate
401 my ($obj) = @_; 696 my ($obj) = @_;
697
698 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
699
402 my $registry = $obj->registry; 700 my $registry = $obj->registry;
403 701
404 @$registry = (); 702 @$registry = ();
405 703
406 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 704 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
407 705
408 for my $name (keys %{ $obj->{_attachment} || {} }) { 706 for my $name (keys %{ $obj->{_attachment} || {} }) {
409 if (my $attach = $attachment{$name}) { 707 if (my $attach = $attachment{$name}) {
410 for (@$attach) { 708 for (@$attach) {
411 my ($klass, @attach) = @$_; 709 my ($klass, @attach) = @$_;
412 _attach @$registry, $klass, @attach; 710 _attach $registry, $klass, @attach;
413 } 711 }
414 } else { 712 } else {
415 warn "object uses attachment '$name' that is not available, postponing.\n"; 713 warn "object uses attachment '$name' that is not available, postponing.\n";
416 } 714 }
417 } 715 }
418} 716}
419 717
420sub object_freezer_save { 718cf::attachable->attach (
421 my ($filename, $objs) = @_;
422
423 if (@$objs) {
424 open my $fh, ">:raw", "$filename.pst~";
425 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
426 close $fh;
427 chmod SAVE_MODE, "$filename.pst~";
428 rename "$filename.pst~", "$filename.pst";
429 } else {
430 unlink "$filename.pst";
431 }
432
433 chmod SAVE_MODE, "$filename~";
434 rename "$filename~", $filename;
435}
436
437sub object_thawer_load {
438 my ($filename) = @_;
439
440 open my $fh, "<:raw:perlio", "$filename.pst"
441 or return;
442
443 eval { local $/; (Storable::thaw <$fh>)->{objs} }
444}
445
446attach_to_objects
447 prio => -1000000, 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,
448 on_clone => sub { 732 on_clone => sub {
449 my ($src, $dst) = @_; 733 my ($src, $dst) = @_;
450 734
451 @{$dst->registry} = @{$src->registry}; 735 @{$dst->registry} = @{$src->registry};
452 736
453 %$dst = %$src; 737 %$dst = %$src;
454 738
455 %{$dst->{_attachment}} = %{$src->{_attachment}} 739 %{$dst->{_attachment}} = %{$src->{_attachment}}
456 if exists $src->{_attachment}; 740 if exists $src->{_attachment};
457 }, 741 },
458; 742);
743
744sub object_freezer_save {
745 my ($filename, $rdata, $objs) = @_;
746
747 sync_job {
748 if (length $$rdata) {
749 warn sprintf "saving %s (%d,%d)\n",
750 $filename, length $$rdata, scalar @$objs;
751
752 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753 chmod SAVE_MODE, $fh;
754 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755 aio_fsync $fh;
756 close $fh;
757
758 if (@$objs) {
759 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760 chmod SAVE_MODE, $fh;
761 my $data = Storable::nfreeze { version => 1, objs => $objs };
762 aio_write $fh, 0, (length $data), $data, 0;
763 aio_fsync $fh;
764 close $fh;
765 aio_rename "$filename.pst~", "$filename.pst";
766 }
767 } else {
768 aio_unlink "$filename.pst";
769 }
770
771 aio_rename "$filename~", $filename;
772 } else {
773 warn "FATAL: $filename~: $!\n";
774 }
775 } else {
776 aio_unlink $filename;
777 aio_unlink "$filename.pst";
778 }
779 }
780}
781
782sub object_freezer_as_string {
783 my ($rdata, $objs) = @_;
784
785 use Data::Dumper;
786
787 $$rdata . Dumper $objs
788}
789
790sub object_thawer_load {
791 my ($filename) = @_;
792
793 my ($data, $av);
794
795 (aio_load $filename, $data) >= 0
796 or return;
797
798 unless (aio_stat "$filename.pst") {
799 (aio_load "$filename.pst", $av) >= 0
800 or return;
801 $av = eval { (Storable::thaw $av)->{objs} };
802 }
803
804 warn sprintf "loading %s (%d)\n",
805 $filename, length $data, scalar @{$av || []};#d#
806 return ($data, $av);
807}
459 808
460############################################################################# 809#############################################################################
461# old plug-in events 810# command handling &c
462 811
463sub inject_event { 812=item cf::register_command $name => \&callback($ob,$args);
464 my $extension = shift;
465 my $event_code = shift;
466 813
467 my $cb = $hook[$event_code]{$extension} 814Register a callback for execution when the client sends the user command
468 or return; 815$name.
469 816
470 &$cb 817=cut
471}
472
473sub inject_global_event {
474 my $event = shift;
475
476 my $cb = $hook[$event]
477 or return;
478
479 List::Util::max map &$_, values %$cb
480}
481
482sub inject_command {
483 my ($name, $obj, $params) = @_;
484
485 for my $cmd (@{ $command{$name} }) {
486 $cmd->[1]->($obj, $params);
487 }
488
489 -1
490}
491 818
492sub register_command { 819sub register_command {
493 my ($name, $time, $cb) = @_; 820 my ($name, $cb) = @_;
494 821
495 my $caller = caller; 822 my $caller = caller;
496 #warn "registering command '$name/$time' to '$caller'"; 823 #warn "registering command '$name/$time' to '$caller'";
497 824
498 push @{ $command{$name} }, [$time, $cb, $caller]; 825 push @{ $COMMAND{$name} }, [$caller, $cb];
499 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
500} 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
501 836
502sub register_extcmd { 837sub register_extcmd {
503 my ($name, $cb) = @_; 838 my ($name, $cb) = @_;
504 839
505 my $caller = caller; 840 $EXTCMD{$name} = $cb;
506 #warn "registering extcmd '$name' to '$caller'";
507
508 $extcmd{$name} = [$cb, $caller];
509} 841}
510 842
511sub register { 843cf::player->attach (
512 my ($base, $pkg) = @_; 844 on_command => sub {
845 my ($pl, $name, $params) = @_;
513 846
514 #TODO 847 my $cb = $COMMAND{$name}
515} 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);
516 874
517sub load_extension { 875sub load_extension {
518 my ($path) = @_; 876 my ($path) = @_;
519 877
520 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
521 my $base = $1; 879 my $base = $1;
522 my $pkg = $1; 880 my $pkg = $1;
523 $pkg =~ s/[^[:word:]]/_/g; 881 $pkg =~ s/[^[:word:]]/_/g;
524 $pkg = "ext::$pkg"; 882 $pkg = "ext::$pkg";
525 883
526 warn "loading '$path' into '$pkg'\n"; 884 warn "... loading '$path' into '$pkg'\n";
527 885
528 open my $fh, "<:utf8", $path 886 open my $fh, "<:utf8", $path
529 or die "$path: $!"; 887 or die "$path: $!";
530 888
531 my $source = 889 my $source =
532 "package $pkg; use strict; use utf8;\n" 890 "package $pkg; use strict; use utf8;\n"
533 . "#line 1 \"$path\"\n{\n" 891 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> }) 892 . (do { local $/; <$fh> })
535 . "\n};\n1"; 893 . "\n};\n1";
536 894
537 eval $source 895 unless (eval $source) {
538 or die "$path: $@"; 896 my $msg = $@ ? "$path: $@\n"
539 897 : "extension disabled.\n";
540 push @exts, $pkg; 898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
541 $ext_pkg{$base} = $pkg; 899 warn $@;
542 900 warn "mandatory extension failed to load, exiting.\n";
543# no strict 'refs'; 901 exit 1;
544# @{"$pkg\::ISA"} = ext::; 902 }
545 903 die $@;
546 register $base, $pkg;
547}
548
549sub unload_extension {
550 my ($pkg) = @_;
551
552 warn "removing extension $pkg\n";
553
554 # remove hooks
555 #TODO
556# for my $idx (0 .. $#PLUGIN_EVENT) {
557# delete $hook[$idx]{$pkg};
558# } 904 }
559 905
560 # remove commands 906 push @EXTS, $pkg;
561 for my $name (keys %command) {
562 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
563
564 if (@cb) {
565 $command{$name} = \@cb;
566 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
567 } else {
568 delete $command{$name};
569 delete $COMMAND{"$name\000"};
570 }
571 }
572
573 # remove extcmds
574 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
575 delete $extcmd{$name};
576 }
577
578 if (my $cb = $pkg->can ("unload")) {
579 eval {
580 $cb->($pkg);
581 1
582 } or warn "$pkg unloaded, but with errors: $@";
583 }
584
585 Symbol::delete_package $pkg;
586} 907}
587 908
588sub load_extensions { 909sub load_extensions {
589 my $LIBDIR = maps_directory "perl";
590
591 for my $ext (<$LIBDIR/*.ext>) { 910 for my $ext (<$LIBDIR/*.ext>) {
592 next unless -r $ext; 911 next unless -r $ext;
593 eval { 912 eval {
594 load_extension $ext; 913 load_extension $ext;
595 1 914 1
596 } or warn "$ext not loaded: $@"; 915 } or warn "$ext not loaded: $@";
597 } 916 }
598} 917}
599 918
600sub _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 {
601 my ($msg) = @_; 1442 my ($map) = @_;
602 1443
603 $msg->("reloading..."); 1444 my @diag; # diagonal neighbours
604 1445
605 eval { 1446 for (0 .. 3) {
606 # 1. cancel all watchers 1447 my $neigh = $map->tile_path ($_)
607 $_->cancel for Event::all_watchers; 1448 or next;
1449 $neigh = find $neigh, $map
1450 or next;
1451 $neigh->load;
608 1452
609 # 2. unload all extensions 1453 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
610 for (@exts) { 1454 [$neigh->tile_path (($_ + 1) % 4), $neigh];
611 $msg->("unloading <$_>"); 1455 }
612 unload_extension $_;
613 }
614 1456
615 # 3. unload all modules loaded from $LIBDIR 1457 for (@diag) {
616 while (my ($k, $v) = each %INC) { 1458 my $neigh = find @$_
617 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1459 or next;
1460 $neigh->load;
1461 }
1462}
618 1463
619 $msg->("removing <$k>"); 1464sub find_sync {
620 delete $INC{$k}; 1465 my ($path, $origin) = @_;
621 1466
622 $k =~ s/\.pm$//; 1467 cf::sync_job { find $path, $origin }
623 $k =~ s/\//::/g; 1468}
624 1469
625 if (my $cb = $k->can ("unload_module")) { 1470sub do_load_sync {
626 $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};
627 } 1497 }
628
629 Symbol::delete_package $k;
630 }
631
632 # 4. get rid of safe::, as good as possible
633 Symbol::delete_package "safe::$_"
634 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
635
636 # 5. remove register_script_function callbacks
637 # TODO
638 1498 }
639 # 6. unload cf.pm "a bit" 1499 undef $MAP_PREFETCHER;
640 delete $INC{"cf.pm"};
641
642 # don't, removes xs symbols, too,
643 # and global variables created in xs
644 #Symbol::delete_package __PACKAGE__;
645
646 # 7. reload cf.pm
647 $msg->("reloading cf.pm");
648 require cf;
649 }; 1500 };
650 $msg->($@) if $@; 1501 $MAP_PREFETCHER->prio (6);
651 1502
652 $msg->("reloaded"); 1503 ()
653}; 1504}
654 1505
655sub perl_reload() { 1506sub save {
656 _perl_reload { 1507 my ($self) = @_;
657 warn $_[0]; 1508
658 print "$_[0]\n"; 1509 my $lock = cf::lock_acquire "map_data:" . $self->path;
1510
1511 $self->{last_save} = $cf::RUNTIME;
1512
1513 return unless $self->dirty;
1514
1515 my $save = $self->save_path; utf8::encode $save;
1516 my $uniq = $self->uniq_path; utf8::encode $uniq;
1517
1518 $self->{load_path} = $save;
1519
1520 return if $self->{deny_save};
1521
1522 local $self->{last_access} = $self->last_access;#d#
1523
1524 cf::async {
1525 $_->contr->save for $self->players;
659 }; 1526 };
660}
661 1527
662register_command "perl-reload", 0, sub { 1528 if ($uniq) {
663 my ($who, $arg) = @_; 1529 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
664 1530 $self->_save_objects ($uniq, cf::IO_UNIQUES);
665 if ($who->flag (FLAG_WIZ)) {
666 _perl_reload {
667 warn $_[0];
668 $who->message ($_[0]);
669 };
670 }
671};
672
673#############################################################################
674# extcmd framework, basically convert ext <msg>
675# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
676
677attach_to_players
678 on_extcmd => sub {
679 my ($pl, $buf) = @_;
680
681 my $msg = eval { from_json $buf };
682
683 if (ref $msg) {
684 if (my $cb = $extcmd{$msg->{msgtype}}) {
685 if (my %reply = $cb->[0]->($pl, $msg)) {
686 $pl->ext_reply ($msg->{msgid}, %reply);
687 }
688 }
689 } else { 1531 } else {
690 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1532 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
691 }
692
693 cf::override;
694 }, 1533 }
695; 1534}
696 1535
697############################################################################# 1536sub swap_out {
698# load/save/clean perl data associated with a map
699
700*cf::mapsupport::on_clean = sub {
701 my ($map) = @_; 1537 my ($self) = @_;
702 1538
703 my $path = $map->tmpname; 1539 # save first because save cedes
704 defined $path or return; 1540 $self->save;
705 1541
706 unlink "$path.pst"; 1542 my $lock = cf::lock_acquire "map_data:" . $self->path;
707};
708 1543
709# old style persistent data, TODO: remove #d# 1544 return if $self->players;
710*cf::mapsupport::on_swapin = 1545 return if $self->in_memory != cf::MAP_IN_MEMORY;
711*cf::mapsupport::on_load = sub { 1546 return if $self->{deny_save};
1547
1548 $self->clear;
1549 $self->in_memory (cf::MAP_SWAPPED);
1550}
1551
1552sub reset_at {
712 my ($map) = @_; 1553 my ($self) = @_;
713 1554
714 my $path = $map->tmpname; 1555 # TODO: safety, remove and allow resettable per-player maps
715 $path = $map->path unless defined $path; 1556 return 1e99 if $self->isa ("ext::map_per_player");#d#
1557 return 1e99 if $self->{deny_reset};
716 1558
717 open my $fh, "<:raw", "$path.cfperl" 1559 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
718 or return; # no perl data 1560 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
719 1561
720 my $data = Storable::thaw do { local $/; <$fh> }; 1562 $time + $to
1563}
721 1564
722 $data->{version} <= 1 1565sub should_reset {
1566 my ($self) = @_;
1567
1568 $self->reset_at <= $cf::RUNTIME
1569}
1570
1571sub reset {
1572 my ($self) = @_;
1573
1574 my $lock = cf::lock_acquire "map_data:$self->{path}";
1575
1576 return if $self->players;
1577 return if $self->isa ("ext::map_per_player");#d#
1578
1579 warn "resetting map ", $self->path;#d#
1580
1581 delete $cf::MAP{$self->path};
1582
1583 $self->in_memory (cf::MAP_SWAPPED);
1584 $self->clear;
1585
1586 $_->clear_links_to ($self) for values %cf::MAP;
1587
1588 $self->unlink_save;
1589 $self->destroy;
1590}
1591
1592my $nuke_counter = "aaaa";
1593
1594sub nuke {
1595 my ($self) = @_;
1596
1597 delete $cf::MAP{$self->path};
1598
1599 $self->unlink_save;
1600
1601 bless $self, "cf::map";
1602 delete $self->{deny_reset};
1603 $self->{deny_save} = 1;
1604 $self->reset_timeout (1);
1605 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1606
1607 $cf::MAP{$self->path} = $self;
1608
1609 $self->reset; # polite request, might not happen
1610}
1611
1612=item cf::map::unique_maps
1613
1614Returns an arrayref of paths of all shared maps that have
1615instantiated unique items. May block.
1616
1617=cut
1618
1619sub unique_maps() {
1620 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
723 or return; # too new 1621 or return;
724 1622
725 $map->_set_obs ($data->{obs}); 1623 my @paths;
726 $map->invoke (EVENT_MAP_UPGRADE);
727};
728 1624
729attach_to_maps prio => -10000, package => cf::mapsupport::; 1625 for (@$files) {
1626 utf8::decode $_;
1627 next if /\.pst$/;
1628 next unless /^$PATH_SEP/o;
730 1629
731############################################################################# 1630 s/\.map$//;
732# load/save perl data associated with player->ob objects 1631 push @paths, $_;
733
734sub all_objects(@) {
735 @_, map all_objects ($_->inv), @_
736}
737
738attach_to_players
739 on_load => sub {
740 my ($pl, $path) = @_;
741
742 for my $o (all_objects $pl->ob) {
743 if (my $value = $o->get_ob_key_value ("_perl_data")) {
744 $o->set_ob_key_value ("_perl_data");
745
746 %$o = %{ Storable::thaw pack "H*", $value };
747 }
748 }
749 }, 1632 }
750;
751 1633
752############################################################################# 1634 \@paths
753# core extensions - in perl
754
755=item cf::player::exists $login
756
757Returns true when the given account exists.
758
759=cut
760
761sub cf::player::exists($) {
762 cf::player::find $_[0]
763 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
764} 1635}
765 1636
1637package cf;
1638
1639=back
1640
1641=head3 cf::object
1642
1643=cut
1644
1645package cf::object;
1646
1647=over 4
1648
1649=item $ob->inv_recursive
1650
1651Returns the inventory of the object _and_ their inventories, recursively.
1652
1653=cut
1654
1655sub inv_recursive_;
1656sub inv_recursive_ {
1657 map { $_, inv_recursive_ $_->inv } @_
1658}
1659
1660sub inv_recursive {
1661 inv_recursive_ inv $_[0]
1662}
1663
1664package cf;
1665
1666=back
1667
1668=head3 cf::object::player
1669
1670=over 4
1671
766=item $player->reply ($npc, $msg[, $flags]) 1672=item $player_object->reply ($npc, $msg[, $flags])
767 1673
768Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1674Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
769can be C<undef>. Does the right thing when the player is currently in a 1675can be C<undef>. Does the right thing when the player is currently in a
770dialogue with the given NPC character. 1676dialogue with the given NPC character.
771 1677
772=cut 1678=cut
773 1679
774# rough implementation of a future "reply" method that works 1680# rough implementation of a future "reply" method that works
775# with dialog boxes. 1681# with dialog boxes.
1682#TODO: the first argument must go, split into a $npc->reply_to ( method
776sub cf::object::player::reply($$$;$) { 1683sub cf::object::player::reply($$$;$) {
777 my ($self, $npc, $msg, $flags) = @_; 1684 my ($self, $npc, $msg, $flags) = @_;
778 1685
779 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1686 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
780 1687
784 $msg = $npc->name . " says: $msg" if $npc; 1691 $msg = $npc->name . " says: $msg" if $npc;
785 $self->message ($msg, $flags); 1692 $self->message ($msg, $flags);
786 } 1693 }
787} 1694}
788 1695
789=item $player->ext_reply ($msgid, $msgtype, %msg) 1696=item $player_object->may ("access")
790 1697
791Sends an ext reply to the player. 1698Returns wether the given player is authorized to access resource "access"
1699(e.g. "command_wizcast").
792 1700
793=cut 1701=cut
794 1702
795sub cf::player::ext_reply($$$%) { 1703sub cf::object::player::may {
1704 my ($self, $access) = @_;
1705
1706 $self->flag (cf::FLAG_WIZ) ||
1707 (ref $cf::CFG{"may_$access"}
1708 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1709 : $cf::CFG{"may_$access"})
1710}
1711
1712=item $player_object->enter_link
1713
1714Freezes the player and moves him/her to a special map (C<{link}>).
1715
1716The player should be reasonably safe there for short amounts of time. You
1717I<MUST> call C<leave_link> as soon as possible, though.
1718
1719Will never block.
1720
1721=item $player_object->leave_link ($map, $x, $y)
1722
1723Moves the player out of the special C<{link}> map onto the specified
1724map. If the map is not valid (or omitted), the player will be moved back
1725to the location he/she was before the call to C<enter_link>, or, if that
1726fails, to the emergency map position.
1727
1728Might block.
1729
1730=cut
1731
1732sub link_map {
1733 unless ($LINK_MAP) {
1734 $LINK_MAP = cf::map::find "{link}"
1735 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1736 $LINK_MAP->load;
1737 }
1738
1739 $LINK_MAP
1740}
1741
1742sub cf::object::player::enter_link {
1743 my ($self) = @_;
1744
1745 $self->deactivate_recursive;
1746
1747 return if UNIVERSAL::isa $self->map, "ext::map_link";
1748
1749 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1750 if $self->map;
1751
1752 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1753}
1754
1755sub cf::object::player::leave_link {
1756 my ($self, $map, $x, $y) = @_;
1757
1758 my $link_pos = delete $self->{_link_pos};
1759
1760 unless ($map) {
1761 # restore original map position
1762 ($map, $x, $y) = @{ $link_pos || [] };
1763 $map = cf::map::find $map;
1764
1765 unless ($map) {
1766 ($map, $x, $y) = @$EMERGENCY_POSITION;
1767 $map = cf::map::find $map
1768 or die "FATAL: cannot load emergency map\n";
1769 }
1770 }
1771
1772 ($x, $y) = (-1, -1)
1773 unless (defined $x) && (defined $y);
1774
1775 # use -1 or undef as default coordinates, not 0, 0
1776 ($x, $y) = ($map->enter_x, $map->enter_y)
1777 if $x <=0 && $y <= 0;
1778
1779 $map->load;
1780 $map->load_diag;
1781
1782 return unless $self->contr->active;
1783 $self->activate_recursive;
1784 $self->enter_map ($map, $x, $y);
1785}
1786
1787cf::player->attach (
1788 on_logout => sub {
1789 my ($pl) = @_;
1790
1791 # abort map switching before logout
1792 if ($pl->ob->{_link_pos}) {
1793 cf::sync_job {
1794 $pl->ob->leave_link
1795 };
1796 }
1797 },
1798 on_login => sub {
1799 my ($pl) = @_;
1800
1801 # try to abort aborted map switching on player login :)
1802 # should happen only on crashes
1803 if ($pl->ob->{_link_pos}) {
1804 $pl->ob->enter_link;
1805 (async {
1806 # we need this sleep as the login has a concurrent enter_exit running
1807 # and this sleep increases chances of the player not ending up in scorn
1808 $pl->ob->reply (undef,
1809 "There was an internal problem at your last logout, "
1810 . "the server will try to bring you to your intended destination in a second.",
1811 cf::NDI_RED);
1812 Coro::Timer::sleep 1;
1813 $pl->ob->leave_link;
1814 })->prio (2);
1815 }
1816 },
1817);
1818
1819=item $player_object->goto ($path, $x, $y)
1820
1821=cut
1822
1823sub cf::object::player::goto {
1824 my ($self, $path, $x, $y) = @_;
1825
1826 $self->enter_link;
1827
1828 (async {
1829 my $map = cf::map::find $path;
1830 $map = $map->customise_for ($self) if $map;
1831
1832# warn "entering ", $map->path, " at ($x, $y)\n"
1833# if $map;
1834
1835 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1836
1837 $self->leave_link ($map, $x, $y);
1838 })->prio (1);
1839}
1840
1841=item $player_object->enter_exit ($exit_object)
1842
1843=cut
1844
1845sub parse_random_map_params {
1846 my ($spec) = @_;
1847
1848 my $rmp = { # defaults
1849 xsize => (cf::rndm 15, 40),
1850 ysize => (cf::rndm 15, 40),
1851 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1852 #layout => string,
1853 };
1854
1855 for (split /\n/, $spec) {
1856 my ($k, $v) = split /\s+/, $_, 2;
1857
1858 $rmp->{lc $k} = $v if (length $k) && (length $v);
1859 }
1860
1861 $rmp
1862}
1863
1864sub prepare_random_map {
1865 my ($exit) = @_;
1866
1867 my $guard = cf::lock_acquire "exit_prepare:$exit";
1868
1869 # all this does is basically replace the /! path by
1870 # a new random map path (?random/...) with a seed
1871 # that depends on the exit object
1872
1873 my $rmp = parse_random_map_params $exit->msg;
1874
1875 if ($exit->map) {
1876 $rmp->{region} = $exit->map->region_name;
1877 $rmp->{origin_map} = $exit->map->path;
1878 $rmp->{origin_x} = $exit->x;
1879 $rmp->{origin_y} = $exit->y;
1880 }
1881
1882 $rmp->{random_seed} ||= $exit->random_seed;
1883
1884 my $data = cf::to_json $rmp;
1885 my $md5 = Digest::MD5::md5_hex $data;
1886 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1887
1888 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1889 aio_write $fh, 0, (length $data), $data, 0;
1890 undef $fh;
1891 aio_rename "$meta~", $meta;
1892
1893 $exit->slaying ("?random/$md5");
1894 $exit->msg (undef);
1895 }
1896}
1897
1898sub cf::object::player::enter_exit {
796 my ($self, $id, %msg) = @_; 1899 my ($self, $exit) = @_;
797 1900
798 $msg{msgid} = $id; 1901 return unless $self->type == cf::PLAYER;
799 1902
800 $self->send ("ext " . to_json \%msg); 1903 $self->enter_link;
801}
802 1904
803############################################################################# 1905 (async {
804# map scripting support 1906 $self->deactivate_recursive; # just to be sure
1907 unless (eval {
1908 prepare_random_map $exit
1909 if $exit->slaying eq "/!";
1910
1911 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1912 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1913
1914 1;
1915 }) {
1916 $self->message ("Something went wrong deep within the crossfire server. "
1917 . "I'll try to bring you back to the map you were before. "
1918 . "Please report this to the dungeon master!",
1919 cf::NDI_UNIQUE | cf::NDI_RED);
1920
1921 warn "ERROR in enter_exit: $@";
1922 $self->leave_link;
1923 }
1924 })->prio (1);
1925}
1926
1927=head3 cf::client
1928
1929=over 4
1930
1931=item $client->send_drawinfo ($text, $flags)
1932
1933Sends a drawinfo packet to the client. Circumvents output buffering so
1934should not be used under normal circumstances.
1935
1936=cut
1937
1938sub cf::client::send_drawinfo {
1939 my ($self, $text, $flags) = @_;
1940
1941 utf8::encode $text;
1942 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1943}
1944
1945
1946=item $success = $client->query ($flags, "text", \&cb)
1947
1948Queues a query to the client, calling the given callback with
1949the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1950C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1951
1952Queries can fail, so check the return code. Or don't, as queries will become
1953reliable at some point in the future.
1954
1955=cut
1956
1957sub cf::client::query {
1958 my ($self, $flags, $text, $cb) = @_;
1959
1960 return unless $self->state == ST_PLAYING
1961 || $self->state == ST_SETUP
1962 || $self->state == ST_CUSTOM;
1963
1964 $self->state (ST_CUSTOM);
1965
1966 utf8::encode $text;
1967 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1968
1969 $self->send_packet ($self->{query_queue}[0][0])
1970 if @{ $self->{query_queue} } == 1;
1971}
1972
1973cf::client->attach (
1974 on_reply => sub {
1975 my ($ns, $msg) = @_;
1976
1977 # this weird shuffling is so that direct followup queries
1978 # get handled first
1979 my $queue = delete $ns->{query_queue}
1980 or return; # be conservative, not sure how that can happen, but we saw a crash here
1981
1982 (shift @$queue)->[1]->($msg);
1983
1984 push @{ $ns->{query_queue} }, @$queue;
1985
1986 if (@{ $ns->{query_queue} } == @$queue) {
1987 if (@$queue) {
1988 $ns->send_packet ($ns->{query_queue}[0][0]);
1989 } else {
1990 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1991 }
1992 }
1993 },
1994);
1995
1996=item $client->async (\&cb)
1997
1998Create a new coroutine, running the specified callback. The coroutine will
1999be automatically cancelled when the client gets destroyed (e.g. on logout,
2000or loss of connection).
2001
2002=cut
2003
2004sub cf::client::async {
2005 my ($self, $cb) = @_;
2006
2007 my $coro = &Coro::async ($cb);
2008
2009 $coro->on_destroy (sub {
2010 delete $self->{_coro}{$coro+0};
2011 });
2012
2013 $self->{_coro}{$coro+0} = $coro;
2014
2015 $coro
2016}
2017
2018cf::client->attach (
2019 on_destroy => sub {
2020 my ($ns) = @_;
2021
2022 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2023 },
2024);
2025
2026=back
2027
2028
2029=head2 SAFE SCRIPTING
2030
2031Functions that provide a safe environment to compile and execute
2032snippets of perl code without them endangering the safety of the server
2033itself. Looping constructs, I/O operators and other built-in functionality
2034is not available in the safe scripting environment, and the number of
2035functions and methods that can be called is greatly reduced.
2036
2037=cut
805 2038
806our $safe = new Safe "safe"; 2039our $safe = new Safe "safe";
807our $safe_hole = new Safe::Hole; 2040our $safe_hole = new Safe::Hole;
808 2041
809$SIG{FPE} = 'IGNORE'; 2042$SIG{FPE} = 'IGNORE';
810 2043
811$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2044$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
812 2045
813# here we export the classes and methods available to script code 2046# here we export the classes and methods available to script code
814 2047
2048=pod
2049
2050The following fucntions and emthods are available within a safe environment:
2051
2052 cf::object contr pay_amount pay_player map
2053 cf::object::player player
2054 cf::player peaceful
2055 cf::map trigger
2056
2057=cut
2058
815for ( 2059for (
816 ["cf::object" => qw(contr pay_amount pay_player)], 2060 ["cf::object" => qw(contr pay_amount pay_player map)],
817 ["cf::object::player" => qw(player)], 2061 ["cf::object::player" => qw(player)],
818 ["cf::player" => qw(peaceful)], 2062 ["cf::player" => qw(peaceful)],
2063 ["cf::map" => qw(trigger)],
819) { 2064) {
820 no strict 'refs'; 2065 no strict 'refs';
821 my ($pkg, @funs) = @$_; 2066 my ($pkg, @funs) = @$_;
822 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2067 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
823 for @funs; 2068 for @funs;
824} 2069}
2070
2071=over 4
2072
2073=item @retval = safe_eval $code, [var => value, ...]
2074
2075Compiled and executes the given perl code snippet. additional var/value
2076pairs result in temporary local (my) scalar variables of the given name
2077that are available in the code snippet. Example:
2078
2079 my $five = safe_eval '$first + $second', first => 1, second => 4;
2080
2081=cut
825 2082
826sub safe_eval($;@) { 2083sub safe_eval($;@) {
827 my ($code, %vars) = @_; 2084 my ($code, %vars) = @_;
828 2085
829 my $qcode = $code; 2086 my $qcode = $code;
852 } 2109 }
853 2110
854 wantarray ? @res : $res[0] 2111 wantarray ? @res : $res[0]
855} 2112}
856 2113
2114=item cf::register_script_function $function => $cb
2115
2116Register a function that can be called from within map/npc scripts. The
2117function should be reasonably secure and should be put into a package name
2118like the extension.
2119
2120Example: register a function that gets called whenever a map script calls
2121C<rent::overview>, as used by the C<rent> extension.
2122
2123 cf::register_script_function "rent::overview" => sub {
2124 ...
2125 };
2126
2127=cut
2128
857sub register_script_function { 2129sub register_script_function {
858 my ($fun, $cb) = @_; 2130 my ($fun, $cb) = @_;
859 2131
860 no strict 'refs'; 2132 no strict 'refs';
861 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2133 *{"safe::$fun"} = $safe_hole->wrap ($cb);
862} 2134}
863 2135
2136=back
2137
2138=cut
2139
2140#############################################################################
2141
2142=head2 EXTENSION DATABASE SUPPORT
2143
2144Crossfire maintains a very simple database for extension use. It can
2145currently store anything that can be serialised using Storable, which
2146excludes objects.
2147
2148The parameter C<$family> should best start with the name of the extension
2149using it, it should be unique.
2150
2151=over 4
2152
2153=item $hashref = cf::db_get $family
2154
2155Return a hashref for use by the extension C<$family>, which can be
2156modified. After modifications, you have to call C<cf::db_dirty> or
2157C<cf::db_sync>.
2158
2159=item $value = cf::db_get $family => $key
2160
2161Returns a single value from the database
2162
2163=item cf::db_put $family => $hashref
2164
2165Stores the given family hashref into the database. Updates are delayed, if
2166you want the data to be synced to disk immediately, use C<cf::db_sync>.
2167
2168=item cf::db_put $family => $key => $value
2169
2170Stores the given C<$value> in the family hash. Updates are delayed, if you
2171want the data to be synced to disk immediately, use C<cf::db_sync>.
2172
2173=item cf::db_dirty
2174
2175Marks the database as dirty, to be updated at a later time.
2176
2177=item cf::db_sync
2178
2179Immediately write the database to disk I<if it is dirty>.
2180
2181=cut
2182
2183our $DB;
2184
2185{
2186 my $path = cf::localdir . "/database.pst";
2187
2188 sub db_load() {
2189 $DB = stat $path ? Storable::retrieve $path : { };
2190 }
2191
2192 my $pid;
2193
2194 sub db_save() {
2195 waitpid $pid, 0 if $pid;
2196 if (0 == ($pid = fork)) {
2197 $DB->{_meta}{version} = 1;
2198 Storable::nstore $DB, "$path~";
2199 rename "$path~", $path;
2200 cf::_exit 0 if defined $pid;
2201 }
2202 }
2203
2204 my $dirty;
2205
2206 sub db_sync() {
2207 db_save if $dirty;
2208 undef $dirty;
2209 }
2210
2211 my $idle = Event->idle (
2212 reentrant => 0,
2213 min => 10,
2214 max => 20,
2215 repeat => 0,
2216 data => WF_AUTOCANCEL,
2217 cb => \&db_sync,
2218 );
2219
2220 sub db_dirty() {
2221 $dirty = 1;
2222 $idle->start;
2223 }
2224
2225 sub db_get($;$) {
2226 @_ >= 2
2227 ? $DB->{$_[0]}{$_[1]}
2228 : ($DB->{$_[0]} ||= { })
2229 }
2230
2231 sub db_put($$;$) {
2232 if (@_ >= 3) {
2233 $DB->{$_[0]}{$_[1]} = $_[2];
2234 } else {
2235 $DB->{$_[0]} = $_[1];
2236 }
2237 db_dirty;
2238 }
2239
2240 cf::global->attach (
2241 prio => 10000,
2242 on_cleanup => sub {
2243 db_sync;
2244 },
2245 );
2246}
2247
864############################################################################# 2248#############################################################################
865# the server's main() 2249# the server's main()
866 2250
2251sub cfg_load {
2252 open my $fh, "<:utf8", cf::confdir . "/config"
2253 or return;
2254
2255 local $/;
2256 *CFG = YAML::Syck::Load <$fh>;
2257
2258 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2259
2260 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2261 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2262
2263 if (exists $CFG{mlockall}) {
2264 eval {
2265 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2266 and die "WARNING: m(un)lockall failed: $!\n";
2267 };
2268 warn $@ if $@;
2269 }
2270}
2271
867sub main { 2272sub main {
2273 # we must not ever block the main coroutine
2274 local $Coro::idle = sub {
2275 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2276 (async {
2277 Event::one_event;
2278 })->prio (Coro::PRIO_MAX);
2279 };
2280
2281 cfg_load;
2282 db_load;
2283 load_extensions;
2284
2285 $TICK_WATCHER->start;
868 Event::loop; 2286 Event::loop;
869} 2287}
870 2288
871############################################################################# 2289#############################################################################
872# initialisation 2290# initialisation and cleanup
873 2291
874register "<global>", __PACKAGE__; 2292# install some emergency cleanup handlers
2293BEGIN {
2294 for my $signal (qw(INT HUP TERM)) {
2295 Event->signal (
2296 reentrant => 0,
2297 data => WF_AUTOCANCEL,
2298 signal => $signal,
2299 cb => sub {
2300 cf::cleanup "SIG$signal";
2301 },
2302 );
2303 }
2304}
2305
2306sub emergency_save() {
2307 my $freeze_guard = cf::freeze_mainloop;
2308
2309 warn "enter emergency perl save\n";
2310
2311 cf::sync_job {
2312 # use a peculiar iteration method to avoid tripping on perl
2313 # refcount bugs in for. also avoids problems with players
2314 # and maps saved/destroyed asynchronously.
2315 warn "begin emergency player save\n";
2316 for my $login (keys %cf::PLAYER) {
2317 my $pl = $cf::PLAYER{$login} or next;
2318 $pl->valid or next;
2319 $pl->save;
2320 }
2321 warn "end emergency player save\n";
2322
2323 warn "begin emergency map save\n";
2324 for my $path (keys %cf::MAP) {
2325 my $map = $cf::MAP{$path} or next;
2326 $map->valid or next;
2327 $map->save;
2328 }
2329 warn "end emergency map save\n";
2330 };
2331
2332 warn "leave emergency perl save\n";
2333}
2334
2335sub reload() {
2336 # can/must only be called in main
2337 if ($Coro::current != $Coro::main) {
2338 warn "can only reload from main coroutine";
2339 return;
2340 }
2341
2342 warn "reloading...";
2343
2344 warn "cancelling server ticker";
2345 $TICK_WATCHER->cancel;
2346
2347 cf::emergency_save;
2348
2349 eval {
2350 # if anything goes wrong in here, we should simply crash as we already saved
2351
2352 warn "syncing database to disk";
2353 cf::db_sync;
2354
2355 warn "cancelling all WF_AUTOCANCEL watchers";
2356 for (Event::all_watchers) {
2357 $_->cancel if $_->data & WF_AUTOCANCEL;
2358 }
2359
2360 warn "flushing outstanding aio requests";
2361 for (;;) {
2362 IO::AIO::flush;
2363 Coro::cede;
2364 last unless IO::AIO::nreqs;
2365 warn "iterate...";
2366 }
2367
2368 warn "cancelling all extension coros";
2369 $_->cancel for values %EXT_CORO;
2370 %EXT_CORO = ();
2371
2372 warn "removing commands";
2373 %COMMAND = ();
2374
2375 warn "removing ext commands";
2376 %EXTCMD = ();
2377
2378 warn "unloading/nuking all extensions";
2379 for my $pkg (@EXTS) {
2380 warn "... unloading $pkg";
2381
2382 if (my $cb = $pkg->can ("unload")) {
2383 eval {
2384 $cb->($pkg);
2385 1
2386 } or warn "$pkg unloaded, but with errors: $@";
2387 }
2388
2389 warn "... nuking $pkg";
2390 Symbol::delete_package $pkg;
2391 }
2392
2393 warn "unloading all perl modules loaded from $LIBDIR";
2394 while (my ($k, $v) = each %INC) {
2395 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2396
2397 warn "... unloading $k";
2398 delete $INC{$k};
2399
2400 $k =~ s/\.pm$//;
2401 $k =~ s/\//::/g;
2402
2403 if (my $cb = $k->can ("unload_module")) {
2404 $cb->();
2405 }
2406
2407 Symbol::delete_package $k;
2408 }
2409
2410 warn "getting rid of safe::, as good as possible";
2411 Symbol::delete_package "safe::$_"
2412 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2413
2414 warn "unloading cf.pm \"a bit\"";
2415 delete $INC{"cf.pm"};
2416
2417 # don't, removes xs symbols, too,
2418 # and global variables created in xs
2419 #Symbol::delete_package __PACKAGE__;
2420
2421 warn "unload completed, starting to reload now";
2422
2423 warn "reloading cf.pm";
2424 require cf;
2425 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2426
2427 warn "loading config and database again";
2428 cf::cfg_load;
2429 cf::db_load;
2430
2431 warn "loading extensions";
2432 cf::load_extensions;
2433
2434 warn "reattaching attachments to objects/players";
2435 _global_reattach;
2436 warn "reattaching attachments to maps";
2437 reattach $_ for values %MAP;
2438
2439 warn "restarting server ticker";
2440
2441 $TICK_WATCHER->start;
2442 };
2443
2444 if ($@) {
2445 warn $@;
2446 warn "error while reloading, exiting.";
2447 exit 1;
2448 }
2449
2450 warn "reloaded";
2451};
2452
2453our $RELOAD_WATCHER; # used only during reload
2454
2455register_command "reload" => sub {
2456 my ($who, $arg) = @_;
2457
2458 if ($who->flag (FLAG_WIZ)) {
2459 $who->message ("reloading server.");
2460
2461 # doing reload synchronously and two reloads happen back-to-back,
2462 # coro crashes during coro_state_free->destroy here.
2463
2464 $RELOAD_WATCHER ||= Event->timer (
2465 reentrant => 0,
2466 after => 0,
2467 data => WF_AUTOCANCEL,
2468 cb => sub {
2469 reload;
2470 undef $RELOAD_WATCHER;
2471 },
2472 );
2473 }
2474};
875 2475
876unshift @INC, $LIBDIR; 2476unshift @INC, $LIBDIR;
877 2477
878load_extensions; 2478my $bug_warning = 0;
879 2479
880$TICK_WATCHER = Event->timer ( 2480$TICK_WATCHER = Event->timer (
2481 reentrant => 0,
2482 parked => 1,
881 prio => 1, 2483 prio => -1,
882 at => $NEXT_TICK || 1, 2484 at => $NEXT_TICK || $TICK,
2485 data => WF_AUTOCANCEL,
883 cb => sub { 2486 cb => sub {
2487 if ($Coro::current != $Coro::main) {
2488 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2489 unless ++$bug_warning > 10;
2490 return;
2491 }
2492
2493 $NOW = Event::time;
2494
884 cf::server_tick; # one server iteration 2495 cf::server_tick; # one server iteration
885 2496 $RUNTIME += $TICK;
886 my $NOW = Event::time;
887 $NEXT_TICK += $TICK; 2497 $NEXT_TICK += $TICK;
888 2498
2499 $WAIT_FOR_TICK->broadcast;
2500 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2501
2502 my $AFTER = Event::time;
2503 warn $AFTER - $NOW;#d#
2504
889 # if we are delayed by four ticks, skip them all 2505 # if we are delayed by four ticks or more, skip them all
890 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2506 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
891 2507
892 $TICK_WATCHER->at ($NEXT_TICK); 2508 $TICK_WATCHER->at ($NEXT_TICK);
893 $TICK_WATCHER->start; 2509 $TICK_WATCHER->start;
894 }, 2510 },
895); 2511);
896 2512
897_reload_2; 2513IO::AIO::max_poll_time $TICK * 0.2;
2514
2515undef $Coro::AIO::WATCHER;
2516$AIO_POLL_WATCHER = Event->io (
2517 reentrant => 0,
2518 fd => IO::AIO::poll_fileno,
2519 poll => 'r',
2520 prio => 6,
2521 data => WF_AUTOCANCEL,
2522 cb => \&IO::AIO::poll_cb,
2523);
2524
2525$WRITE_RUNTIME_WATCHER = Event->timer (
2526 reentrant => 0,
2527 data => WF_AUTOCANCEL,
2528 after => 1,
2529 interval => 10,
2530 prio => 6, # keep it lowest so it acts like a watchdog
2531 cb => Coro::unblock_sub {
2532 write_runtime
2533 or warn "ERROR: unable to write runtime file: $!";
2534 },
2535);
2536
2537END { cf::emergency_save }
898 2538
8991 25391
900 2540

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines