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.48 by root, Sun Aug 27 15:24:22 2006 UTC vs.
Revision 1.164 by root, Thu Jan 11 01:24:25 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
369package cf::path;
370
371use overload
372 '""' => \&as_string;
373
374# used to convert map paths into valid unix filenames by repalcing / by ∕
375our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
376
377sub register {
378 my ($pkg, $prefix) = @_;
379
380 $EXT_MAP{$prefix} = $pkg;
381}
382
383sub new {
384 my ($class, $path, $base) = @_;
385
386 return $path if ref $path;
387
388 my $self = {};
389
390 # {... are special paths that are not being touched
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
521sub unlink_save {
522 my ($self) = @_;
523
524 utf8::encode (my $save = $self->save_path);
525 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
526 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
527}
528
529package cf;
530
531#############################################################################
532
533=head2 ATTACHABLE OBJECTS
534
535Many objects in crossfire are so-called attachable objects. That means you can
536attach callbacks/event handlers (a collection of which is called an "attachment")
537to it. All such attachable objects support the following methods.
538
539In the following description, CLASS can be any of C<global>, C<object>
540C<player>, C<client> or C<map> (i.e. the attachable objects in
541crossfire+).
542
543=over 4
544
110=item $object->attach ($attachment, key => $value...) 545=item $attachable->attach ($attachment, key => $value...)
111 546
112Attach a pre-registered attachment to an object. 547=item $attachable->detach ($attachment)
113 548
114=item $player->attach ($attachment, key => $value...) 549Attach/detach a pre-registered attachment to a specific object and give it
550the specified key/value pairs as arguments.
115 551
116Attach a pre-registered attachment to a player. 552Example, attach a minesweeper attachment to the given object, making it a
55310x10 minesweeper game:
117 554
118=item $map->attach ($attachment, key => $value...) # not yet persistent 555 $obj->attach (minesweeper => width => 10, height => 10);
119 556
120Attach a pre-registered attachment to a map. 557=item $bool = $attachable->attached ($name)
121 558
122=item cf::attach_global ... 559Checks wether the named attachment is currently attached to the object.
123 560
124Attach handlers for global events. 561=item cf::CLASS->attach ...
125 562
126This and all following C<attach_*>-functions expect any number of the 563=item cf::CLASS->detach ...
127following handler/hook descriptions: 564
565Define an anonymous attachment and attach it to all objects of the given
566CLASS. See the next function for an explanation of its arguments.
567
568You can attach to global events by using the C<cf::global> class.
569
570Example, log all player logins:
571
572 cf::player->attach (
573 on_login => sub {
574 my ($pl) = @_;
575 ...
576 },
577 );
578
579Example, attach to the jeweler skill:
580
581 cf::object->attach (
582 type => cf::SKILL,
583 subtype => cf::SK_JEWELER,
584 on_use_skill => sub {
585 my ($sk, $ob, $part, $dir, $msg) = @_;
586 ...
587 },
588 );
589
590=item cf::CLASS::attachment $name, ...
591
592Register an attachment by C<$name> through which attachable objects of the
593given CLASS can refer to this attachment.
594
595Some classes such as crossfire maps and objects can specify attachments
596that are attached at load/instantiate time, thus the need for a name.
597
598These calls expect any number of the following handler/hook descriptions:
128 599
129=over 4 600=over 4
130 601
131=item prio => $number 602=item prio => $number
132 603
134by another C<prio> setting). Lower priority handlers get executed 605by another C<prio> setting). Lower priority handlers get executed
135earlier. The default priority is C<0>, and many built-in handlers are 606earlier. The default priority is C<0>, and many built-in handlers are
136registered at priority C<-1000>, so lower priorities should not be used 607registered at priority C<-1000>, so lower priorities should not be used
137unless you know what you are doing. 608unless you know what you are doing.
138 609
610=item type => $type
611
612(Only for C<< cf::object->attach >> calls), limits the attachment to the
613given type of objects only (the additional parameter C<subtype> can be
614used to further limit to the given subtype).
615
139=item on_I<event> => \&cb 616=item on_I<event> => \&cb
140 617
141Call the given code reference whenever the named event happens (event is 618Call 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 619something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
143handlers are recognised generally depends on the type of object these 620handlers are recognised generally depends on the type of object these
152package and register them. Only handlers for eevents supported by the 629package and register them. Only handlers for eevents supported by the
153object/class are recognised. 630object/class are recognised.
154 631
155=back 632=back
156 633
157=item cf::attach_to_type $object_type, $subtype, ... 634Example, define an attachment called "sockpuppet" that calls the given
635event handler when a monster attacks:
158 636
159Attach handlers for a specific object type (e.g. TRANSPORT) and 637 cf::object::attachment sockpuppet =>
160subtype. If C<$subtype> is zero or undef, matches all objects of the given 638 on_skill_attack => sub {
161type. 639 my ($self, $victim) = @_;
640 ...
641 }
642 }
162 643
163=item cf::attach_to_objects ... 644=item $attachable->valid
164 645
165Attach handlers to all objects. Do not use this except for debugging or 646Just 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 647C-level object still exists. If you try to access an object that has no
167the game. 648valid C counterpart anymore you get an exception at runtime. This method
168 649can be used to test for existence of the C object part without causing an
169=item cf::attach_to_players ... 650exception.
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 651
179=cut 652=cut
180 653
181# the following variables are defined in .xs and must not be re-created 654# the following variables are defined in .xs and must not be re-created
182our @CB_GLOBAL = (); # registry for all global events 655our @CB_GLOBAL = (); # registry for all global events
656our @CB_ATTACHABLE = (); # registry for all attachables
183our @CB_OBJECT = (); # all objects (should not be used except in emergency) 657our @CB_OBJECT = (); # all objects (should not be used except in emergency)
184our @CB_PLAYER = (); 658our @CB_PLAYER = ();
659our @CB_CLIENT = ();
185our @CB_TYPE = (); # registry for type (cf-object class) based events 660our @CB_TYPE = (); # registry for type (cf-object class) based events
186our @CB_MAP = (); 661our @CB_MAP = ();
187 662
188my %attachment; 663my %attachment;
189 664
190sub _attach_cb($\%$$$) { 665sub _attach_cb($$$$) {
191 my ($registry, $undo, $event, $prio, $cb) = @_; 666 my ($registry, $event, $prio, $cb) = @_;
192 667
193 use sort 'stable'; 668 use sort 'stable';
194 669
195 $cb = [$prio, $cb]; 670 $cb = [$prio, $cb];
196 671
197 @{$registry->[$event]} = sort 672 @{$registry->[$event]} = sort
198 { $a->[0] cmp $b->[0] } 673 { $a->[0] cmp $b->[0] }
199 @{$registry->[$event] || []}, $cb; 674 @{$registry->[$event] || []}, $cb;
200
201 push @{$undo->{cb}}, [$event, $cb];
202} 675}
676
677# hack
678my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
203 679
204# attach handles attaching event callbacks 680# attach handles attaching event callbacks
205# the only thing the caller has to do is pass the correct 681# the only thing the caller has to do is pass the correct
206# registry (== where the callback attaches to). 682# registry (== where the callback attaches to).
207sub _attach(\@$@) { 683sub _attach {
208 my ($registry, $klass, @arg) = @_; 684 my ($registry, $klass, @arg) = @_;
209 685
686 my $object_type;
210 my $prio = 0; 687 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; 688 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
689
690 #TODO: get rid of this hack
691 if ($attachable_klass{$klass}) {
692 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
693 }
218 694
219 while (@arg) { 695 while (@arg) {
220 my $type = shift @arg; 696 my $type = shift @arg;
221 697
222 if ($type eq "prio") { 698 if ($type eq "prio") {
223 $prio = shift @arg; 699 $prio = shift @arg;
224 700
701 } elsif ($type eq "type") {
702 $object_type = shift @arg;
703 $registry = $CB_TYPE[$object_type] ||= [];
704
705 } elsif ($type eq "subtype") {
706 defined $object_type or Carp::croak "subtype specified without type";
707 my $object_subtype = shift @arg;
708 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
709
225 } elsif ($type eq "package") { 710 } elsif ($type eq "package") {
226 my $pkg = shift @arg; 711 my $pkg = shift @arg;
227 712
228 while (my ($name, $id) = each %cb_id) { 713 while (my ($name, $id) = each %cb_id) {
229 if (my $cb = $pkg->can ($name)) { 714 if (my $cb = $pkg->can ($name)) {
230 _attach_cb $registry, %undo, $id, $prio, $cb; 715 _attach_cb $registry, $id, $prio, $cb;
231 } 716 }
232 } 717 }
233 718
234 } elsif (exists $cb_id{$type}) { 719 } elsif (exists $cb_id{$type}) {
235 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 720 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236 721
237 } elsif (ref $type) { 722 } elsif (ref $type) {
238 warn "attaching objects not supported, ignoring.\n"; 723 warn "attaching objects not supported, ignoring.\n";
239 724
240 } else { 725 } else {
241 shift @arg; 726 shift @arg;
242 warn "attach argument '$type' not supported, ignoring.\n"; 727 warn "attach argument '$type' not supported, ignoring.\n";
243 } 728 }
244 } 729 }
245
246 \%undo
247} 730}
248 731
249sub _attach_attachment { 732sub _object_attach {
250 my ($obj, $name, %arg) = @_; 733 my ($obj, $name, %arg) = @_;
251 734
252 my $res; 735 return if exists $obj->{_attachment}{$name};
253 736
254 if (my $attach = $attachment{$name}) { 737 if (my $attach = $attachment{$name}) {
255 my $registry = $obj->registry; 738 my $registry = $obj->registry;
256 739
257 for (@$attach) { 740 for (@$attach) {
258 my ($klass, @attach) = @$_; 741 my ($klass, @attach) = @$_;
259 $res = _attach @$registry, $klass, @attach; 742 _attach $registry, $klass, @attach;
260 } 743 }
261 744
262 $obj->{$name} = \%arg; 745 $obj->{$name} = \%arg;
263 } else { 746 } else {
264 warn "object uses attachment '$name' that is not available, postponing.\n"; 747 warn "object uses attachment '$name' that is not available, postponing.\n";
265 } 748 }
266 749
267 push @{$obj->{_attachment}}, $name; 750 $obj->{_attachment}{$name} = undef;
268
269 $res->{attachment} = $name;
270 $res
271} 751}
272 752
273sub cf::object::attach { 753sub cf::attachable::attach {
754 if (ref $_[0]) {
755 _object_attach @_;
756 } else {
757 _attach shift->_attach_registry, @_;
758 }
759};
760
761# all those should be optimised
762sub cf::attachable::detach {
274 my ($obj, $name, %arg) = @_; 763 my ($obj, $name) = @_;
275 764
276 _attach_attachment $obj, $name, %arg; 765 if (ref $obj) {
277} 766 delete $obj->{_attachment}{$name};
767 reattach ($obj);
768 } else {
769 Carp::croak "cannot, currently, detach class attachments";
770 }
771};
278 772
279sub cf::player::attach { 773sub cf::attachable::attached {
280 my ($obj, $name, %arg) = @_; 774 my ($obj, $name) = @_;
281 775
282 _attach_attachment KLASS_PLAYER, $obj, $name, %arg; 776 exists $obj->{_attachment}{$name}
283} 777}
284 778
285sub cf::map::attach { 779for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
286 my ($obj, $name, %arg) = @_; 780 eval "#line " . __LINE__ . " 'cf.pm'
781 sub cf::\L$klass\E::_attach_registry {
782 (\\\@CB_$klass, KLASS_$klass)
783 }
287 784
288 _attach_attachment KLASS_MAP, $obj, $name, %arg; 785 sub cf::\L$klass\E::attachment {
289}
290
291sub attach_global {
292 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
293}
294
295sub attach_to_type {
296 my $type = shift;
297 my $subtype = shift;
298
299 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300}
301
302sub attach_to_objects {
303 _attach @CB_OBJECT, KLASS_OBJECT, @_
304}
305
306sub attach_to_players {
307 _attach @CB_PLAYER, KLASS_PLAYER, @_
308}
309
310sub attach_to_maps {
311 _attach @CB_MAP, KLASS_MAP, @_
312}
313
314sub register_attachment {
315 my $name = shift; 786 my \$name = shift;
316 787
317 $attachment{$name} = [[KLASS_OBJECT, @_]]; 788 \$attachment{\$name} = [[KLASS_$klass, \@_]];
789 }
790 ";
791 die if $@;
318} 792}
319 793
320our $override; 794our $override;
321our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 795our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322 796
336 for (@$callbacks) { 810 for (@$callbacks) {
337 eval { &{$_->[1]} }; 811 eval { &{$_->[1]} };
338 812
339 if ($@) { 813 if ($@) {
340 warn "$@"; 814 warn "$@";
341 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 815 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342 override; 816 override;
343 } 817 }
344 818
345 return 1 if $override; 819 return 1 if $override;
346 } 820 }
347 821
348 0 822 0
349} 823}
824
825=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
826
827=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
828
829Generate an object-specific event with the given arguments.
830
831This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
832removed in future versions), and there is no public API to access override
833results (if you must, access C<@cf::invoke_results> directly).
834
835=back
836
837=cut
350 838
351############################################################################# 839#############################################################################
352# object support 840# object support
353 841
354sub instantiate {
355 my ($obj, $data) = @_;
356
357 $data = from_json $data;
358
359 for (@$data) {
360 my ($name, $args) = @$_;
361 attach $obj, $name, %{$args || {} };
362 }
363}
364
365# basically do the same as instantiate, without calling instantiate
366sub reattach { 842sub reattach {
843 # basically do the same as instantiate, without calling instantiate
367 my ($obj) = @_; 844 my ($obj) = @_;
845
368 my $registry = $obj->registry; 846 my $registry = $obj->registry;
369 847
370 @$registry = (); 848 @$registry = ();
371 849
850 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
851
372 for my $name (@{ $obj->{_attachment} }) { 852 for my $name (keys %{ $obj->{_attachment} || {} }) {
373 if (my $attach = $attachment{$name}) { 853 if (my $attach = $attachment{$name}) {
374 for (@$attach) { 854 for (@$attach) {
375 my ($klass, @attach) = @$_; 855 my ($klass, @attach) = @$_;
376 _attach @$registry, $klass, @attach; 856 _attach $registry, $klass, @attach;
377 } 857 }
378 } else { 858 } else {
379 warn "object uses attachment '$name' that is not available, postponing.\n"; 859 warn "object uses attachment '$name' that is not available, postponing.\n";
380 } 860 }
381 } 861 }
382} 862}
383 863
864cf::attachable->attach (
865 prio => -1000000,
866 on_instantiate => sub {
867 my ($obj, $data) = @_;
868
869 $data = from_json $data;
870
871 for (@$data) {
872 my ($name, $args) = @$_;
873
874 $obj->attach ($name, %{$args || {} });
875 }
876 },
877 on_reattach => \&reattach,
878 on_clone => sub {
879 my ($src, $dst) = @_;
880
881 @{$dst->registry} = @{$src->registry};
882
883 %$dst = %$src;
884
885 %{$dst->{_attachment}} = %{$src->{_attachment}}
886 if exists $src->{_attachment};
887 },
888);
889
384sub object_freezer_save { 890sub object_freezer_save {
385 my ($filename, $objs) = @_; 891 my ($filename, $rdata, $objs) = @_;
386 892
387 $filename .= ".pst"; 893 sync_job {
894 if (length $$rdata) {
895 warn sprintf "saving %s (%d,%d)\n",
896 $filename, length $$rdata, scalar @$objs;
388 897
389 if (@$objs) { 898 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
390 open my $fh, ">:raw", "$filename~"; 899 chmod SAVE_MODE, $fh;
391 chmod $fh, SAVE_MODE; 900 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
392 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 901 aio_fsync $fh;
393 close $fh; 902 close $fh;
903
904 if (@$objs) {
905 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
906 chmod SAVE_MODE, $fh;
907 my $data = Storable::nfreeze { version => 1, objs => $objs };
908 aio_write $fh, 0, (length $data), $data, 0;
909 aio_fsync $fh;
910 close $fh;
911 aio_rename "$filename.pst~", "$filename.pst";
912 }
913 } else {
914 aio_unlink "$filename.pst";
915 }
916
394 rename "$filename~", $filename; 917 aio_rename "$filename~", $filename;
918 } else {
919 warn "FATAL: $filename~: $!\n";
920 }
395 } else { 921 } else {
396 unlink $filename; 922 aio_unlink $filename;
923 aio_unlink "$filename.pst";
924 }
397 } 925 }
926}
927
928sub object_freezer_as_string {
929 my ($rdata, $objs) = @_;
930
931 use Data::Dumper;
932
933 $$rdata . Dumper $objs
398} 934}
399 935
400sub object_thawer_load { 936sub object_thawer_load {
401 my ($filename) = @_; 937 my ($filename) = @_;
402 938
403 open my $fh, "<:raw:perlio", "$filename.pst" 939 my ($data, $av);
940
941 (aio_load $filename, $data) >= 0
404 or return; 942 or return;
405 943
406 eval { local $/; (Storable::thaw <$fh>)->{objs} } 944 unless (aio_stat "$filename.pst") {
407} 945 (aio_load "$filename.pst", $av) >= 0
408 946 or return;
409attach_to_objects 947 $av = eval { (Storable::thaw $av)->{objs} };
410 prio => -1000000,
411 on_clone => sub {
412 my ($src, $dst) = @_;
413
414 @{$dst->registry} = @{$src->registry};
415
416 %$dst = %$src;
417
418 $dst->{_attachment} = [@{ $src->{_attachment} }]
419 if exists $src->{_attachment};
420 }, 948 }
421; 949
950 warn sprintf "loading %s (%d)\n",
951 $filename, length $data, scalar @{$av || []};#d#
952 return ($data, $av);
953}
422 954
423############################################################################# 955#############################################################################
424# old plug-in events 956# command handling &c
425 957
426sub inject_event { 958=item cf::register_command $name => \&callback($ob,$args);
427 my $extension = shift;
428 my $event_code = shift;
429 959
430 my $cb = $hook[$event_code]{$extension} 960Register a callback for execution when the client sends the user command
431 or return; 961$name.
432 962
433 &$cb 963=cut
434}
435
436sub inject_global_event {
437 my $event = shift;
438
439 my $cb = $hook[$event]
440 or return;
441
442 List::Util::max map &$_, values %$cb
443}
444
445sub inject_command {
446 my ($name, $obj, $params) = @_;
447
448 for my $cmd (@{ $command{$name} }) {
449 $cmd->[1]->($obj, $params);
450 }
451
452 -1
453}
454 964
455sub register_command { 965sub register_command {
456 my ($name, $time, $cb) = @_; 966 my ($name, $cb) = @_;
457 967
458 my $caller = caller; 968 my $caller = caller;
459 #warn "registering command '$name/$time' to '$caller'"; 969 #warn "registering command '$name/$time' to '$caller'";
460 970
461 push @{ $command{$name} }, [$time, $cb, $caller]; 971 push @{ $COMMAND{$name} }, [$caller, $cb];
462 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
463} 972}
973
974=item cf::register_extcmd $name => \&callback($pl,$packet);
975
976Register a callbackf ro execution when the client sends an extcmd packet.
977
978If the callback returns something, it is sent back as if reply was being
979called.
980
981=cut
464 982
465sub register_extcmd { 983sub register_extcmd {
466 my ($name, $cb) = @_; 984 my ($name, $cb) = @_;
467 985
468 my $caller = caller; 986 $EXTCMD{$name} = $cb;
469 #warn "registering extcmd '$name' to '$caller'";
470
471 $extcmd{$name} = [$cb, $caller];
472} 987}
473 988
474sub register { 989cf::player->attach (
475 my ($base, $pkg) = @_; 990 on_command => sub {
991 my ($pl, $name, $params) = @_;
476 992
477 #TODO 993 my $cb = $COMMAND{$name}
478} 994 or return;
995
996 for my $cmd (@$cb) {
997 $cmd->[1]->($pl->ob, $params);
998 }
999
1000 cf::override;
1001 },
1002 on_extcmd => sub {
1003 my ($pl, $buf) = @_;
1004
1005 my $msg = eval { from_json $buf };
1006
1007 if (ref $msg) {
1008 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
1009 if (my %reply = $cb->($pl, $msg)) {
1010 $pl->ext_reply ($msg->{msgid}, %reply);
1011 }
1012 }
1013 } else {
1014 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1015 }
1016
1017 cf::override;
1018 },
1019);
479 1020
480sub load_extension { 1021sub load_extension {
481 my ($path) = @_; 1022 my ($path) = @_;
482 1023
483 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1024 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
484 my $base = $1; 1025 my $base = $1;
485 my $pkg = $1; 1026 my $pkg = $1;
486 $pkg =~ s/[^[:word:]]/_/g; 1027 $pkg =~ s/[^[:word:]]/_/g;
487 $pkg = "ext::$pkg"; 1028 $pkg = "ext::$pkg";
488 1029
489 warn "loading '$path' into '$pkg'\n"; 1030 warn "... loading '$path' into '$pkg'\n";
490 1031
491 open my $fh, "<:utf8", $path 1032 open my $fh, "<:utf8", $path
492 or die "$path: $!"; 1033 or die "$path: $!";
493 1034
494 my $source = 1035 my $source =
496 . "#line 1 \"$path\"\n{\n" 1037 . "#line 1 \"$path\"\n{\n"
497 . (do { local $/; <$fh> }) 1038 . (do { local $/; <$fh> })
498 . "\n};\n1"; 1039 . "\n};\n1";
499 1040
500 eval $source 1041 eval $source
501 or die "$path: $@"; 1042 or die $@ ? "$path: $@\n"
1043 : "extension disabled.\n";
502 1044
503 push @exts, $pkg; 1045 push @EXTS, $pkg;
504 $ext_pkg{$base} = $pkg;
505
506# no strict 'refs';
507# @{"$pkg\::ISA"} = ext::;
508
509 register $base, $pkg;
510}
511
512sub unload_extension {
513 my ($pkg) = @_;
514
515 warn "removing extension $pkg\n";
516
517 # remove hooks
518 #TODO
519# for my $idx (0 .. $#PLUGIN_EVENT) {
520# delete $hook[$idx]{$pkg};
521# }
522
523 # remove commands
524 for my $name (keys %command) {
525 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
526
527 if (@cb) {
528 $command{$name} = \@cb;
529 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
530 } else {
531 delete $command{$name};
532 delete $COMMAND{"$name\000"};
533 }
534 }
535
536 # remove extcmds
537 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
538 delete $extcmd{$name};
539 }
540
541 if (my $cb = $pkg->can ("unload")) {
542 eval {
543 $cb->($pkg);
544 1
545 } or warn "$pkg unloaded, but with errors: $@";
546 }
547
548 Symbol::delete_package $pkg;
549} 1046}
550 1047
551sub load_extensions { 1048sub load_extensions {
552 my $LIBDIR = maps_directory "perl";
553
554 for my $ext (<$LIBDIR/*.ext>) { 1049 for my $ext (<$LIBDIR/*.ext>) {
555 next unless -r $ext; 1050 next unless -r $ext;
556 eval { 1051 eval {
557 load_extension $ext; 1052 load_extension $ext;
558 1 1053 1
559 } or warn "$ext not loaded: $@"; 1054 } or warn "$ext not loaded: $@";
560 } 1055 }
561} 1056}
562 1057
563sub _perl_reload(&) {
564 my ($msg) = @_;
565
566 $msg->("reloading...");
567
568 eval {
569 # 1. cancel all watchers
570 $_->cancel for Event::all_watchers;
571
572 # 2. unload all extensions
573 for (@exts) {
574 $msg->("unloading <$_>");
575 unload_extension $_;
576 }
577
578 # 3. unload all modules loaded from $LIBDIR
579 while (my ($k, $v) = each %INC) {
580 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582 $msg->("removing <$k>");
583 delete $INC{$k};
584
585 $k =~ s/\.pm$//;
586 $k =~ s/\//::/g;
587
588 if (my $cb = $k->can ("unload_module")) {
589 $cb->();
590 }
591
592 Symbol::delete_package $k;
593 }
594
595 # 4. get rid of safe::, as good as possible
596 Symbol::delete_package "safe::$_"
597 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599 # 5. remove register_script_function callbacks
600 # TODO
601
602 # 6. unload cf.pm "a bit"
603 delete $INC{"cf.pm"};
604
605 # don't, removes xs symbols, too,
606 # and global variables created in xs
607 #Symbol::delete_package __PACKAGE__;
608
609 # 7. reload cf.pm
610 $msg->("reloading cf.pm");
611 require cf;
612 };
613 $msg->($@) if $@;
614
615 $msg->("reloaded");
616};
617
618sub perl_reload() {
619 _perl_reload {
620 warn $_[0];
621 print "$_[0]\n";
622 };
623}
624
625register_command "perl-reload", 0, sub {
626 my ($who, $arg) = @_;
627
628 if ($who->flag (FLAG_WIZ)) {
629 _perl_reload {
630 warn $_[0];
631 $who->message ($_[0]);
632 };
633 }
634};
635
636#############################################################################
637# extcmd framework, basically convert ext <msg>
638# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639
640attach_to_players
641 on_extcmd => sub {
642 my ($pl, $buf) = @_;
643
644 my $msg = eval { from_json $buf };
645
646 if (ref $msg) {
647 if (my $cb = $extcmd{$msg->{msgtype}}) {
648 if (my %reply = $cb->[0]->($pl, $msg)) {
649 $pl->ext_reply ($msg->{msgid}, %reply);
650 }
651 }
652 } else {
653 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
654 }
655
656 cf::override;
657 },
658;
659
660############################################################################# 1058#############################################################################
661# load/save/clean perl data associated with a map 1059# load/save/clean perl data associated with a map
662 1060
663*cf::mapsupport::on_clean = sub { 1061*cf::mapsupport::on_clean = sub {
664 my ($map) = @_; 1062 my ($map) = @_;
665 1063
666 my $path = $map->tmpname; 1064 my $path = $map->tmpname;
667 defined $path or return; 1065 defined $path or return;
668 1066
669 unlink "$path.cfperl";
670 unlink "$path.pst"; 1067 unlink "$path.pst";
671}; 1068};
672 1069
673*cf::mapsupport::on_swapin = 1070cf::map->attach (prio => -10000, package => cf::mapsupport::);
674*cf::mapsupport::on_load = sub { 1071
1072#############################################################################
1073
1074=head2 CORE EXTENSIONS
1075
1076Functions and methods that extend core crossfire objects.
1077
1078=cut
1079
1080package cf::player;
1081
1082use Coro::AIO;
1083
1084=head3 cf::player
1085
1086=over 4
1087
1088=item cf::player::find $login
1089
1090Returns the given player object, loading it if necessary (might block).
1091
1092=cut
1093
1094sub playerdir($) {
1095 cf::localdir
1096 . "/"
1097 . cf::playerdir
1098 . "/"
1099 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1100}
1101
1102sub path($) {
1103 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1104
1105 (playerdir $login) . "/$login.pl"
1106}
1107
1108sub find_active($) {
1109 $cf::PLAYER{$_[0]}
1110 and $cf::PLAYER{$_[0]}->active
1111 and $cf::PLAYER{$_[0]}
1112}
1113
1114sub exists($) {
1115 my ($login) = @_;
1116
1117 $cf::PLAYER{$login}
1118 or cf::sync_job { !aio_stat $login }
1119}
1120
1121sub find($) {
1122 return $cf::PLAYER{$_[0]} || do {
1123 my $login = $_[0];
1124
1125 my $guard = cf::lock_acquire "user_find:$login";
1126
1127 $cf::PLAYER{$_[0]} || do {
1128 my $pl = load_pl path $login
1129 or return;
1130 $cf::PLAYER{$login} = $pl
1131 }
1132 }
1133}
1134
1135sub save($) {
1136 my ($pl) = @_;
1137
1138 return if $pl->{deny_save};
1139
1140 my $path = path $pl;
1141 my $guard = cf::lock_acquire "user_save:$path";
1142
1143 return if $pl->{deny_save};
1144
1145 aio_mkdir playerdir $pl, 0770;
1146 $pl->{last_save} = $cf::RUNTIME;
1147
1148 $pl->save_pl ($path);
1149 Coro::cede;
1150}
1151
1152sub new($) {
1153 my ($login) = @_;
1154
1155 my $self = create;
1156
1157 $self->ob->name ($login);
1158 $self->{deny_save} = 1;
1159
1160 $cf::PLAYER{$login} = $self;
1161
1162 $self
1163}
1164
1165=item $pl->quit_character
1166
1167Nukes the player without looking back. If logged in, the connection will
1168be destroyed. May block for a long time.
1169
1170=cut
1171
1172sub quit_character {
1173 my ($pl) = @_;
1174
1175 $pl->{deny_save} = 1;
1176 $pl->password ("*"); # this should lock out the player until we nuked the dir
1177
1178 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1179 $pl->deactivate;
1180 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1181 $pl->ns->destroy if $pl->ns;
1182
1183 my $path = playerdir $pl;
1184 my $temp = "$path~$cf::RUNTIME~deleting~";
1185 aio_rename $path, $temp;
1186 delete $cf::PLAYER{$pl->ob->name};
1187 $pl->destroy;
1188 IO::AIO::aio_rmtree $temp;
1189}
1190
1191=item cf::player::list_logins
1192
1193Returns am arrayref of all valid playernames in the system, can take a
1194while and may block, so not sync_job-capable, ever.
1195
1196=cut
1197
1198sub list_logins {
1199 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1200 or return [];
1201
1202 my @logins;
1203
1204 for my $login (@$dirs) {
1205 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1206 aio_read $fh, 0, 512, my $buf, 0 or next;
1207 $buf !~ /^password -------------$/m or next; # official not-valid tag
1208
1209 utf8::decode $login;
1210 push @logins, $login;
1211 }
1212
1213 \@logins
1214}
1215
1216=item $player->maps
1217
1218Returns an arrayref of cf::path's of all maps that are private for this
1219player. May block.
1220
1221=cut
1222
1223sub maps($) {
1224 my ($pl) = @_;
1225
1226 my $files = aio_readdir playerdir $pl
1227 or return;
1228
1229 my @paths;
1230
1231 for (@$files) {
1232 utf8::decode $_;
1233 next if /\.(?:pl|pst)$/;
1234 next unless /^$PATH_SEP/o;
1235
1236 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1237 }
1238
1239 \@paths
1240}
1241
1242=item $player->ext_reply ($msgid, $msgtype, %msg)
1243
1244Sends an ext reply to the player.
1245
1246=cut
1247
1248sub ext_reply($$$%) {
1249 my ($self, $id, %msg) = @_;
1250
1251 $msg{msgid} = $id;
1252
1253 $self->send ("ext " . cf::to_json \%msg);
1254}
1255
1256package cf;
1257
1258=back
1259
1260
1261=head3 cf::map
1262
1263=over 4
1264
1265=cut
1266
1267package cf::map;
1268
1269use Fcntl;
1270use Coro::AIO;
1271
1272our $MAX_RESET = 3600;
1273our $DEFAULT_RESET = 3000;
1274
1275sub generate_random_map {
1276 my ($path, $rmp) = @_;
1277
1278 # mit "rum" bekleckern, nicht
1279 cf::map::_create_random_map (
1280 $path,
1281 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1282 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1283 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1284 $rmp->{exit_on_final_map},
1285 $rmp->{xsize}, $rmp->{ysize},
1286 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1287 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1288 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1289 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1290 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1291 (cf::region::find $rmp->{region}), $rmp->{custom}
1292 )
1293}
1294
1295# and all this just because we cannot iterate over
1296# all maps in C++...
1297sub change_all_map_light {
1298 my ($change) = @_;
1299
1300 $_->change_map_light ($change)
1301 for grep $_->outdoor, values %cf::MAP;
1302}
1303
1304sub load_map_header($) {
1305 my ($path) = @_;
1306
1307 utf8::encode $path;
1308 aio_open $path, O_RDONLY, 0
1309 or return;
1310
1311 my $map = cf::map::new
1312 or return;
1313
1314 # for better error messages only, will be overwritten later
1315 $map->path ($path);
1316
1317 $map->load_header ($path)
1318 or return;
1319
1320 $map->{load_path} = $path;
1321
1322 $map
1323}
1324
1325sub find;
1326sub find {
1327 my ($path, $origin) = @_;
1328
1329 #warn "find<$path,$origin>\n";#d#
1330
1331 $path = new cf::path $path, $origin && $origin->path;
1332 my $key = $path->as_string;
1333
1334 cf::lock_wait "map_find:$key";
1335
1336 $cf::MAP{$key} || do {
1337 my $guard = cf::lock_acquire "map_find:$key";
1338
1339 # do it the slow way
1340 my $map = $path->load_temp;
1341
1342 Coro::cede;
1343
1344 if ($map) {
1345 $map->last_access ((delete $map->{last_access})
1346 || $cf::RUNTIME); #d#
1347 # safety
1348 $map->{instantiate_time} = $cf::RUNTIME
1349 if $map->{instantiate_time} > $cf::RUNTIME;
1350 } else {
1351 $map = $path->load_orig
1352 or return;
1353
1354 $map->{load_original} = 1;
1355 $map->{instantiate_time} = $cf::RUNTIME;
1356 $map->last_access ($cf::RUNTIME);
1357 $map->instantiate;
1358
1359 # per-player maps become, after loading, normal maps
1360 $map->per_player (0) if $path->{user_rel};
1361 }
1362
1363 $map->path ($key);
1364 $map->{path} = $path;
1365 $map->{last_save} = $cf::RUNTIME;
1366
1367 Coro::cede;
1368
1369 if ($map->should_reset) {
1370 $map->reset;
1371 undef $guard;
1372 $map = find $path
1373 or return;
1374 }
1375
1376 $cf::MAP{$key} = $map
1377 }
1378}
1379
1380sub load {
1381 my ($self) = @_;
1382
1383 my $path = $self->{path};
1384 my $guard = cf::lock_acquire "map_load:" . $path->as_string;
1385
1386 return if $self->in_memory != cf::MAP_SWAPPED;
1387
1388 $self->in_memory (cf::MAP_LOADING);
1389
1390 $self->alloc;
1391 $self->load_objects ($self->{load_path}, 1)
1392 or return;
1393
1394 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1395 if delete $self->{load_original};
1396
1397 if (my $uniq = $path->uniq_path) {
1398 utf8::encode $uniq;
1399 if (aio_open $uniq, O_RDONLY, 0) {
1400 $self->clear_unique_items;
1401 $self->load_objects ($uniq, 0);
1402 }
1403 }
1404
1405 Coro::cede;
1406
1407 # now do the right thing for maps
1408 $self->link_multipart_objects;
1409
1410 if ($self->{path}->is_style_map) {
1411 $self->{deny_save} = 1;
1412 $self->{deny_reset} = 1;
1413 } else {
1414 $self->decay_objects;
1415 $self->fix_auto_apply;
1416 $self->update_buttons;
1417 $self->set_darkness_map;
1418 $self->difficulty ($self->estimate_difficulty)
1419 unless $self->difficulty;
1420 $self->activate;
1421 }
1422
1423 Coro::cede;
1424
1425 $self->in_memory (cf::MAP_IN_MEMORY);
1426}
1427
1428# find and load all maps in the 3x3 area around a map
1429sub load_diag {
675 my ($map) = @_; 1430 my ($map) = @_;
676 1431
677 my $path = $map->tmpname; 1432 my @diag; # diagonal neighbours
678 $path = $map->path unless defined $path;
679 1433
680 open my $fh, "<:raw", "$path.cfperl" 1434 for (0 .. 3) {
681 or return; # no perl data 1435 my $neigh = $map->tile_path ($_)
1436 or next;
1437 $neigh = find $neigh, $map
1438 or next;
1439 $neigh->load;
682 1440
683 my $data = Storable::thaw do { local $/; <$fh> }; 1441 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1442 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1443 }
684 1444
685 $data->{version} <= 1 1445 for (@diag) {
686 or return; # too new 1446 my $neigh = find @$_
1447 or next;
1448 $neigh->load;
1449 }
1450}
687 1451
688 $map->_set_obs ($data->{obs}); 1452sub find_sync {
1453 my ($path, $origin) = @_;
1454
1455 cf::sync_job { find $path, $origin }
1456}
1457
1458sub do_load_sync {
1459 my ($map) = @_;
1460
1461 cf::sync_job { $map->load };
1462}
1463
1464our %MAP_PREFETCH;
1465our $MAP_PREFETCHER = Coro::async {
1466 while () {
1467 while (%MAP_PREFETCH) {
1468 my $key = each %MAP_PREFETCH
1469 or next;
1470 my $path = delete $MAP_PREFETCH{$key};
1471
1472 my $map = find $path
1473 or next;
1474 $map->load;
1475 }
1476 Coro::schedule;
1477 }
689}; 1478};
690 1479
691attach_to_maps prio => -10000, package => cf::mapsupport::; 1480sub find_async {
1481 my ($path, $origin) = @_;
692 1482
693############################################################################# 1483 $path = new cf::path $path, $origin && $origin->path;
694# load/save perl data associated with player->ob objects 1484 my $key = $path->as_string;
695 1485
696sub all_objects(@) { 1486 if (my $map = $cf::MAP{$key}) {
697 @_, map all_objects ($_->inv), @_ 1487 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
698}
699
700attach_to_players
701 on_load => sub {
702 my ($pl, $path) = @_;
703
704 for my $o (all_objects $pl->ob) {
705 if (my $value = $o->get_ob_key_value ("_perl_data")) {
706 $o->set_ob_key_value ("_perl_data");
707
708 %$o = %{ Storable::thaw pack "H*", $value };
709 }
710 }
711 }, 1488 }
712;
713 1489
714############################################################################# 1490 $MAP_PREFETCH{$key} = $path;
715# core extensions - in perl 1491 $MAP_PREFETCHER->ready;
716 1492
717=item cf::player::exists $login 1493 ()
718
719Returns true when the given account exists.
720
721=cut
722
723sub cf::player::exists($) {
724 cf::player::find $_[0]
725 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
726} 1494}
727 1495
1496sub save {
1497 my ($self) = @_;
1498
1499 my $lock = cf::lock_acquire "map_data:" . $self->path;
1500
1501 $self->{last_save} = $cf::RUNTIME;
1502
1503 return unless $self->dirty;
1504
1505 my $save = $self->{path}->save_path; utf8::encode $save;
1506 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1507
1508 $self->{load_path} = $save;
1509
1510 return if $self->{deny_save};
1511
1512 local $self->{last_access} = $self->last_access;#d#
1513
1514 cf::async {
1515 $_->contr->save for $self->players;
1516 };
1517
1518 if ($uniq) {
1519 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1520 $self->save_objects ($uniq, cf::IO_UNIQUES);
1521 } else {
1522 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1523 }
1524}
1525
1526sub swap_out {
1527 my ($self) = @_;
1528
1529 # save first because save cedes
1530 $self->save;
1531
1532 my $lock = cf::lock_acquire "map_data:" . $self->path;
1533
1534 return if $self->players;
1535 return if $self->in_memory != cf::MAP_IN_MEMORY;
1536 return if $self->{deny_save};
1537
1538 $self->clear;
1539 $self->in_memory (cf::MAP_SWAPPED);
1540}
1541
1542sub reset_at {
1543 my ($self) = @_;
1544
1545 # TODO: safety, remove and allow resettable per-player maps
1546 return 1e99 if $self->{path}{user_rel};
1547 return 1e99 if $self->{deny_reset};
1548
1549 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1550 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1551
1552 $time + $to
1553}
1554
1555sub should_reset {
1556 my ($self) = @_;
1557
1558 $self->reset_at <= $cf::RUNTIME
1559}
1560
1561sub rename {
1562 my ($self, $new_path) = @_;
1563
1564 $self->{path}->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->{path}->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
728=item $player->reply ($npc, $msg[, $flags]) 1672=item $player_object->reply ($npc, $msg[, $flags])
729 1673
730Sends 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>
731can 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
732dialogue with the given NPC character. 1676dialogue with the given NPC character.
733 1677
734=cut 1678=cut
735 1679
736# rough implementation of a future "reply" method that works 1680# rough implementation of a future "reply" method that works
737# with dialog boxes. 1681# with dialog boxes.
1682#TODO: the first argument must go, split into a $npc->reply_to ( method
738sub cf::object::player::reply($$$;$) { 1683sub cf::object::player::reply($$$;$) {
739 my ($self, $npc, $msg, $flags) = @_; 1684 my ($self, $npc, $msg, $flags) = @_;
740 1685
741 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1686 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
742 1687
746 $msg = $npc->name . " says: $msg" if $npc; 1691 $msg = $npc->name . " says: $msg" if $npc;
747 $self->message ($msg, $flags); 1692 $self->message ($msg, $flags);
748 } 1693 }
749} 1694}
750 1695
751=item $player->ext_reply ($msgid, $msgtype, %msg) 1696=item $player_object->may ("access")
752 1697
753Sends an ext reply to the player. 1698Returns wether the given player is authorized to access resource "access"
1699(e.g. "command_wizcast").
754 1700
755=cut 1701=cut
756 1702
757sub 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 {
758 my ($self, $id, %msg) = @_; 1882 my ($self, $exit) = @_;
759 1883
760 $msg{msgid} = $id; 1884 return unless $self->type == cf::PLAYER;
761 1885
762 $self->send ("ext " . to_json \%msg); 1886 $self->enter_link;
763}
764 1887
765############################################################################# 1888 (async {
766# 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
767 2021
768our $safe = new Safe "safe"; 2022our $safe = new Safe "safe";
769our $safe_hole = new Safe::Hole; 2023our $safe_hole = new Safe::Hole;
770 2024
771$SIG{FPE} = 'IGNORE'; 2025$SIG{FPE} = 'IGNORE';
772 2026
773$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));
774 2028
775# here we export the classes and methods available to script code 2029# here we export the classes and methods available to script code
776 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
777for ( 2042for (
778 ["cf::object" => qw(contr pay_amount pay_player)], 2043 ["cf::object" => qw(contr pay_amount pay_player map)],
779 ["cf::object::player" => qw(player)], 2044 ["cf::object::player" => qw(player)],
780 ["cf::player" => qw(peaceful)], 2045 ["cf::player" => qw(peaceful)],
2046 ["cf::map" => qw(trigger)],
781) { 2047) {
782 no strict 'refs'; 2048 no strict 'refs';
783 my ($pkg, @funs) = @$_; 2049 my ($pkg, @funs) = @$_;
784 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2050 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785 for @funs; 2051 for @funs;
786} 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
787 2065
788sub safe_eval($;@) { 2066sub safe_eval($;@) {
789 my ($code, %vars) = @_; 2067 my ($code, %vars) = @_;
790 2068
791 my $qcode = $code; 2069 my $qcode = $code;
814 } 2092 }
815 2093
816 wantarray ? @res : $res[0] 2094 wantarray ? @res : $res[0]
817} 2095}
818 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
819sub register_script_function { 2112sub register_script_function {
820 my ($fun, $cb) = @_; 2113 my ($fun, $cb) = @_;
821 2114
822 no strict 'refs'; 2115 no strict 'refs';
823 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2116 *{"safe::$fun"} = $safe_hole->wrap ($cb);
824} 2117}
825 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
826############################################################################# 2226#############################################################################
827# the server's main() 2227# the server's main()
828 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
829sub 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;
830 Event::loop; 2260 Event::loop;
831} 2261}
832 2262
833############################################################################# 2263#############################################################################
834# initialisation 2264# initialisation and cleanup
835 2265
836register "<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};
837 2464
838unshift @INC, $LIBDIR; 2465unshift @INC, $LIBDIR;
839 2466
840load_extensions;
841
842$TICK_WATCHER = Event->timer ( 2467$TICK_WATCHER = Event->timer (
2468 reentrant => 0,
843 prio => 1, 2469 prio => 0,
844 at => $NEXT_TICK || 1, 2470 at => $NEXT_TICK || $TICK,
2471 data => WF_AUTOCANCEL,
845 cb => sub { 2472 cb => sub {
2473 $NOW = Event::time;
2474
846 cf::server_tick; # one server iteration 2475 cf::server_tick; # one server iteration
847 2476 $RUNTIME += $TICK;
848 my $NOW = Event::time;
849 $NEXT_TICK += $TICK; 2477 $NEXT_TICK += $TICK;
850 2478
2479 $WAIT_FOR_TICK->broadcast;
2480 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2481
851 # if we are delayed by four ticks, skip them all 2482 # if we are delayed by four ticks or more, skip them all
852 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2483 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
853 2484
854 $TICK_WATCHER->at ($NEXT_TICK); 2485 $TICK_WATCHER->at ($NEXT_TICK);
855 $TICK_WATCHER->start; 2486 $TICK_WATCHER->start;
856 }, 2487 },
857); 2488);
858 2489
859_reload_2; 2490IO::AIO::max_poll_time $TICK * 0.2;
2491
2492Event->io (
2493 fd => IO::AIO::poll_fileno,
2494 poll => 'r',
2495 prio => 5,
2496 data => WF_AUTOCANCEL,
2497 cb => \&IO::AIO::poll_cb,
2498);
2499
2500Event->timer (
2501 data => WF_AUTOCANCEL,
2502 after => 0,
2503 interval => 10,
2504 cb => sub {
2505 (Coro::unblock_sub {
2506 write_runtime
2507 or warn "ERROR: unable to write runtime file: $!";
2508 })->();
2509 },
2510);
2511
2512END { cf::emergency_save }
860 2513
8611 25141
862 2515

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines