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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines