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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines