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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines