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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines