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.135 by root, Thu Jan 4 20:29: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;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Digest::MD5;
21use Fcntl;
10use IO::AIO (); 22use IO::AIO 2.31 ();
11use YAML::Syck (); 23use YAML::Syck ();
12use Time::HiRes; 24use Time::HiRes;
13use Event; 25
14$Event::Eval = 1; # no idea why this is required, but it is 26use Event; $Event::Eval = 1; # no idea why this is required, but it is
15 27
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 29$YAML::Syck::ImplicitUnicode = 1;
18 30
19use strict; 31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20 32
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 34
23our %COMMAND = (); 35our %COMMAND = ();
24our %COMMAND_TIME = (); 36our %COMMAND_TIME = ();
25our %EXTCMD = (); 37our %EXTCMD = ();
26 38
27_init_vars;
28
29our @EVENT; 39our @EVENT;
30our $LIBDIR = datadir . "/ext"; 40our $LIBDIR = datadir . "/ext";
31 41
32our $TICK = MAX_TIME * 1e-6; 42our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER; 43our $TICK_WATCHER;
34our $NEXT_TICK; 44our $NEXT_TICK;
45our $NOW;
35 46
36our %CFG; 47our %CFG;
37 48
38our $UPTIME; $UPTIME ||= time; 49our $UPTIME; $UPTIME ||= time;
50our $RUNTIME;
51
52our %MAP; # all maps
53our $LINK_MAP; # the special {link} map
54our $RANDOM_MAPS = cf::localdir . "/random";
55our %EXT_CORO;
56
57binmode STDOUT;
58binmode STDERR;
59
60# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime"
63 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.;
65}
66
67mkdir cf::localdir;
68mkdir cf::localdir . "/" . cf::playerdir;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION;
39 76
40############################################################################# 77#############################################################################
41 78
42=head2 GLOBAL VARIABLES 79=head2 GLOBAL VARIABLES
43 80
44=over 4 81=over 4
45 82
46=item $cf::UPTIME 83=item $cf::UPTIME
47 84
48The timestamp of the server start (so not actually an uptime). 85The timestamp of the server start (so not actually an uptime).
86
87=item $cf::RUNTIME
88
89The time this server has run, starts at 0 and is increased by $cf::TICK on
90every server tick.
49 91
50=item $cf::LIBDIR 92=item $cf::LIBDIR
51 93
52The perl library directory, where extensions and cf-specific modules can 94The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically. 95be found. It will be added to C<@INC> automatically.
96
97=item $cf::NOW
98
99The time of the last (current) server tick.
54 100
55=item $cf::TICK 101=item $cf::TICK
56 102
57The interval between server ticks, in seconds. 103The interval between server ticks, in seconds.
58 104
66=cut 112=cut
67 113
68BEGIN { 114BEGIN {
69 *CORE::GLOBAL::warn = sub { 115 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 116 my $msg = join "", @_;
117 utf8::encode $msg;
118
71 $msg .= "\n" 119 $msg .= "\n"
72 unless $msg =~ /\n$/; 120 unless $msg =~ /\n$/;
73 121
74 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 122 LOG llevError, "cfperl: $msg";
76 }; 123 };
77} 124}
78 125
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 131@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85 132
86# we bless all objects into (empty) derived classes to force a method lookup 133# we bless all objects into (empty) derived classes to force a method lookup
87# within the Safe compartment. 134# within the Safe compartment.
88for my $pkg (qw( 135for my $pkg (qw(
89 cf::global 136 cf::global cf::attachable
90 cf::object cf::object::player 137 cf::object cf::object::player
91 cf::client cf::player 138 cf::client cf::player
92 cf::arch cf::living 139 cf::arch cf::living
93 cf::map cf::party cf::region 140 cf::map cf::party cf::region
94)) { 141)) {
132sub to_json($) { 179sub to_json($) {
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134 JSON::Syck::Dump $_[0] 181 JSON::Syck::Dump $_[0]
135} 182}
136 183
184=item cf::lock_wait $string
185
186Wait until the given lock is available. See cf::lock_acquire.
187
188=item my $lock = cf::lock_acquire $string
189
190Wait until the given lock is available and then acquires it and returns
191a Coro::guard object. If the guard object gets destroyed (goes out of scope,
192for example when the coroutine gets canceled), the lock is automatically
193returned.
194
195Lock names should begin with a unique identifier (for example, cf::map::find
196uses map_find and cf::map::load uses map_load).
197
198=cut
199
200our %LOCK;
201
202sub lock_wait($) {
203 my ($key) = @_;
204
205 # wait for lock, if any
206 while ($LOCK{$key}) {
207 push @{ $LOCK{$key} }, $Coro::current;
208 Coro::schedule;
209 }
210}
211
212sub lock_acquire($) {
213 my ($key) = @_;
214
215 # wait, to be sure we are not locked
216 lock_wait $key;
217
218 $LOCK{$key} = [];
219
220 Coro::guard {
221 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} };
223 }
224}
225
226=item cf::async { BLOCK }
227
228Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
229error instead of exiting the server in case of a problem.
230
231=cut
232
233sub async(&) {
234 my ($cb) = @_;
235
236 Coro::async {
237 eval { $cb->() };
238 warn $@ if $@;
239 }
240}
241
242sub freeze_mainloop {
243 return unless $TICK_WATCHER->is_active;
244
245 my $guard = Coro::guard { $TICK_WATCHER->start };
246 $TICK_WATCHER->stop;
247 $guard
248}
249
250=item cf::sync_job { BLOCK }
251
252The design of crossfire+ requires that the main coro ($Coro::main) is
253always able to handle events or runnable, as crossfire+ is only partly
254reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
255
256If it must be done, put the blocking parts into C<sync_job>. This will run
257the given BLOCK in another coroutine while waiting for the result. The
258server will be frozen during this time, so the block should either finish
259fast or be very important.
260
261=cut
262
263sub sync_job(&) {
264 my ($job) = @_;
265
266 if ($Coro::current == $Coro::main) {
267 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/
269
270 # TODO: use suspend/resume instead
271 # (but this is cancel-safe)
272 my $freeze_guard = freeze_mainloop;
273
274 my $busy = 1;
275 my @res;
276
277 (Coro::async {
278 @res = eval { $job->() };
279 warn $@ if $@;
280 undef $busy;
281 })->prio (Coro::PRIO_MAX);
282
283 while ($busy) {
284 Coro::cede_notself;
285 Event::one_event unless Coro::nready;
286 }
287
288 wantarray ? @res : $res[0]
289 } else {
290 # we are in another coroutine, how wonderful, everything just works
291
292 $job->()
293 }
294}
295
296=item $coro = cf::coro { BLOCK }
297
298Creates and returns a new coro. This coro is automcatially being canceled
299when the extension calling this is being unloaded.
300
301=cut
302
303sub coro(&) {
304 my $cb = shift;
305
306 my $coro = &cf::async ($cb);
307
308 $coro->on_destroy (sub {
309 delete $EXT_CORO{$coro+0};
310 });
311 $EXT_CORO{$coro+0} = $coro;
312
313 $coro
314}
315
316sub write_runtime {
317 my $runtime = cf::localdir . "/runtime";
318
319 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
320 or return;
321
322 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
323 (aio_write $fh, 0, (length $value), $value, 0) <= 0
324 and return;
325
326 aio_fsync $fh
327 and return;
328
329 close $fh
330 or return;
331
332 aio_rename "$runtime~", $runtime
333 and return;
334
335 1
336}
337
137=back 338=back
138 339
139=cut 340=cut
140 341
141############################################################################# 342#############################################################################
142 343
344package cf::path;
345
346sub new {
347 my ($class, $path, $base) = @_;
348
349 $path = $path->as_string if ref $path;
350
351 my $self = bless { }, $class;
352
353 # {... are special paths that are not touched
354 # ?xxx/... are special absolute paths
355 # ?random/... random maps
356 # /! non-realised random map exit
357 # /... normal maps
358 # ~/... per-player maps without a specific player (DO NOT USE)
359 # ~user/... per-player map of a specific user
360
361 if ($path =~ /^{/) {
362 # fine as it is
363 } elsif ($path =~ s{^\?random/}{}) {
364 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365 $self->{random} = cf::from_json $data;
366 } else {
367 if ($path =~ s{^~([^/]+)?}{}) {
368 $self->{user_rel} = 1;
369
370 if (defined $1) {
371 $self->{user} = $1;
372 } elsif ($base =~ m{^~([^/]+)/}) {
373 $self->{user} = $1;
374 } else {
375 warn "cannot resolve user-relative path without user <$path,$base>\n";
376 }
377 } elsif ($path =~ /^\//) {
378 # already absolute
379 } else {
380 $base =~ s{[^/]+/?$}{};
381 return $class->new ("$base/$path");
382 }
383
384 for ($path) {
385 redo if s{/\.?/}{/};
386 redo if s{/[^/]+/\.\./}{/};
387 }
388 }
389
390 $self->{path} = $path;
391
392 $self
393}
394
395# the name / primary key / in-game path
396sub as_string {
397 my ($self) = @_;
398
399 $self->{user_rel} ? "~$self->{user}$self->{path}"
400 : $self->{random} ? "?random/$self->{path}"
401 : $self->{path}
402}
403
404# the displayed name, this is a one way mapping
405sub visible_name {
406 my ($self) = @_;
407
408# if (my $rmp = $self->{random}) {
409# # todo: be more intelligent about this
410# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411# } else {
412 $self->as_string
413# }
414}
415
416# escape the /'s in the path
417sub _escaped_path {
418 # ∕ is U+2215
419 (my $path = $_[0]{path}) =~ s/\//∕/g;
420 $path
421}
422
423# the original (read-only) location
424sub load_path {
425 my ($self) = @_;
426
427 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428}
429
430# the temporary/swap location
431sub save_path {
432 my ($self) = @_;
433
434 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437}
438
439# the unique path, might be eq to save_path
440sub uniq_path {
441 my ($self) = @_;
442
443 $self->{user_rel} || $self->{random}
444 ? undef
445 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446}
447
448# return random map parameters, or undef
449sub random_map_params {
450 my ($self) = @_;
451
452 $self->{random}
453}
454
455# this is somewhat ugly, but style maps do need special treatment
456sub is_style_map {
457 $_[0]{path} =~ m{^/styles/}
458}
459
460package cf;
461
462#############################################################################
463
143=head2 ATTACHABLE OBJECTS 464=head2 ATTACHABLE OBJECTS
144 465
145You can define and attach attachments to each "attachable" object in 466Many objects in crossfire are so-called attachable objects. That means you can
146crossfire+ (objects, players, clients, maps and the special "global" 467attach callbacks/event handlers (a collection of which is called an "attachment")
468to it. All such attachable objects support the following methods.
469
147class). In the following description, CLASS can be any of C<global>, 470In the following description, CLASS can be any of C<global>, C<object>
148C<object> C<player>, C<client> or C<map>. 471C<player>, C<client> or C<map> (i.e. the attachable objects in
472crossfire+).
149 473
150=over 4 474=over 4
151 475
476=item $attachable->attach ($attachment, key => $value...)
477
478=item $attachable->detach ($attachment)
479
480Attach/detach a pre-registered attachment to a specific object and give it
481the specified key/value pairs as arguments.
482
483Example, attach a minesweeper attachment to the given object, making it a
48410x10 minesweeper game:
485
486 $obj->attach (minesweeper => width => 10, height => 10);
487
488=item $bool = $attachable->attached ($name)
489
490Checks wether the named attachment is currently attached to the object.
491
492=item cf::CLASS->attach ...
493
494=item cf::CLASS->detach ...
495
496Define an anonymous attachment and attach it to all objects of the given
497CLASS. See the next function for an explanation of its arguments.
498
499You can attach to global events by using the C<cf::global> class.
500
501Example, log all player logins:
502
503 cf::player->attach (
504 on_login => sub {
505 my ($pl) = @_;
506 ...
507 },
508 );
509
510Example, attach to the jeweler skill:
511
512 cf::object->attach (
513 type => cf::SKILL,
514 subtype => cf::SK_JEWELER,
515 on_use_skill => sub {
516 my ($sk, $ob, $part, $dir, $msg) = @_;
517 ...
518 },
519 );
520
152=item cf::CLASS::attachment $name, ... 521=item cf::CLASS::attachment $name, ...
153 522
154Register an attachment by name through which attachable objects can refer 523Register an attachment by C<$name> through which attachable objects of the
155to this attachment. 524given CLASS can refer to this attachment.
156 525
157=item $bool = $attachable->attached ($name) 526Some classes such as crossfire maps and objects can specify attachments
527that are attached at load/instantiate time, thus the need for a name.
158 528
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 529These calls expect any number of the following handler/hook descriptions:
172descriptions:
173 530
174=over 4 531=over 4
175 532
176=item prio => $number 533=item prio => $number
177 534
203package and register them. Only handlers for eevents supported by the 560package and register them. Only handlers for eevents supported by the
204object/class are recognised. 561object/class are recognised.
205 562
206=back 563=back
207 564
565Example, define an attachment called "sockpuppet" that calls the given
566event handler when a monster attacks:
567
568 cf::object::attachment sockpuppet =>
569 on_skill_attack => sub {
570 my ($self, $victim) = @_;
571 ...
572 }
573 }
574
575=item $attachable->valid
576
577Just because you have a perl object does not mean that the corresponding
578C-level object still exists. If you try to access an object that has no
579valid C counterpart anymore you get an exception at runtime. This method
580can be used to test for existence of the C object part without causing an
581exception.
582
208=cut 583=cut
209 584
210# the following variables are defined in .xs and must not be re-created 585# the following variables are defined in .xs and must not be re-created
211our @CB_GLOBAL = (); # registry for all global events 586our @CB_GLOBAL = (); # registry for all global events
587our @CB_ATTACHABLE = (); # registry for all attachables
212our @CB_OBJECT = (); # all objects (should not be used except in emergency) 588our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213our @CB_PLAYER = (); 589our @CB_PLAYER = ();
214our @CB_CLIENT = (); 590our @CB_CLIENT = ();
215our @CB_TYPE = (); # registry for type (cf-object class) based events 591our @CB_TYPE = (); # registry for type (cf-object class) based events
216our @CB_MAP = (); 592our @CB_MAP = ();
217 593
218my %attachment; 594my %attachment;
219 595
220sub _attach_cb($$$$) { 596sub _attach_cb($$$$) {
221 my ($registry, $event, $prio, $cb) = @_; 597 my ($registry, $event, $prio, $cb) = @_;
226 602
227 @{$registry->[$event]} = sort 603 @{$registry->[$event]} = sort
228 { $a->[0] cmp $b->[0] } 604 { $a->[0] cmp $b->[0] }
229 @{$registry->[$event] || []}, $cb; 605 @{$registry->[$event] || []}, $cb;
230} 606}
607
608# hack
609my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231 610
232# attach handles attaching event callbacks 611# attach handles attaching event callbacks
233# the only thing the caller has to do is pass the correct 612# the only thing the caller has to do is pass the correct
234# registry (== where the callback attaches to). 613# registry (== where the callback attaches to).
235sub _attach { 614sub _attach {
237 616
238 my $object_type; 617 my $object_type;
239 my $prio = 0; 618 my $prio = 0;
240 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 619 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241 620
621 #TODO: get rid of this hack
622 if ($attachable_klass{$klass}) {
623 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
624 }
625
242 while (@arg) { 626 while (@arg) {
243 my $type = shift @arg; 627 my $type = shift @arg;
244 628
245 if ($type eq "prio") { 629 if ($type eq "prio") {
246 $prio = shift @arg; 630 $prio = shift @arg;
321 my ($obj, $name) = @_; 705 my ($obj, $name) = @_;
322 706
323 exists $obj->{_attachment}{$name} 707 exists $obj->{_attachment}{$name}
324} 708}
325 709
326for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 710for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327 eval "#line " . __LINE__ . " 'cf.pm' 711 eval "#line " . __LINE__ . " 'cf.pm'
328 sub cf::\L$klass\E::_attach_registry { 712 sub cf::\L$klass\E::_attach_registry {
329 (\\\@CB_$klass, KLASS_$klass) 713 (\\\@CB_$klass, KLASS_$klass)
330 } 714 }
331 715
367 } 751 }
368 752
369 0 753 0
370} 754}
371 755
372=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 756=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373 757
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, ...) 758=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379 759
380=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382Generate a global/object/player/map-specific event with the given arguments. 760Generate an object-specific event with the given arguments.
383 761
384This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 762This 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 763removed in future versions), and there is no public API to access override
386results (if you must, access C<@cf::invoke_results> directly). 764results (if you must, access C<@cf::invoke_results> directly).
387 765
388=back 766=back
389 767
390=cut 768=cut
391 769
392############################################################################# 770#############################################################################
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 771# object support
414 772
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 { 773sub reattach {
774 # basically do the same as instantiate, without calling instantiate
429 my ($obj) = @_; 775 my ($obj) = @_;
776
430 my $registry = $obj->registry; 777 my $registry = $obj->registry;
431 778
432 @$registry = (); 779 @$registry = ();
433 780
434 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 781 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
443 warn "object uses attachment '$name' that is not available, postponing.\n"; 790 warn "object uses attachment '$name' that is not available, postponing.\n";
444 } 791 }
445 } 792 }
446} 793}
447 794
448sub object_freezer_save { 795cf::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, 796 prio => -1000000,
797 on_instantiate => sub {
798 my ($obj, $data) = @_;
799
800 $data = from_json $data;
801
802 for (@$data) {
803 my ($name, $args) = @$_;
804
805 $obj->attach ($name, %{$args || {} });
806 }
807 },
808 on_reattach => \&reattach,
508 on_clone => sub { 809 on_clone => sub {
509 my ($src, $dst) = @_; 810 my ($src, $dst) = @_;
510 811
511 @{$dst->registry} = @{$src->registry}; 812 @{$dst->registry} = @{$src->registry};
512 813
514 815
515 %{$dst->{_attachment}} = %{$src->{_attachment}} 816 %{$dst->{_attachment}} = %{$src->{_attachment}}
516 if exists $src->{_attachment}; 817 if exists $src->{_attachment};
517 }, 818 },
518); 819);
820
821sub object_freezer_save {
822 my ($filename, $rdata, $objs) = @_;
823
824 sync_job {
825 if (length $$rdata) {
826 warn sprintf "saving %s (%d,%d)\n",
827 $filename, length $$rdata, scalar @$objs;
828
829 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830 chmod SAVE_MODE, $fh;
831 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
832 aio_fsync $fh;
833 close $fh;
834
835 if (@$objs) {
836 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
837 chmod SAVE_MODE, $fh;
838 my $data = Storable::nfreeze { version => 1, objs => $objs };
839 aio_write $fh, 0, (length $data), $data, 0;
840 aio_fsync $fh;
841 close $fh;
842 aio_rename "$filename.pst~", "$filename.pst";
843 }
844 } else {
845 aio_unlink "$filename.pst";
846 }
847
848 aio_rename "$filename~", $filename;
849 } else {
850 warn "FATAL: $filename~: $!\n";
851 }
852 } else {
853 aio_unlink $filename;
854 aio_unlink "$filename.pst";
855 }
856 }
857}
858
859sub object_freezer_as_string {
860 my ($rdata, $objs) = @_;
861
862 use Data::Dumper;
863
864 $$rdata . Dumper $objs
865}
866
867sub object_thawer_load {
868 my ($filename) = @_;
869
870 my ($data, $av);
871
872 (aio_load $filename, $data) >= 0
873 or return;
874
875 unless (aio_stat "$filename.pst") {
876 (aio_load "$filename.pst", $av) >= 0
877 or return;
878 $av = eval { (Storable::thaw $av)->{objs} };
879 }
880
881 warn sprintf "loading %s (%d)\n",
882 $filename, length $data, scalar @{$av || []};#d#
883 return ($data, $av);
884}
519 885
520############################################################################# 886#############################################################################
521# command handling &c 887# command handling &c
522 888
523=item cf::register_command $name => \&callback($ob,$args); 889=item cf::register_command $name => \&callback($ob,$args);
712 1078
713=head2 CORE EXTENSIONS 1079=head2 CORE EXTENSIONS
714 1080
715Functions and methods that extend core crossfire objects. 1081Functions and methods that extend core crossfire objects.
716 1082
1083=head3 cf::player
1084
717=over 4 1085=over 4
718 1086
719=item cf::player::exists $login 1087=item cf::player::exists $login
720 1088
721Returns true when the given account exists. 1089Returns true when the given account exists.
725sub cf::player::exists($) { 1093sub cf::player::exists($) {
726 cf::player::find $_[0] 1094 cf::player::find $_[0]
727 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1095 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
728} 1096}
729 1097
1098=item $player->ext_reply ($msgid, $msgtype, %msg)
1099
1100Sends an ext reply to the player.
1101
1102=cut
1103
1104sub cf::player::ext_reply($$$%) {
1105 my ($self, $id, %msg) = @_;
1106
1107 $msg{msgid} = $id;
1108
1109 $self->send ("ext " . to_json \%msg);
1110}
1111
1112=back
1113
1114
1115=head3 cf::map
1116
1117=over 4
1118
1119=cut
1120
1121package cf::map;
1122
1123use Fcntl;
1124use Coro::AIO;
1125
1126our $MAX_RESET = 3600;
1127our $DEFAULT_RESET = 3000;
1128
1129sub generate_random_map {
1130 my ($path, $rmp) = @_;
1131
1132 # mit "rum" bekleckern, nicht
1133 cf::map::_create_random_map
1134 $path,
1135 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1137 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{exit_on_final_map},
1139 $rmp->{xsize}, $rmp->{ysize},
1140 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1144 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145 (cf::region::find $rmp->{region})
1146}
1147
1148# and all this just because we cannot iterate over
1149# all maps in C++...
1150sub change_all_map_light {
1151 my ($change) = @_;
1152
1153 $_->change_map_light ($change)
1154 for grep $_->outdoor, values %cf::MAP;
1155}
1156
1157sub try_load_header($) {
1158 my ($path) = @_;
1159
1160 utf8::encode $path;
1161 aio_open $path, O_RDONLY, 0
1162 or return;
1163
1164 my $map = cf::map::new
1165 or return;
1166
1167 # for better error messages only, will be overwritten
1168 $map->path ($path);
1169
1170 $map->load_header ($path)
1171 or return;
1172
1173 $map->{load_path} = $path;
1174
1175 $map
1176}
1177
1178sub find;
1179sub find {
1180 my ($path, $origin) = @_;
1181
1182 #warn "find<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186
1187 cf::lock_wait "map_find:$key";
1188
1189 $cf::MAP{$key} || do {
1190 my $guard = cf::lock_acquire "map_find:$key";
1191
1192 # do it the slow way
1193 my $map = try_load_header $path->save_path;
1194
1195 Coro::cede;
1196
1197 if ($map) {
1198 $map->last_access ((delete $map->{last_access})
1199 || $cf::RUNTIME); #d#
1200 # safety
1201 $map->{instantiate_time} = $cf::RUNTIME
1202 if $map->{instantiate_time} > $cf::RUNTIME;
1203 } else {
1204 if (my $rmp = $path->random_map_params) {
1205 $map = generate_random_map $key, $rmp;
1206 } else {
1207 $map = try_load_header $path->load_path;
1208 }
1209
1210 $map or return;
1211
1212 $map->{load_original} = 1;
1213 $map->{instantiate_time} = $cf::RUNTIME;
1214 $map->last_access ($cf::RUNTIME);
1215 $map->instantiate;
1216
1217 # per-player maps become, after loading, normal maps
1218 $map->per_player (0) if $path->{user_rel};
1219 }
1220
1221 $map->path ($key);
1222 $map->{path} = $path;
1223 $map->{last_save} = $cf::RUNTIME;
1224
1225 Coro::cede;
1226
1227 if ($map->should_reset) {
1228 $map->reset;
1229 undef $guard;
1230 $map = find $path
1231 or return;
1232 }
1233
1234 $cf::MAP{$key} = $map
1235 }
1236}
1237
1238sub load {
1239 my ($self) = @_;
1240
1241 my $path = $self->{path};
1242 my $guard = cf::lock_acquire "map_load:" . $path->as_string;
1243
1244 return if $self->in_memory != cf::MAP_SWAPPED;
1245
1246 $self->in_memory (cf::MAP_LOADING);
1247
1248 $self->alloc;
1249 $self->load_objects ($self->{load_path}, 1)
1250 or return;
1251
1252 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1253 if delete $self->{load_original};
1254
1255 if (my $uniq = $path->uniq_path) {
1256 utf8::encode $uniq;
1257 if (aio_open $uniq, O_RDONLY, 0) {
1258 $self->clear_unique_items;
1259 $self->load_objects ($uniq, 0);
1260 }
1261 }
1262
1263 Coro::cede;
1264
1265 # now do the right thing for maps
1266 $self->link_multipart_objects;
1267
1268 if ($self->{path}->is_style_map) {
1269 $self->{deny_save} = 1;
1270 $self->{deny_reset} = 1;
1271 } else {
1272 $self->fix_auto_apply;
1273 $self->decay_objects;
1274 $self->update_buttons;
1275 $self->set_darkness_map;
1276 $self->difficulty ($self->estimate_difficulty)
1277 unless $self->difficulty;
1278 $self->activate;
1279 }
1280
1281 Coro::cede;
1282
1283 $self->in_memory (cf::MAP_IN_MEMORY);
1284}
1285
1286sub find_sync {
1287 my ($path, $origin) = @_;
1288
1289 cf::sync_job { cf::map::find $path, $origin }
1290}
1291
1292sub do_load_sync {
1293 my ($map) = @_;
1294
1295 cf::sync_job { $map->load };
1296}
1297
1298sub save {
1299 my ($self) = @_;
1300
1301 $self->{last_save} = $cf::RUNTIME;
1302
1303 return unless $self->dirty;
1304
1305 my $save = $self->{path}->save_path; utf8::encode $save;
1306 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1307
1308 $self->{load_path} = $save;
1309
1310 return if $self->{deny_save};
1311
1312 local $self->{last_access} = $self->last_access;#d#
1313
1314 if ($uniq) {
1315 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1316 $self->save_objects ($uniq, cf::IO_UNIQUES);
1317 } else {
1318 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1319 }
1320}
1321
1322sub swap_out {
1323 my ($self) = @_;
1324
1325 # save first because save cedes
1326 $self->save;
1327
1328 return if $self->players;
1329 return if $self->in_memory != cf::MAP_IN_MEMORY;
1330 return if $self->{deny_save};
1331
1332 $self->clear;
1333 $self->in_memory (cf::MAP_SWAPPED);
1334}
1335
1336sub reset_at {
1337 my ($self) = @_;
1338
1339 # TODO: safety, remove and allow resettable per-player maps
1340 return 1e99 if $self->{path}{user_rel};
1341 return 1e99 if $self->{deny_reset};
1342
1343 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1345
1346 $time + $to
1347}
1348
1349sub should_reset {
1350 my ($self) = @_;
1351
1352 $self->reset_at <= $cf::RUNTIME
1353}
1354
1355sub unlink_save {
1356 my ($self) = @_;
1357
1358 utf8::encode (my $save = $self->{path}->save_path);
1359 aioreq_pri 3; IO::AIO::aio_unlink $save;
1360 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361}
1362
1363sub rename {
1364 my ($self, $new_path) = @_;
1365
1366 $self->unlink_save;
1367
1368 delete $cf::MAP{$self->path};
1369 $self->{path} = new cf::path $new_path;
1370 $self->path ($self->{path}->as_string);
1371 $cf::MAP{$self->path} = $self;
1372
1373 $self->save;
1374}
1375
1376sub reset {
1377 my ($self) = @_;
1378
1379 return if $self->players;
1380 return if $self->{path}{user_rel};#d#
1381
1382 warn "resetting map ", $self->path;#d#
1383
1384 delete $cf::MAP{$self->path};
1385
1386 $_->clear_links_to ($self) for values %cf::MAP;
1387
1388 $self->unlink_save;
1389 $self->destroy;
1390}
1391
1392my $nuke_counter = "aaaa";
1393
1394sub nuke {
1395 my ($self) = @_;
1396
1397 $self->{deny_save} = 1;
1398 $self->reset_timeout (1);
1399 $self->rename ("{nuke}/" . ($nuke_counter++));
1400 $self->reset; # polite request, might not happen
1401}
1402
1403sub customise_for {
1404 my ($map, $ob) = @_;
1405
1406 if ($map->per_player) {
1407 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
1408 }
1409
1410 $map
1411}
1412
1413sub emergency_save {
1414 my $freeze_guard = cf::freeze_mainloop;
1415
1416 warn "enter emergency map save\n";
1417
1418 cf::sync_job {
1419 warn "begin emergency map save\n";
1420 $_->save for values %cf::MAP;
1421 };
1422
1423 warn "end emergency map save\n";
1424}
1425
1426package cf;
1427
1428=back
1429
1430
1431=head3 cf::object::player
1432
1433=over 4
1434
730=item $player_object->reply ($npc, $msg[, $flags]) 1435=item $player_object->reply ($npc, $msg[, $flags])
731 1436
732Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1437Sends 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 1438can be C<undef>. Does the right thing when the player is currently in a
734dialogue with the given NPC character. 1439dialogue with the given NPC character.
735 1440
736=cut 1441=cut
737 1442
738# rough implementation of a future "reply" method that works 1443# rough implementation of a future "reply" method that works
739# with dialog boxes. 1444# with dialog boxes.
1445#TODO: the first argument must go, split into a $npc->reply_to ( method
740sub cf::object::player::reply($$$;$) { 1446sub cf::object::player::reply($$$;$) {
741 my ($self, $npc, $msg, $flags) = @_; 1447 my ($self, $npc, $msg, $flags) = @_;
742 1448
743 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1449 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744 1450
748 $msg = $npc->name . " says: $msg" if $npc; 1454 $msg = $npc->name . " says: $msg" if $npc;
749 $self->message ($msg, $flags); 1455 $self->message ($msg, $flags);
750 } 1456 }
751} 1457}
752 1458
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") 1459=item $player_object->may ("access")
768 1460
769Returns wether the given player is authorized to access resource "access" 1461Returns wether the given player is authorized to access resource "access"
770(e.g. "command_wizcast"). 1462(e.g. "command_wizcast").
771 1463
778 (ref $cf::CFG{"may_$access"} 1470 (ref $cf::CFG{"may_$access"}
779 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1471 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780 : $cf::CFG{"may_$access"}) 1472 : $cf::CFG{"may_$access"})
781} 1473}
782 1474
783=cut 1475=item $player_object->enter_link
784 1476
785############################################################################# 1477Freezes the player and moves him/her to a special map (C<{link}>).
1478
1479The player should be reaosnably safe there for short amounts of time. You
1480I<MUST> call C<leave_link> as soon as possible, though.
1481
1482=item $player_object->leave_link ($map, $x, $y)
1483
1484Moves the player out of the specila link map onto the given map. If the
1485map is not valid (or omitted), the player will be moved back to the
1486location he/she was before the call to C<enter_link>, or, if that fails,
1487to the emergency map position.
1488
1489Might block.
1490
1491=cut
1492
1493sub cf::object::player::enter_link {
1494 my ($self) = @_;
1495
1496 $self->deactivate_recursive;
1497
1498 return if $self->map == $LINK_MAP;
1499
1500 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501 if $self->map;
1502
1503 $self->enter_map ($LINK_MAP, 20, 20);
1504}
1505
1506sub cf::object::player::leave_link {
1507 my ($self, $map, $x, $y) = @_;
1508
1509 my $link_pos = delete $self->{_link_pos};
1510
1511 unless ($map) {
1512 # restore original map position
1513 ($map, $x, $y) = @{ $link_pos || [] };
1514 $map = cf::map::find $map;
1515
1516 unless ($map) {
1517 ($map, $x, $y) = @$EMERGENCY_POSITION;
1518 $map = cf::map::find $map
1519 or die "FATAL: cannot load emergency map\n";
1520 }
1521 }
1522
1523 ($x, $y) = (-1, -1)
1524 unless (defined $x) && (defined $y);
1525
1526 # use -1 or undef as default coordinates, not 0, 0
1527 ($x, $y) = ($map->enter_x, $map->enter_y)
1528 if $x <=0 && $y <= 0;
1529
1530 $map->load;
1531
1532 $self->activate_recursive;
1533 $self->enter_map ($map, $x, $y);
1534}
1535
1536cf::player->attach (
1537 on_logout => sub {
1538 my ($pl) = @_;
1539
1540 # abort map switching before logout
1541 if ($pl->ob->{_link_pos}) {
1542 cf::sync_job {
1543 $pl->ob->leave_link
1544 };
1545 }
1546 },
1547 on_login => sub {
1548 my ($pl) = @_;
1549
1550 # try to abort aborted map switching on player login :)
1551 # should happen only on crashes
1552 if ($pl->ob->{_link_pos}) {
1553 $pl->ob->enter_link;
1554 cf::async {
1555 # we need this sleep as the login has a concurrent enter_exit running
1556 # and this sleep increases chances of the player not ending up in scorn
1557 Coro::Timer::sleep 1;
1558 $pl->ob->leave_link;
1559 };
1560 }
1561 },
1562);
1563
1564=item $player_object->goto_map ($path, $x, $y)
1565
1566=cut
1567
1568sub cf::object::player::goto_map {
1569 my ($self, $path, $x, $y) = @_;
1570
1571 $self->enter_link;
1572
1573 (cf::async {
1574 $path = new cf::path $path;
1575
1576 my $map = cf::map::find $path->as_string;
1577 $map = $map->customise_for ($self) if $map;
1578
1579# warn "entering ", $map->path, " at ($x, $y)\n"
1580# if $map;
1581
1582 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1583
1584 $self->leave_link ($map, $x, $y);
1585 })->prio (1);
1586}
1587
1588=item $player_object->enter_exit ($exit_object)
1589
1590=cut
1591
1592sub parse_random_map_params {
1593 my ($spec) = @_;
1594
1595 my $rmp = { # defaults
1596 xsize => 10,
1597 ysize => 10,
1598 };
1599
1600 for (split /\n/, $spec) {
1601 my ($k, $v) = split /\s+/, $_, 2;
1602
1603 $rmp->{lc $k} = $v if (length $k) && (length $v);
1604 }
1605
1606 $rmp
1607}
1608
1609sub prepare_random_map {
1610 my ($exit) = @_;
1611
1612 # all this does is basically replace the /! path by
1613 # a new random map path (?random/...) with a seed
1614 # that depends on the exit object
1615
1616 my $rmp = parse_random_map_params $exit->msg;
1617
1618 if ($exit->map) {
1619 $rmp->{region} = $exit->map->region_name;
1620 $rmp->{origin_map} = $exit->map->path;
1621 $rmp->{origin_x} = $exit->x;
1622 $rmp->{origin_y} = $exit->y;
1623 }
1624
1625 $rmp->{random_seed} ||= $exit->random_seed;
1626
1627 my $data = cf::to_json $rmp;
1628 my $md5 = Digest::MD5::md5_hex $data;
1629
1630 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1631 aio_write $fh, 0, (length $data), $data, 0;
1632
1633 $exit->slaying ("?random/$md5");
1634 $exit->msg (undef);
1635 }
1636}
1637
1638sub cf::object::player::enter_exit {
1639 my ($self, $exit) = @_;
1640
1641 return unless $self->type == cf::PLAYER;
1642
1643 $self->enter_link;
1644
1645 (cf::async {
1646 $self->deactivate_recursive; # just to be sure
1647 unless (eval {
1648 prepare_random_map $exit
1649 if $exit->slaying eq "/!";
1650
1651 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653
1654 1;
1655 }) {
1656 $self->message ("Something went wrong deep within the crossfire server. "
1657 . "I'll try to bring you back to the map you were before. "
1658 . "Please report this to the dungeon master",
1659 cf::NDI_UNIQUE | cf::NDI_RED);
1660
1661 warn "ERROR in enter_exit: $@";
1662 $self->leave_link;
1663 }
1664 })->prio (1);
1665}
1666
1667=head3 cf::client
1668
1669=over 4
1670
1671=item $client->send_drawinfo ($text, $flags)
1672
1673Sends a drawinfo packet to the client. Circumvents output buffering so
1674should not be used under normal circumstances.
1675
1676=cut
1677
1678sub cf::client::send_drawinfo {
1679 my ($self, $text, $flags) = @_;
1680
1681 utf8::encode $text;
1682 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1683}
1684
1685
1686=item $success = $client->query ($flags, "text", \&cb)
1687
1688Queues a query to the client, calling the given callback with
1689the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1690C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1691
1692Queries can fail, so check the return code. Or don't, as queries will become
1693reliable at some point in the future.
1694
1695=cut
1696
1697sub cf::client::query {
1698 my ($self, $flags, $text, $cb) = @_;
1699
1700 return unless $self->state == ST_PLAYING
1701 || $self->state == ST_SETUP
1702 || $self->state == ST_CUSTOM;
1703
1704 $self->state (ST_CUSTOM);
1705
1706 utf8::encode $text;
1707 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1708
1709 $self->send_packet ($self->{query_queue}[0][0])
1710 if @{ $self->{query_queue} } == 1;
1711}
1712
1713cf::client->attach (
1714 on_reply => sub {
1715 my ($ns, $msg) = @_;
1716
1717 # this weird shuffling is so that direct followup queries
1718 # get handled first
1719 my $queue = delete $ns->{query_queue}
1720 or return; # be conservative, not sure how that can happen, but we saw a crash here
1721
1722 (shift @$queue)->[1]->($msg);
1723
1724 push @{ $ns->{query_queue} }, @$queue;
1725
1726 if (@{ $ns->{query_queue} } == @$queue) {
1727 if (@$queue) {
1728 $ns->send_packet ($ns->{query_queue}[0][0]);
1729 } else {
1730 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1731 }
1732 }
1733 },
1734);
1735
1736=item $client->coro (\&cb)
1737
1738Create a new coroutine, running the specified callback. The coroutine will
1739be automatically cancelled when the client gets destroyed (e.g. on logout,
1740or loss of connection).
1741
1742=cut
1743
1744sub cf::client::coro {
1745 my ($self, $cb) = @_;
1746
1747 my $coro = &cf::async ($cb);
1748
1749 $coro->on_destroy (sub {
1750 delete $self->{_coro}{$coro+0};
1751 });
1752
1753 $self->{_coro}{$coro+0} = $coro;
1754
1755 $coro
1756}
1757
1758cf::client->attach (
1759 on_destroy => sub {
1760 my ($ns) = @_;
1761
1762 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1763 },
1764);
1765
1766=back
1767
786 1768
787=head2 SAFE SCRIPTING 1769=head2 SAFE SCRIPTING
788 1770
789Functions that provide a safe environment to compile and execute 1771Functions that provide a safe environment to compile and execute
790snippets of perl code without them endangering the safety of the server 1772snippets of perl code without them endangering the safety of the server
942 1924
943{ 1925{
944 my $path = cf::localdir . "/database.pst"; 1926 my $path = cf::localdir . "/database.pst";
945 1927
946 sub db_load() { 1928 sub db_load() {
947 warn "loading database $path\n";#d# remove later
948 $DB = stat $path ? Storable::retrieve $path : { }; 1929 $DB = stat $path ? Storable::retrieve $path : { };
949 } 1930 }
950 1931
951 my $pid; 1932 my $pid;
952 1933
953 sub db_save() { 1934 sub db_save() {
954 warn "saving database $path\n";#d# remove later
955 waitpid $pid, 0 if $pid; 1935 waitpid $pid, 0 if $pid;
956 if (0 == ($pid = fork)) { 1936 if (0 == ($pid = fork)) {
957 $DB->{_meta}{version} = 1; 1937 $DB->{_meta}{version} = 1;
958 Storable::nstore $DB, "$path~"; 1938 Storable::nstore $DB, "$path~";
959 rename "$path~", $path; 1939 rename "$path~", $path;
1007 open my $fh, "<:utf8", cf::confdir . "/config" 1987 open my $fh, "<:utf8", cf::confdir . "/config"
1008 or return; 1988 or return;
1009 1989
1010 local $/; 1990 local $/;
1011 *CFG = YAML::Syck::Load <$fh>; 1991 *CFG = YAML::Syck::Load <$fh>;
1992
1993 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994
1995 if (exists $CFG{mlockall}) {
1996 eval {
1997 $CFG{mlockall} ? &mlockall : &munlockall
1998 and die "WARNING: m(un)lockall failed: $!\n";
1999 };
2000 warn $@ if $@;
2001 }
1012} 2002}
1013 2003
1014sub main { 2004sub main {
2005 # we must not ever block the main coroutine
2006 local $Coro::idle = sub {
2007 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008 (Coro::unblock_sub {
2009 Event::one_event;
2010 })->();
2011 };
2012
1015 cfg_load; 2013 cfg_load;
1016 db_load; 2014 db_load;
1017 load_extensions; 2015 load_extensions;
1018 Event::loop; 2016 Event::loop;
1019} 2017}
1020 2018
1021############################################################################# 2019#############################################################################
1022# initialisation 2020# initialisation
1023 2021
1024sub _perl_reload(&) { 2022sub reload() {
1025 my ($msg) = @_; 2023 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n";
2026 return;
2027 }
1026 2028
1027 $msg->("reloading..."); 2029 warn "reloading...";
2030
2031 my $guard = freeze_mainloop;
2032 cf::emergency_save;
1028 2033
1029 eval { 2034 eval {
2035 # if anything goes wrong in here, we should simply crash as we already saved
2036
1030 # cancel all watchers 2037 # cancel all watchers
1031 for (Event::all_watchers) { 2038 for (Event::all_watchers) {
1032 $_->cancel if $_->data & WF_AUTOCANCEL; 2039 $_->cancel if $_->data & WF_AUTOCANCEL;
1033 } 2040 }
1034 2041
2042 # cancel all extension coros
2043 $_->cancel for values %EXT_CORO;
2044 %EXT_CORO = ();
2045
1035 # unload all extensions 2046 # unload all extensions
1036 for (@exts) { 2047 for (@exts) {
1037 $msg->("unloading <$_>"); 2048 warn "unloading <$_>";
1038 unload_extension $_; 2049 unload_extension $_;
1039 } 2050 }
1040 2051
1041 # unload all modules loaded from $LIBDIR 2052 # unload all modules loaded from $LIBDIR
1042 while (my ($k, $v) = each %INC) { 2053 while (my ($k, $v) = each %INC) {
1043 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2054 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044 2055
1045 $msg->("removing <$k>"); 2056 warn "removing <$k>";
1046 delete $INC{$k}; 2057 delete $INC{$k};
1047 2058
1048 $k =~ s/\.pm$//; 2059 $k =~ s/\.pm$//;
1049 $k =~ s/\//::/g; 2060 $k =~ s/\//::/g;
1050 2061
1055 Symbol::delete_package $k; 2066 Symbol::delete_package $k;
1056 } 2067 }
1057 2068
1058 # sync database to disk 2069 # sync database to disk
1059 cf::db_sync; 2070 cf::db_sync;
2071 IO::AIO::flush;
1060 2072
1061 # get rid of safe::, as good as possible 2073 # get rid of safe::, as good as possible
1062 Symbol::delete_package "safe::$_" 2074 Symbol::delete_package "safe::$_"
1063 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064 2076
1065 # remove register_script_function callbacks 2077 # remove register_script_function callbacks
1066 # TODO 2078 # TODO
1067 2079
1068 # unload cf.pm "a bit" 2080 # unload cf.pm "a bit"
1071 # don't, removes xs symbols, too, 2083 # don't, removes xs symbols, too,
1072 # and global variables created in xs 2084 # and global variables created in xs
1073 #Symbol::delete_package __PACKAGE__; 2085 #Symbol::delete_package __PACKAGE__;
1074 2086
1075 # reload cf.pm 2087 # reload cf.pm
1076 $msg->("reloading cf.pm"); 2088 warn "reloading cf.pm";
1077 require cf; 2089 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078 2091
1079 # load config and database again 2092 # load config and database again
1080 cf::cfg_load; 2093 cf::cfg_load;
1081 cf::db_load; 2094 cf::db_load;
1082 2095
1083 # load extensions 2096 # load extensions
1084 $msg->("load extensions"); 2097 warn "load extensions";
1085 cf::load_extensions; 2098 cf::load_extensions;
1086 2099
1087 # reattach attachments to objects 2100 # reattach attachments to objects
1088 $msg->("reattach"); 2101 warn "reattach";
1089 _global_reattach; 2102 _global_reattach;
1090 }; 2103 };
1091 $msg->($@) if $@;
1092 2104
1093 $msg->("reloaded"); 2105 if ($@) {
2106 warn $@;
2107 warn "error while reloading, exiting.";
2108 exit 1;
2109 }
2110
2111 warn "reloaded successfully";
1094}; 2112};
1095 2113
1096sub perl_reload() { 2114#############################################################################
1097 _perl_reload { 2115
1098 warn $_[0]; 2116unless ($LINK_MAP) {
1099 print "$_[0]\n"; 2117 $LINK_MAP = cf::map::new;
1100 }; 2118
2119 $LINK_MAP->width (41);
2120 $LINK_MAP->height (41);
2121 $LINK_MAP->alloc;
2122 $LINK_MAP->path ("{link}");
2123 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126 # dirty hack because... archetypes are not yet loaded
2127 Event->timer (
2128 after => 2,
2129 cb => sub {
2130 $_[0]->w->cancel;
2131
2132 # provide some exits "home"
2133 my $exit = cf::object::new "exit";
2134
2135 $exit->slaying ($EMERGENCY_POSITION->[0]);
2136 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139 $LINK_MAP->insert ($exit->clone, 19, 19);
2140 $LINK_MAP->insert ($exit->clone, 19, 20);
2141 $LINK_MAP->insert ($exit->clone, 19, 21);
2142 $LINK_MAP->insert ($exit->clone, 20, 19);
2143 $LINK_MAP->insert ($exit->clone, 20, 21);
2144 $LINK_MAP->insert ($exit->clone, 21, 19);
2145 $LINK_MAP->insert ($exit->clone, 21, 20);
2146 $LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148 $exit->destroy;
2149 });
2150
2151 $LINK_MAP->{deny_save} = 1;
2152 $LINK_MAP->{deny_reset} = 1;
2153
2154 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1101} 2155}
1102 2156
1103register "<global>", __PACKAGE__; 2157register "<global>", __PACKAGE__;
1104 2158
1105register_command "perl-reload" => sub { 2159register_command "reload" => sub {
1106 my ($who, $arg) = @_; 2160 my ($who, $arg) = @_;
1107 2161
1108 if ($who->flag (FLAG_WIZ)) { 2162 if ($who->flag (FLAG_WIZ)) {
1109 _perl_reload { 2163 $who->message ("start of reload.");
1110 warn $_[0]; 2164 reload;
1111 $who->message ($_[0]); 2165 $who->message ("end of reload.");
1112 };
1113 } 2166 }
1114}; 2167};
1115 2168
1116unshift @INC, $LIBDIR; 2169unshift @INC, $LIBDIR;
1117 2170
1118$TICK_WATCHER = Event->timer ( 2171$TICK_WATCHER = Event->timer (
2172 reentrant => 0,
1119 prio => 0, 2173 prio => 0,
1120 at => $NEXT_TICK || 1, 2174 at => $NEXT_TICK || $TICK,
1121 data => WF_AUTOCANCEL, 2175 data => WF_AUTOCANCEL,
1122 cb => sub { 2176 cb => sub {
1123 cf::server_tick; # one server iteration 2177 cf::server_tick; # one server iteration
1124 2178 $RUNTIME += $TICK;
1125 my $NOW = Event::time;
1126 $NEXT_TICK += $TICK; 2179 $NEXT_TICK += $TICK;
1127 2180
1128 # if we are delayed by four ticks or more, skip them all 2181 # if we are delayed by four ticks or more, skip them all
1129 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2182 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130 2183
1131 $TICK_WATCHER->at ($NEXT_TICK); 2184 $TICK_WATCHER->at ($NEXT_TICK);
1132 $TICK_WATCHER->start; 2185 $TICK_WATCHER->start;
1133 }, 2186 },
1134); 2187);
1135 2188
1136IO::AIO::max_poll_time $TICK * 0.2; 2189IO::AIO::max_poll_time $TICK * 0.2;
1137 2190
2191Event->io (
1138Event->io (fd => IO::AIO::poll_fileno, 2192 fd => IO::AIO::poll_fileno,
1139 poll => 'r', 2193 poll => 'r',
1140 prio => 5, 2194 prio => 5,
1141 data => WF_AUTOCANCEL, 2195 data => WF_AUTOCANCEL,
1142 cb => \&IO::AIO::poll_cb); 2196 cb => \&IO::AIO::poll_cb,
2197);
2198
2199Event->timer (
2200 data => WF_AUTOCANCEL,
2201 after => 0,
2202 interval => 10,
2203 cb => sub {
2204 (Coro::unblock_sub {
2205 write_runtime
2206 or warn "ERROR: unable to write runtime file: $!";
2207 })->();
2208 },
2209);
2210
2211END { cf::emergency_save }
1143 2212
11441 22131
1145 2214

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines