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.44 by root, Sat Aug 26 08:44:06 2006 UTC vs.
Revision 1.216 by root, Thu Feb 15 14:30:21 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines