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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines