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.109 by root, Sun Dec 31 22:23:12 2006 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 $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO;
57
58binmode STDOUT;
59binmode STDERR;
60
61# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime"
64 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.;
66}
67
68mkdir cf::localdir;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73
74# a special map that is always available
75our $LINK_MAP;
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::sync_job { BLOCK }
185
186The design of crossfire+ requires that the main coro ($Coro::main) is
187always able to handle events or runnable, as crossfire+ is only partly
188reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
189
190If it must be done, put the blocking parts into C<sync_job>. This will run
191the given BLOCK in another coroutine while waiting for the result. The
192server will be frozen during this time, so the block should either finish
193fast or be very important.
194
195=cut
196
197sub sync_job(&) {
198 my ($job) = @_;
199
200 my $busy = 1;
201 my @res;
202
203 # TODO: use suspend/resume instead
204 local $FREEZE = 1;
205
206 my $coro = Coro::async {
207 @res = eval { $job->() };
208 warn $@ if $@;
209 undef $busy;
210 };
211
212 if ($Coro::current == $Coro::main) {
213 $coro->prio (Coro::PRIO_MAX);
214 while ($busy) {
215 Coro::cede_notself;
216 Event::one_event unless Coro::nready;
217 }
218 } else {
219 $coro->join;
220 }
221
222 wantarray ? @res : $res[0]
223}
224
225=item $coro = cf::coro { BLOCK }
226
227Creates and returns a new coro. This coro is automcatially being canceled
228when the extension calling this is being unloaded.
229
230=cut
231
232sub coro(&) {
233 my $cb = shift;
234
235 my $coro; $coro = async {
236 eval {
237 $cb->();
238 };
239 warn $@ if $@;
240 };
241
242 $coro->on_destroy (sub {
243 delete $EXT_CORO{$coro+0};
244 });
245 $EXT_CORO{$coro+0} = $coro;
246
247 $coro
248}
249
250sub write_runtime {
251 my $runtime = cf::localdir . "/runtime";
252
253 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
254 or return;
255
256 my $value = $cf::RUNTIME;
257 (aio_write $fh, 0, (length $value), $value, 0) <= 0
258 and return;
259
260 aio_fsync $fh
261 and return;
262
263 close $fh
264 or return;
265
266 aio_rename "$runtime~", $runtime
267 and return;
268
269 1
270}
271
137=back 272=back
138 273
139=cut 274=cut
140 275
141############################################################################# 276#############################################################################
142 277
278package cf::path;
279
280sub new {
281 my ($class, $path, $base) = @_;
282
283 my $self = bless { }, $class;
284
285 if ($path =~ s{^\?random/}{}) {
286 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
287 $self->{random} = cf::from_json $data;
288 } else {
289 if ($path =~ s{^~([^/]+)?}{}) {
290 $self->{user_rel} = 1;
291
292 if (defined $1) {
293 $self->{user} = $1;
294 } elsif ($base =~ m{^~([^/]+)/}) {
295 $self->{user} = $1;
296 } else {
297 warn "cannot resolve user-relative path without user <$path,$base>\n";
298 }
299 } elsif ($path =~ /^\//) {
300 # already absolute
301 } else {
302 $base =~ s{[^/]+/?$}{};
303 return $class->new ("$base/$path");
304 }
305
306 for ($path) {
307 redo if s{/\.?/}{/};
308 redo if s{/[^/]+/\.\./}{/};
309 }
310 }
311
312 $self->{path} = $path;
313
314 $self
315}
316
317# the name / primary key / in-game path
318sub as_string {
319 my ($self) = @_;
320
321 $self->{user_rel} ? "~$self->{user}$self->{path}"
322 : $self->{random} ? "?random/$self->{path}"
323 : $self->{path}
324}
325
326# the displayed name, this is a one way mapping
327sub visible_name {
328 my ($self) = @_;
329
330# if (my $rmp = $self->{random}) {
331# # todo: be more intelligent about this
332# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
333# } else {
334 $self->as_string
335# }
336}
337
338# escape the /'s in the path
339sub _escaped_path {
340 # ∕ is U+2215
341 (my $path = $_[0]{path}) =~ s/\//∕/g;
342 $path
343}
344
345# the original (read-only) location
346sub load_path {
347 my ($self) = @_;
348
349 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
350}
351
352# the temporary/swap location
353sub save_path {
354 my ($self) = @_;
355
356 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
357 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
358 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
359}
360
361# the unique path, might be eq to save_path
362sub uniq_path {
363 my ($self) = @_;
364
365 $self->{user_rel} || $self->{random}
366 ? undef
367 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
368}
369
370# return random map parameters, or undef
371sub random_map_params {
372 my ($self) = @_;
373
374 $self->{random}
375}
376
377# this is somewhat ugly, but style maps do need special treatment
378sub is_style_map {
379 $_[0]{path} =~ m{^/styles/}
380}
381
382package cf;
383
384#############################################################################
385
143=head2 ATTACHABLE OBJECTS 386=head2 ATTACHABLE OBJECTS
144 387
145You can define and attach attachments to each "attachable" object in 388Many objects in crossfire are so-called attachable objects. That means you can
146crossfire+ (objects, players, clients, maps and the special "global" 389attach callbacks/event handlers (a collection of which is called an "attachment")
390to it. All such attachable objects support the following methods.
391
147class). In the following description, CLASS can be any of C<global>, 392In the following description, CLASS can be any of C<global>, C<object>
148C<object> C<player>, C<client> or C<map>. 393C<player>, C<client> or C<map> (i.e. the attachable objects in
394crossfire+).
149 395
150=over 4 396=over 4
151 397
398=item $attachable->attach ($attachment, key => $value...)
399
400=item $attachable->detach ($attachment)
401
402Attach/detach a pre-registered attachment to a specific object and give it
403the specified key/value pairs as arguments.
404
405Example, attach a minesweeper attachment to the given object, making it a
40610x10 minesweeper game:
407
408 $obj->attach (minesweeper => width => 10, height => 10);
409
410=item $bool = $attachable->attached ($name)
411
412Checks wether the named attachment is currently attached to the object.
413
414=item cf::CLASS->attach ...
415
416=item cf::CLASS->detach ...
417
418Define an anonymous attachment and attach it to all objects of the given
419CLASS. See the next function for an explanation of its arguments.
420
421You can attach to global events by using the C<cf::global> class.
422
423Example, log all player logins:
424
425 cf::player->attach (
426 on_login => sub {
427 my ($pl) = @_;
428 ...
429 },
430 );
431
432Example, attach to the jeweler skill:
433
434 cf::object->attach (
435 type => cf::SKILL,
436 subtype => cf::SK_JEWELER,
437 on_use_skill => sub {
438 my ($sk, $ob, $part, $dir, $msg) = @_;
439 ...
440 },
441 );
442
152=item cf::CLASS::attachment $name, ... 443=item cf::CLASS::attachment $name, ...
153 444
154Register an attachment by name through which attachable objects can refer 445Register an attachment by C<$name> through which attachable objects of the
155to this attachment. 446given CLASS can refer to this attachment.
156 447
157=item $bool = $attachable->attached ($name) 448Some classes such as crossfire maps and objects can specify attachments
449that are attached at load/instantiate time, thus the need for a name.
158 450
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 451These calls expect any number of the following handler/hook descriptions:
172descriptions:
173 452
174=over 4 453=over 4
175 454
176=item prio => $number 455=item prio => $number
177 456
203package and register them. Only handlers for eevents supported by the 482package and register them. Only handlers for eevents supported by the
204object/class are recognised. 483object/class are recognised.
205 484
206=back 485=back
207 486
487Example, define an attachment called "sockpuppet" that calls the given
488event handler when a monster attacks:
489
490 cf::object::attachment sockpuppet =>
491 on_skill_attack => sub {
492 my ($self, $victim) = @_;
493 ...
494 }
495 }
496
497=item $attachable->valid
498
499Just because you have a perl object does not mean that the corresponding
500C-level object still exists. If you try to access an object that has no
501valid C counterpart anymore you get an exception at runtime. This method
502can be used to test for existence of the C object part without causing an
503exception.
504
208=cut 505=cut
209 506
210# the following variables are defined in .xs and must not be re-created 507# the following variables are defined in .xs and must not be re-created
211our @CB_GLOBAL = (); # registry for all global events 508our @CB_GLOBAL = (); # registry for all global events
509our @CB_ATTACHABLE = (); # registry for all attachables
212our @CB_OBJECT = (); # all objects (should not be used except in emergency) 510our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213our @CB_PLAYER = (); 511our @CB_PLAYER = ();
214our @CB_CLIENT = (); 512our @CB_CLIENT = ();
215our @CB_TYPE = (); # registry for type (cf-object class) based events 513our @CB_TYPE = (); # registry for type (cf-object class) based events
216our @CB_MAP = (); 514our @CB_MAP = ();
217 515
218my %attachment; 516my %attachment;
219 517
220sub _attach_cb($$$$) { 518sub _attach_cb($$$$) {
221 my ($registry, $event, $prio, $cb) = @_; 519 my ($registry, $event, $prio, $cb) = @_;
226 524
227 @{$registry->[$event]} = sort 525 @{$registry->[$event]} = sort
228 { $a->[0] cmp $b->[0] } 526 { $a->[0] cmp $b->[0] }
229 @{$registry->[$event] || []}, $cb; 527 @{$registry->[$event] || []}, $cb;
230} 528}
529
530# hack
531my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231 532
232# attach handles attaching event callbacks 533# attach handles attaching event callbacks
233# the only thing the caller has to do is pass the correct 534# the only thing the caller has to do is pass the correct
234# registry (== where the callback attaches to). 535# registry (== where the callback attaches to).
235sub _attach { 536sub _attach {
237 538
238 my $object_type; 539 my $object_type;
239 my $prio = 0; 540 my $prio = 0;
240 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 541 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241 542
543 #TODO: get rid of this hack
544 if ($attachable_klass{$klass}) {
545 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
546 }
547
242 while (@arg) { 548 while (@arg) {
243 my $type = shift @arg; 549 my $type = shift @arg;
244 550
245 if ($type eq "prio") { 551 if ($type eq "prio") {
246 $prio = shift @arg; 552 $prio = shift @arg;
321 my ($obj, $name) = @_; 627 my ($obj, $name) = @_;
322 628
323 exists $obj->{_attachment}{$name} 629 exists $obj->{_attachment}{$name}
324} 630}
325 631
326for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 632for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327 eval "#line " . __LINE__ . " 'cf.pm' 633 eval "#line " . __LINE__ . " 'cf.pm'
328 sub cf::\L$klass\E::_attach_registry { 634 sub cf::\L$klass\E::_attach_registry {
329 (\\\@CB_$klass, KLASS_$klass) 635 (\\\@CB_$klass, KLASS_$klass)
330 } 636 }
331 637
367 } 673 }
368 674
369 0 675 0
370} 676}
371 677
372=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 678=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373 679
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, ...) 680=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379 681
380=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382Generate a global/object/player/map-specific event with the given arguments. 682Generate an object-specific event with the given arguments.
383 683
384This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 684This 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 685removed in future versions), and there is no public API to access override
386results (if you must, access C<@cf::invoke_results> directly). 686results (if you must, access C<@cf::invoke_results> directly).
387 687
388=back 688=back
389 689
390=cut 690=cut
391 691
392############################################################################# 692#############################################################################
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 693# object support
414 694
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 { 695sub reattach {
696 # basically do the same as instantiate, without calling instantiate
429 my ($obj) = @_; 697 my ($obj) = @_;
698
430 my $registry = $obj->registry; 699 my $registry = $obj->registry;
431 700
432 @$registry = (); 701 @$registry = ();
433 702
434 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 703 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
443 warn "object uses attachment '$name' that is not available, postponing.\n"; 712 warn "object uses attachment '$name' that is not available, postponing.\n";
444 } 713 }
445 } 714 }
446} 715}
447 716
448sub object_freezer_save { 717cf::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, 718 prio => -1000000,
719 on_instantiate => sub {
720 my ($obj, $data) = @_;
721
722 $data = from_json $data;
723
724 for (@$data) {
725 my ($name, $args) = @$_;
726
727 $obj->attach ($name, %{$args || {} });
728 }
729 },
730 on_reattach => \&reattach,
508 on_clone => sub { 731 on_clone => sub {
509 my ($src, $dst) = @_; 732 my ($src, $dst) = @_;
510 733
511 @{$dst->registry} = @{$src->registry}; 734 @{$dst->registry} = @{$src->registry};
512 735
514 737
515 %{$dst->{_attachment}} = %{$src->{_attachment}} 738 %{$dst->{_attachment}} = %{$src->{_attachment}}
516 if exists $src->{_attachment}; 739 if exists $src->{_attachment};
517 }, 740 },
518); 741);
742
743sub object_freezer_save {
744 my ($filename, $rdata, $objs) = @_;
745
746 sync_job {
747 if (length $$rdata) {
748 warn sprintf "saving %s (%d,%d)\n",
749 $filename, length $$rdata, scalar @$objs;
750
751 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
752 chmod SAVE_MODE, $fh;
753 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
754 aio_fsync $fh;
755 close $fh;
756
757 if (@$objs) {
758 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
759 chmod SAVE_MODE, $fh;
760 my $data = Storable::nfreeze { version => 1, objs => $objs };
761 aio_write $fh, 0, (length $data), $data, 0;
762 aio_fsync $fh;
763 close $fh;
764 aio_rename "$filename.pst~", "$filename.pst";
765 }
766 } else {
767 aio_unlink "$filename.pst";
768 }
769
770 aio_rename "$filename~", $filename;
771 } else {
772 warn "FATAL: $filename~: $!\n";
773 }
774 } else {
775 aio_unlink $filename;
776 aio_unlink "$filename.pst";
777 }
778 }
779}
780
781sub object_freezer_as_string {
782 my ($rdata, $objs) = @_;
783
784 use Data::Dumper;
785
786 $$rdata . Dumper $objs
787}
788
789sub object_thawer_load {
790 my ($filename) = @_;
791
792 my ($data, $av);
793
794 (aio_load $filename, $data) >= 0
795 or return;
796
797 unless (aio_stat "$filename.pst") {
798 (aio_load "$filename.pst", $av) >= 0
799 or return;
800 $av = eval { (Storable::thaw <$av>)->{objs} };
801 }
802
803 return ($data, $av);
804}
519 805
520############################################################################# 806#############################################################################
521# command handling &c 807# command handling &c
522 808
523=item cf::register_command $name => \&callback($ob,$args); 809=item cf::register_command $name => \&callback($ob,$args);
712 998
713=head2 CORE EXTENSIONS 999=head2 CORE EXTENSIONS
714 1000
715Functions and methods that extend core crossfire objects. 1001Functions and methods that extend core crossfire objects.
716 1002
1003=head3 cf::player
1004
717=over 4 1005=over 4
718 1006
719=item cf::player::exists $login 1007=item cf::player::exists $login
720 1008
721Returns true when the given account exists. 1009Returns true when the given account exists.
725sub cf::player::exists($) { 1013sub cf::player::exists($) {
726 cf::player::find $_[0] 1014 cf::player::find $_[0]
727 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1015 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
728} 1016}
729 1017
1018=item $player->ext_reply ($msgid, $msgtype, %msg)
1019
1020Sends an ext reply to the player.
1021
1022=cut
1023
1024sub cf::player::ext_reply($$$%) {
1025 my ($self, $id, %msg) = @_;
1026
1027 $msg{msgid} = $id;
1028
1029 $self->send ("ext " . to_json \%msg);
1030}
1031
1032=back
1033
1034=head3 cf::object::player
1035
1036=over 4
1037
730=item $player_object->reply ($npc, $msg[, $flags]) 1038=item $player_object->reply ($npc, $msg[, $flags])
731 1039
732Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1040Sends 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 1041can be C<undef>. Does the right thing when the player is currently in a
734dialogue with the given NPC character. 1042dialogue with the given NPC character.
735 1043
736=cut 1044=cut
737 1045
738# rough implementation of a future "reply" method that works 1046# rough implementation of a future "reply" method that works
739# with dialog boxes. 1047# with dialog boxes.
1048#TODO: the first argument must go, split into a $npc->reply_to ( method
740sub cf::object::player::reply($$$;$) { 1049sub cf::object::player::reply($$$;$) {
741 my ($self, $npc, $msg, $flags) = @_; 1050 my ($self, $npc, $msg, $flags) = @_;
742 1051
743 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1052 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744 1053
748 $msg = $npc->name . " says: $msg" if $npc; 1057 $msg = $npc->name . " says: $msg" if $npc;
749 $self->message ($msg, $flags); 1058 $self->message ($msg, $flags);
750 } 1059 }
751} 1060}
752 1061
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") 1062=item $player_object->may ("access")
768 1063
769Returns wether the given player is authorized to access resource "access" 1064Returns wether the given player is authorized to access resource "access"
770(e.g. "command_wizcast"). 1065(e.g. "command_wizcast").
771 1066
778 (ref $cf::CFG{"may_$access"} 1073 (ref $cf::CFG{"may_$access"}
779 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1074 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780 : $cf::CFG{"may_$access"}) 1075 : $cf::CFG{"may_$access"})
781} 1076}
782 1077
783=cut 1078=head3 cf::client
784 1079
785############################################################################# 1080=over 4
1081
1082=item $client->send_drawinfo ($text, $flags)
1083
1084Sends a drawinfo packet to the client. Circumvents output buffering so
1085should not be used under normal circumstances.
1086
1087=cut
1088
1089sub cf::client::send_drawinfo {
1090 my ($self, $text, $flags) = @_;
1091
1092 utf8::encode $text;
1093 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1094}
1095
1096
1097=item $success = $client->query ($flags, "text", \&cb)
1098
1099Queues a query to the client, calling the given callback with
1100the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1101C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1102
1103Queries can fail, so check the return code. Or don't, as queries will become
1104reliable at some point in the future.
1105
1106=cut
1107
1108sub cf::client::query {
1109 my ($self, $flags, $text, $cb) = @_;
1110
1111 return unless $self->state == ST_PLAYING
1112 || $self->state == ST_SETUP
1113 || $self->state == ST_CUSTOM;
1114
1115 $self->state (ST_CUSTOM);
1116
1117 utf8::encode $text;
1118 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1119
1120 $self->send_packet ($self->{query_queue}[0][0])
1121 if @{ $self->{query_queue} } == 1;
1122}
1123
1124cf::client->attach (
1125 on_reply => sub {
1126 my ($ns, $msg) = @_;
1127
1128 # this weird shuffling is so that direct followup queries
1129 # get handled first
1130 my $queue = delete $ns->{query_queue};
1131
1132 (shift @$queue)->[1]->($msg);
1133
1134 push @{ $ns->{query_queue} }, @$queue;
1135
1136 if (@{ $ns->{query_queue} } == @$queue) {
1137 if (@$queue) {
1138 $ns->send_packet ($ns->{query_queue}[0][0]);
1139 } else {
1140 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1141 }
1142 }
1143 },
1144);
1145
1146=item $client->coro (\&cb)
1147
1148Create a new coroutine, running the specified callback. The coroutine will
1149be automatically cancelled when the client gets destroyed (e.g. on logout,
1150or loss of connection).
1151
1152=cut
1153
1154sub cf::client::coro {
1155 my ($self, $cb) = @_;
1156
1157 my $coro; $coro = async {
1158 eval {
1159 $cb->();
1160 };
1161 warn $@ if $@;
1162 };
1163
1164 $coro->on_destroy (sub {
1165 delete $self->{_coro}{$coro+0};
1166 });
1167
1168 $self->{_coro}{$coro+0} = $coro;
1169
1170 $coro
1171}
1172
1173cf::client->attach (
1174 on_destroy => sub {
1175 my ($ns) = @_;
1176
1177 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1178 },
1179);
1180
1181=back
1182
786 1183
787=head2 SAFE SCRIPTING 1184=head2 SAFE SCRIPTING
788 1185
789Functions that provide a safe environment to compile and execute 1186Functions that provide a safe environment to compile and execute
790snippets of perl code without them endangering the safety of the server 1187snippets of perl code without them endangering the safety of the server
1010 local $/; 1407 local $/;
1011 *CFG = YAML::Syck::Load <$fh>; 1408 *CFG = YAML::Syck::Load <$fh>;
1012} 1409}
1013 1410
1014sub main { 1411sub main {
1412 # we must not ever block the main coroutine
1413 local $Coro::idle = sub {
1414 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1415 (Coro::unblock_sub {
1416 Event::one_event;
1417 })->();
1418 };
1419
1015 cfg_load; 1420 cfg_load;
1016 db_load; 1421 db_load;
1017 load_extensions; 1422 load_extensions;
1018 Event::loop; 1423 Event::loop;
1019} 1424}
1020 1425
1021############################################################################# 1426#############################################################################
1022# initialisation 1427# initialisation
1023 1428
1024sub _perl_reload(&) { 1429sub perl_reload() {
1025 my ($msg) = @_; 1430 # can/must only be called in main
1431 if ($Coro::current != $Coro::main) {
1432 warn "can only reload from main coroutine\n";
1433 return;
1434 }
1026 1435
1027 $msg->("reloading..."); 1436 warn "reloading...";
1437
1438 local $FREEZE = 1;
1439 cf::emergency_save;
1028 1440
1029 eval { 1441 eval {
1442 # if anything goes wrong in here, we should simply crash as we already saved
1443
1030 # cancel all watchers 1444 # cancel all watchers
1031 for (Event::all_watchers) { 1445 for (Event::all_watchers) {
1032 $_->cancel if $_->data & WF_AUTOCANCEL; 1446 $_->cancel if $_->data & WF_AUTOCANCEL;
1033 } 1447 }
1034 1448
1449 # cancel all extension coros
1450 $_->cancel for values %EXT_CORO;
1451 %EXT_CORO = ();
1452
1035 # unload all extensions 1453 # unload all extensions
1036 for (@exts) { 1454 for (@exts) {
1037 $msg->("unloading <$_>"); 1455 warn "unloading <$_>";
1038 unload_extension $_; 1456 unload_extension $_;
1039 } 1457 }
1040 1458
1041 # unload all modules loaded from $LIBDIR 1459 # unload all modules loaded from $LIBDIR
1042 while (my ($k, $v) = each %INC) { 1460 while (my ($k, $v) = each %INC) {
1043 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1461 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044 1462
1045 $msg->("removing <$k>"); 1463 warn "removing <$k>";
1046 delete $INC{$k}; 1464 delete $INC{$k};
1047 1465
1048 $k =~ s/\.pm$//; 1466 $k =~ s/\.pm$//;
1049 $k =~ s/\//::/g; 1467 $k =~ s/\//::/g;
1050 1468
1055 Symbol::delete_package $k; 1473 Symbol::delete_package $k;
1056 } 1474 }
1057 1475
1058 # sync database to disk 1476 # sync database to disk
1059 cf::db_sync; 1477 cf::db_sync;
1478 IO::AIO::flush;
1060 1479
1061 # get rid of safe::, as good as possible 1480 # get rid of safe::, as good as possible
1062 Symbol::delete_package "safe::$_" 1481 Symbol::delete_package "safe::$_"
1063 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1482 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064 1483
1065 # remove register_script_function callbacks 1484 # remove register_script_function callbacks
1066 # TODO 1485 # TODO
1067 1486
1068 # unload cf.pm "a bit" 1487 # unload cf.pm "a bit"
1071 # don't, removes xs symbols, too, 1490 # don't, removes xs symbols, too,
1072 # and global variables created in xs 1491 # and global variables created in xs
1073 #Symbol::delete_package __PACKAGE__; 1492 #Symbol::delete_package __PACKAGE__;
1074 1493
1075 # reload cf.pm 1494 # reload cf.pm
1076 $msg->("reloading cf.pm"); 1495 warn "reloading cf.pm";
1077 require cf; 1496 require cf;
1497 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078 1498
1079 # load config and database again 1499 # load config and database again
1080 cf::cfg_load; 1500 cf::cfg_load;
1081 cf::db_load; 1501 cf::db_load;
1082 1502
1083 # load extensions 1503 # load extensions
1084 $msg->("load extensions"); 1504 warn "load extensions";
1085 cf::load_extensions; 1505 cf::load_extensions;
1086 1506
1087 # reattach attachments to objects 1507 # reattach attachments to objects
1088 $msg->("reattach"); 1508 warn "reattach";
1089 _global_reattach; 1509 _global_reattach;
1090 }; 1510 };
1091 $msg->($@) if $@;
1092 1511
1093 $msg->("reloaded"); 1512 if ($@) {
1513 warn $@;
1514 warn "error while reloading, exiting.";
1515 exit 1;
1516 }
1517
1518 warn "reloaded successfully";
1094}; 1519};
1095 1520
1096sub perl_reload() { 1521#############################################################################
1097 _perl_reload { 1522
1098 warn $_[0]; 1523unless ($LINK_MAP) {
1099 print "$_[0]\n"; 1524 $LINK_MAP = cf::map::new;
1100 }; 1525
1526 $LINK_MAP->width (41);
1527 $LINK_MAP->height (41);
1528 $LINK_MAP->alloc;
1529 $LINK_MAP->path ("{link}");
1530 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1531 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1101} 1532}
1102 1533
1103register "<global>", __PACKAGE__; 1534register "<global>", __PACKAGE__;
1104 1535
1105register_command "perl-reload" => sub { 1536register_command "perl-reload" => sub {
1106 my ($who, $arg) = @_; 1537 my ($who, $arg) = @_;
1107 1538
1108 if ($who->flag (FLAG_WIZ)) { 1539 if ($who->flag (FLAG_WIZ)) {
1540 $who->message ("start of reload.");
1109 _perl_reload { 1541 perl_reload;
1110 warn $_[0]; 1542 $who->message ("end of reload.");
1111 $who->message ($_[0]);
1112 };
1113 } 1543 }
1114}; 1544};
1115 1545
1116unshift @INC, $LIBDIR; 1546unshift @INC, $LIBDIR;
1117 1547
1118$TICK_WATCHER = Event->timer ( 1548$TICK_WATCHER = Event->timer (
1549 reentrant => 0,
1119 prio => 0, 1550 prio => 0,
1120 at => $NEXT_TICK || 1, 1551 at => $NEXT_TICK || $TICK,
1121 data => WF_AUTOCANCEL, 1552 data => WF_AUTOCANCEL,
1122 cb => sub { 1553 cb => sub {
1554 unless ($FREEZE) {
1123 cf::server_tick; # one server iteration 1555 cf::server_tick; # one server iteration
1556 $RUNTIME += $TICK;
1557 }
1124 1558
1125 my $NOW = Event::time;
1126 $NEXT_TICK += $TICK; 1559 $NEXT_TICK += $TICK;
1127 1560
1128 # if we are delayed by four ticks or more, skip them all 1561 # if we are delayed by four ticks or more, skip them all
1129 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1562 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130 1563
1131 $TICK_WATCHER->at ($NEXT_TICK); 1564 $TICK_WATCHER->at ($NEXT_TICK);
1132 $TICK_WATCHER->start; 1565 $TICK_WATCHER->start;
1133 }, 1566 },
1134); 1567);
1135 1568
1136IO::AIO::max_poll_time $TICK * 0.2; 1569IO::AIO::max_poll_time $TICK * 0.2;
1137 1570
1571Event->io (
1138Event->io (fd => IO::AIO::poll_fileno, 1572 fd => IO::AIO::poll_fileno,
1139 poll => 'r', 1573 poll => 'r',
1140 prio => 5, 1574 prio => 5,
1141 data => WF_AUTOCANCEL, 1575 data => WF_AUTOCANCEL,
1142 cb => \&IO::AIO::poll_cb); 1576 cb => \&IO::AIO::poll_cb,
1577);
1578
1579Event->timer (
1580 data => WF_AUTOCANCEL,
1581 after => 0,
1582 interval => 10,
1583 cb => sub {
1584 (Coro::unblock_sub {
1585 write_runtime
1586 or warn "ERROR: unable to write runtime file: $!";
1587 })->();
1588 },
1589);
1143 1590
11441 15911
1145 1592

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines