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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines