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.58 by root, Wed Aug 30 12:08:15 2006 UTC vs.
Revision 1.156 by root, Tue Jan 9 22:07:08 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Data::Dumper;
21use Digest::MD5;
22use Fcntl;
23use IO::AIO 2.32 ();
24use YAML::Syck ();
10use Time::HiRes; 25use Time::HiRes;
11use Event; 26
12$Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
13 28
14use strict; 29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15 30
16_reload_1; 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1;
17 33
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35
18our %COMMAND = (); 36our %COMMAND = ();
37our %COMMAND_TIME = ();
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, $objs) = @_;
482
483 if (@$objs) {
484 open my $fh, ">:raw", "$filename.pst~";
485 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
486 close $fh;
487 chmod SAVE_MODE, "$filename.pst~";
488 rename "$filename.pst~", "$filename.pst";
489 } else {
490 unlink "$filename.pst";
491 }
492
493 chmod SAVE_MODE, "$filename~";
494 rename "$filename~", $filename;
495}
496
497sub object_thawer_load {
498 my ($filename) = @_;
499
500 open my $fh, "<:raw:perlio", "$filename.pst"
501 or return;
502
503 eval { local $/; (Storable::thaw <$fh>)->{objs} }
504}
505
506attach_to_objects
507 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,
508 on_clone => sub { 837 on_clone => sub {
509 my ($src, $dst) = @_; 838 my ($src, $dst) = @_;
510 839
511 @{$dst->registry} = @{$src->registry}; 840 @{$dst->registry} = @{$src->registry};
512 841
513 %$dst = %$src; 842 %$dst = %$src;
514 843
515 %{$dst->{_attachment}} = %{$src->{_attachment}} 844 %{$dst->{_attachment}} = %{$src->{_attachment}}
516 if exists $src->{_attachment}; 845 if exists $src->{_attachment};
517 }, 846 },
518; 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}
519 913
520############################################################################# 914#############################################################################
521# old plug-in events 915# command handling &c
522 916
523sub inject_event { 917=item cf::register_command $name => \&callback($ob,$args);
524 my $extension = shift;
525 my $event_code = shift;
526 918
527 my $cb = $hook[$event_code]{$extension} 919Register a callback for execution when the client sends the user command
528 or return; 920$name.
529 921
530 &$cb 922=cut
531}
532
533sub inject_global_event {
534 my $event = shift;
535
536 my $cb = $hook[$event]
537 or return;
538
539 List::Util::max map &$_, values %$cb
540}
541
542sub inject_command {
543 my ($name, $obj, $params) = @_;
544
545 for my $cmd (@{ $command{$name} }) {
546 $cmd->[1]->($obj, $params);
547 }
548
549 -1
550}
551 923
552sub register_command { 924sub register_command {
553 my ($name, $time, $cb) = @_; 925 my ($name, $cb) = @_;
554 926
555 my $caller = caller; 927 my $caller = caller;
556 #warn "registering command '$name/$time' to '$caller'"; 928 #warn "registering command '$name/$time' to '$caller'";
557 929
558 push @{ $command{$name} }, [$time, $cb, $caller]; 930 push @{ $COMMAND{$name} }, [$caller, $cb];
559 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
560} 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
561 941
562sub register_extcmd { 942sub register_extcmd {
563 my ($name, $cb) = @_; 943 my ($name, $cb) = @_;
564 944
565 my $caller = caller; 945 my $caller = caller;
566 #warn "registering extcmd '$name' to '$caller'"; 946 #warn "registering extcmd '$name' to '$caller'";
567 947
568 $extcmd{$name} = [$cb, $caller]; 948 $EXTCMD{$name} = [$cb, $caller];
569} 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);
570 982
571sub register { 983sub register {
572 my ($base, $pkg) = @_; 984 my ($base, $pkg) = @_;
573 985
574 #TODO 986 #TODO
593 . "#line 1 \"$path\"\n{\n" 1005 . "#line 1 \"$path\"\n{\n"
594 . (do { local $/; <$fh> }) 1006 . (do { local $/; <$fh> })
595 . "\n};\n1"; 1007 . "\n};\n1";
596 1008
597 eval $source 1009 eval $source
598 or die "$path: $@"; 1010 or die $@ ? "$path: $@\n"
1011 : "extension disabled.\n";
599 1012
600 push @exts, $pkg; 1013 push @exts, $pkg;
601 $ext_pkg{$base} = $pkg; 1014 $ext_pkg{$base} = $pkg;
602 1015
603# no strict 'refs'; 1016# no strict 'refs';
616# for my $idx (0 .. $#PLUGIN_EVENT) { 1029# for my $idx (0 .. $#PLUGIN_EVENT) {
617# delete $hook[$idx]{$pkg}; 1030# delete $hook[$idx]{$pkg};
618# } 1031# }
619 1032
620 # remove commands 1033 # remove commands
621 for my $name (keys %command) { 1034 for my $name (keys %COMMAND) {
622 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 1035 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
623 1036
624 if (@cb) { 1037 if (@cb) {
625 $command{$name} = \@cb; 1038 $COMMAND{$name} = \@cb;
626 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
627 } else { 1039 } else {
628 delete $command{$name};
629 delete $COMMAND{"$name\000"}; 1040 delete $COMMAND{$name};
630 } 1041 }
631 } 1042 }
632 1043
633 # remove extcmds 1044 # remove extcmds
634 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 1045 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
635 delete $extcmd{$name}; 1046 delete $EXTCMD{$name};
636 } 1047 }
637 1048
638 if (my $cb = $pkg->can ("unload")) { 1049 if (my $cb = $pkg->can ("unload")) {
639 eval { 1050 eval {
640 $cb->($pkg); 1051 $cb->($pkg);
644 1055
645 Symbol::delete_package $pkg; 1056 Symbol::delete_package $pkg;
646} 1057}
647 1058
648sub load_extensions { 1059sub load_extensions {
649 my $LIBDIR = maps_directory "perl";
650
651 for my $ext (<$LIBDIR/*.ext>) { 1060 for my $ext (<$LIBDIR/*.ext>) {
652 next unless -r $ext; 1061 next unless -r $ext;
653 eval { 1062 eval {
654 load_extension $ext; 1063 load_extension $ext;
655 1 1064 1
656 } or warn "$ext not loaded: $@"; 1065 } or warn "$ext not loaded: $@";
657 } 1066 }
658} 1067}
659 1068
660sub _perl_reload(&) {
661 my ($msg) = @_;
662
663 $msg->("reloading...");
664
665 eval {
666 # 1. cancel all watchers
667 $_->cancel for Event::all_watchers;
668
669 # 2. unload all extensions
670 for (@exts) {
671 $msg->("unloading <$_>");
672 unload_extension $_;
673 }
674
675 # 3. unload all modules loaded from $LIBDIR
676 while (my ($k, $v) = each %INC) {
677 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
678
679 $msg->("removing <$k>");
680 delete $INC{$k};
681
682 $k =~ s/\.pm$//;
683 $k =~ s/\//::/g;
684
685 if (my $cb = $k->can ("unload_module")) {
686 $cb->();
687 }
688
689 Symbol::delete_package $k;
690 }
691
692 # 4. get rid of safe::, as good as possible
693 Symbol::delete_package "safe::$_"
694 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
695
696 # 5. remove register_script_function callbacks
697 # TODO
698
699 # 6. unload cf.pm "a bit"
700 delete $INC{"cf.pm"};
701
702 # don't, removes xs symbols, too,
703 # and global variables created in xs
704 #Symbol::delete_package __PACKAGE__;
705
706 # 7. reload cf.pm
707 $msg->("reloading cf.pm");
708 require cf;
709 };
710 $msg->($@) if $@;
711
712 $msg->("reloaded");
713};
714
715sub perl_reload() {
716 _perl_reload {
717 warn $_[0];
718 print "$_[0]\n";
719 };
720}
721
722register_command "perl-reload", 0, sub {
723 my ($who, $arg) = @_;
724
725 if ($who->flag (FLAG_WIZ)) {
726 _perl_reload {
727 warn $_[0];
728 $who->message ($_[0]);
729 };
730 }
731};
732
733#############################################################################
734# extcmd framework, basically convert ext <msg>
735# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
736
737attach_to_players
738 on_extcmd => sub {
739 my ($pl, $buf) = @_;
740
741 my $msg = eval { from_json $buf };
742
743 if (ref $msg) {
744 if (my $cb = $extcmd{$msg->{msgtype}}) {
745 if (my %reply = $cb->[0]->($pl, $msg)) {
746 $pl->ext_reply ($msg->{msgid}, %reply);
747 }
748 }
749 } else {
750 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
751 }
752
753 cf::override;
754 },
755;
756
757############################################################################# 1069#############################################################################
758# load/save/clean perl data associated with a map 1070# load/save/clean perl data associated with a map
759 1071
760*cf::mapsupport::on_clean = sub { 1072*cf::mapsupport::on_clean = sub {
761 my ($map) = @_; 1073 my ($map) = @_;
764 defined $path or return; 1076 defined $path or return;
765 1077
766 unlink "$path.pst"; 1078 unlink "$path.pst";
767}; 1079};
768 1080
769attach_to_maps prio => -10000, package => cf::mapsupport::; 1081cf::map->attach (prio => -10000, package => cf::mapsupport::);
770 1082
771############################################################################# 1083#############################################################################
772# load/save perl data associated with player->ob objects
773 1084
774sub all_objects(@) { 1085=head2 CORE EXTENSIONS
775 @_, map all_objects ($_->inv), @_
776}
777 1086
778attach_to_players 1087Functions and methods that extend core crossfire objects.
779 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($) {
780 my ($pl, $path) = @_; 1316 my ($path) = @_;
781 1317
782 for my $o (all_objects $pl->ob) { 1318 utf8::encode $path;
783 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1319 aio_open $path, O_RDONLY, 0
784 $o->set_ob_key_value ("_perl_data"); 1320 or return;
785 1321
786 %$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;
787 } 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};
788 } 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
789 }, 1393 }
790;
791
792#############################################################################
793# core extensions - in perl
794
795=item cf::player::exists $login
796
797Returns true when the given account exists.
798
799=cut
800
801sub cf::player::exists($) {
802 cf::player::find $_[0]
803 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
804} 1394}
805 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
1444sub find_sync {
1445 my ($path, $origin) = @_;
1446
1447 cf::sync_job { cf::map::find $path, $origin }
1448}
1449
1450sub do_load_sync {
1451 my ($map) = @_;
1452
1453 cf::sync_job { $map->load };
1454}
1455
1456sub save {
1457 my ($self) = @_;
1458
1459 my $lock = cf::lock_acquire "map_data:" . $self->path;
1460
1461 $self->{last_save} = $cf::RUNTIME;
1462
1463 return unless $self->dirty;
1464
1465 my $save = $self->{path}->save_path; utf8::encode $save;
1466 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1467
1468 $self->{load_path} = $save;
1469
1470 return if $self->{deny_save};
1471
1472 local $self->{last_access} = $self->last_access;#d#
1473
1474 cf::async {
1475 $_->contr->save for $self->players;
1476 };
1477
1478 if ($uniq) {
1479 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1480 $self->save_objects ($uniq, cf::IO_UNIQUES);
1481 } else {
1482 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1483 }
1484}
1485
1486sub swap_out {
1487 my ($self) = @_;
1488
1489 # save first because save cedes
1490 $self->save;
1491
1492 my $lock = cf::lock_acquire "map_data:" . $self->path;
1493
1494 return if $self->players;
1495 return if $self->in_memory != cf::MAP_IN_MEMORY;
1496 return if $self->{deny_save};
1497
1498 $self->clear;
1499 $self->in_memory (cf::MAP_SWAPPED);
1500}
1501
1502sub reset_at {
1503 my ($self) = @_;
1504
1505 # TODO: safety, remove and allow resettable per-player maps
1506 return 1e99 if $self->{path}{user_rel};
1507 return 1e99 if $self->{deny_reset};
1508
1509 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1510 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1511
1512 $time + $to
1513}
1514
1515sub should_reset {
1516 my ($self) = @_;
1517
1518 $self->reset_at <= $cf::RUNTIME
1519}
1520
1521sub unlink_save {
1522 my ($self) = @_;
1523
1524 utf8::encode (my $save = $self->{path}->save_path);
1525 aioreq_pri 3; IO::AIO::aio_unlink $save;
1526 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1527}
1528
1529sub rename {
1530 my ($self, $new_path) = @_;
1531
1532 $self->unlink_save;
1533
1534 delete $cf::MAP{$self->path};
1535 $self->{path} = new cf::path $new_path;
1536 $self->path ($self->{path}->as_string);
1537 $cf::MAP{$self->path} = $self;
1538
1539 $self->save;
1540}
1541
1542sub reset {
1543 my ($self) = @_;
1544
1545 my $lock = cf::lock_acquire "map_data:" . $self->path;
1546
1547 return if $self->players;
1548 return if $self->{path}{user_rel};#d#
1549
1550 warn "resetting map ", $self->path;#d#
1551
1552 delete $cf::MAP{$self->path};
1553
1554 $_->clear_links_to ($self) for values %cf::MAP;
1555
1556 $self->unlink_save;
1557 $self->destroy;
1558}
1559
1560my $nuke_counter = "aaaa";
1561
1562sub nuke {
1563 my ($self) = @_;
1564
1565 $self->{deny_save} = 1;
1566 $self->reset_timeout (1);
1567 $self->rename ("{nuke}/" . ($nuke_counter++));
1568 $self->reset; # polite request, might not happen
1569}
1570
1571sub customise_for {
1572 my ($map, $ob) = @_;
1573
1574 if ($map->per_player) {
1575 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
1576 }
1577
1578 $map
1579}
1580
1581package cf;
1582
1583=back
1584
1585=head3 cf::object
1586
1587=cut
1588
1589package cf::object;
1590
1591=over 4
1592
1593=item $ob->inv_recursive
1594
1595Returns the inventory of the object _and_ their inventories, recursively.
1596
1597=cut
1598
1599sub inv_recursive_;
1600sub inv_recursive_ {
1601 map { $_, inv_recursive_ $_->inv } @_
1602}
1603
1604sub inv_recursive {
1605 inv_recursive_ inv $_[0]
1606}
1607
1608package cf;
1609
1610=back
1611
1612=head3 cf::object::player
1613
1614=over 4
1615
806=item $player->reply ($npc, $msg[, $flags]) 1616=item $player_object->reply ($npc, $msg[, $flags])
807 1617
808Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1618Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
809can be C<undef>. Does the right thing when the player is currently in a 1619can be C<undef>. Does the right thing when the player is currently in a
810dialogue with the given NPC character. 1620dialogue with the given NPC character.
811 1621
812=cut 1622=cut
813 1623
814# rough implementation of a future "reply" method that works 1624# rough implementation of a future "reply" method that works
815# with dialog boxes. 1625# with dialog boxes.
1626#TODO: the first argument must go, split into a $npc->reply_to ( method
816sub cf::object::player::reply($$$;$) { 1627sub cf::object::player::reply($$$;$) {
817 my ($self, $npc, $msg, $flags) = @_; 1628 my ($self, $npc, $msg, $flags) = @_;
818 1629
819 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1630 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
820 1631
824 $msg = $npc->name . " says: $msg" if $npc; 1635 $msg = $npc->name . " says: $msg" if $npc;
825 $self->message ($msg, $flags); 1636 $self->message ($msg, $flags);
826 } 1637 }
827} 1638}
828 1639
829=item $player->ext_reply ($msgid, $msgtype, %msg) 1640=item $player_object->may ("access")
830 1641
831Sends an ext reply to the player. 1642Returns wether the given player is authorized to access resource "access"
1643(e.g. "command_wizcast").
832 1644
833=cut 1645=cut
834 1646
835sub cf::player::ext_reply($$$%) { 1647sub cf::object::player::may {
1648 my ($self, $access) = @_;
1649
1650 $self->flag (cf::FLAG_WIZ) ||
1651 (ref $cf::CFG{"may_$access"}
1652 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1653 : $cf::CFG{"may_$access"})
1654}
1655
1656=item $player_object->enter_link
1657
1658Freezes the player and moves him/her to a special map (C<{link}>).
1659
1660The player should be reaosnably safe there for short amounts of time. You
1661I<MUST> call C<leave_link> as soon as possible, though.
1662
1663=item $player_object->leave_link ($map, $x, $y)
1664
1665Moves the player out of the specila link map onto the given map. If the
1666map is not valid (or omitted), the player will be moved back to the
1667location he/she was before the call to C<enter_link>, or, if that fails,
1668to the emergency map position.
1669
1670Might block.
1671
1672=cut
1673
1674sub cf::object::player::enter_link {
1675 my ($self) = @_;
1676
1677 $self->deactivate_recursive;
1678
1679 return if $self->map == $LINK_MAP;
1680
1681 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1682 if $self->map;
1683
1684 $self->enter_map ($LINK_MAP, 20, 20);
1685}
1686
1687sub cf::object::player::leave_link {
1688 my ($self, $map, $x, $y) = @_;
1689
1690 my $link_pos = delete $self->{_link_pos};
1691
1692 unless ($map) {
1693 # restore original map position
1694 ($map, $x, $y) = @{ $link_pos || [] };
1695 $map = cf::map::find $map;
1696
1697 unless ($map) {
1698 ($map, $x, $y) = @$EMERGENCY_POSITION;
1699 $map = cf::map::find $map
1700 or die "FATAL: cannot load emergency map\n";
1701 }
1702 }
1703
1704 ($x, $y) = (-1, -1)
1705 unless (defined $x) && (defined $y);
1706
1707 # use -1 or undef as default coordinates, not 0, 0
1708 ($x, $y) = ($map->enter_x, $map->enter_y)
1709 if $x <=0 && $y <= 0;
1710
1711 $map->load;
1712
1713 return unless $self->contr->active;
1714 $self->activate_recursive;
1715 $self->enter_map ($map, $x, $y);
1716}
1717
1718cf::player->attach (
1719 on_logout => sub {
1720 my ($pl) = @_;
1721
1722 # abort map switching before logout
1723 if ($pl->ob->{_link_pos}) {
1724 cf::sync_job {
1725 $pl->ob->leave_link
1726 };
1727 }
1728 },
1729 on_login => sub {
1730 my ($pl) = @_;
1731
1732 # try to abort aborted map switching on player login :)
1733 # should happen only on crashes
1734 if ($pl->ob->{_link_pos}) {
1735 $pl->ob->enter_link;
1736 (async {
1737 # we need this sleep as the login has a concurrent enter_exit running
1738 # and this sleep increases chances of the player not ending up in scorn
1739 $pl->ob->reply (undef,
1740 "There was an internal problem at your last logout, "
1741 . "the server will try to bring you to your intended destination in a second.",
1742 cf::NDI_RED);
1743 Coro::Timer::sleep 1;
1744 $pl->ob->leave_link;
1745 })->prio (2);
1746 }
1747 },
1748);
1749
1750=item $player_object->goto ($path, $x, $y)
1751
1752=cut
1753
1754sub cf::object::player::goto {
1755 my ($self, $path, $x, $y) = @_;
1756
1757 $path = new cf::path $path;
1758 $path ne "/" or Carp::cluck ("oy");#d#
1759
1760 $self->enter_link;
1761
1762 (async {
1763 my $map = cf::map::find $path->as_string;
1764 $map = $map->customise_for ($self) if $map;
1765
1766# warn "entering ", $map->path, " at ($x, $y)\n"
1767# if $map;
1768
1769 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1770
1771 $self->leave_link ($map, $x, $y);
1772 })->prio (1);
1773}
1774
1775=item $player_object->enter_exit ($exit_object)
1776
1777=cut
1778
1779sub parse_random_map_params {
1780 my ($spec) = @_;
1781
1782 my $rmp = { # defaults
1783 xsize => 10,
1784 ysize => 10,
1785 };
1786
1787 for (split /\n/, $spec) {
1788 my ($k, $v) = split /\s+/, $_, 2;
1789
1790 $rmp->{lc $k} = $v if (length $k) && (length $v);
1791 }
1792
1793 $rmp
1794}
1795
1796sub prepare_random_map {
1797 my ($exit) = @_;
1798
1799 # all this does is basically replace the /! path by
1800 # a new random map path (?random/...) with a seed
1801 # that depends on the exit object
1802
1803 my $rmp = parse_random_map_params $exit->msg;
1804
1805 if ($exit->map) {
1806 $rmp->{region} = $exit->map->region_name;
1807 $rmp->{origin_map} = $exit->map->path;
1808 $rmp->{origin_x} = $exit->x;
1809 $rmp->{origin_y} = $exit->y;
1810 }
1811
1812 $rmp->{random_seed} ||= $exit->random_seed;
1813
1814 my $data = cf::to_json $rmp;
1815 my $md5 = Digest::MD5::md5_hex $data;
1816
1817 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1818 aio_write $fh, 0, (length $data), $data, 0;
1819
1820 $exit->slaying ("?random/$md5");
1821 $exit->msg (undef);
1822 }
1823}
1824
1825sub cf::object::player::enter_exit {
836 my ($self, $id, %msg) = @_; 1826 my ($self, $exit) = @_;
837 1827
838 $msg{msgid} = $id; 1828 return unless $self->type == cf::PLAYER;
839 1829
840 $self->send ("ext " . to_json \%msg); 1830 $self->enter_link;
841}
842 1831
843############################################################################# 1832 (async {
844# map scripting support 1833 $self->deactivate_recursive; # just to be sure
1834 unless (eval {
1835 prepare_random_map $exit
1836 if $exit->slaying eq "/!";
1837
1838 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1839 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1840
1841 1;
1842 }) {
1843 $self->message ("Something went wrong deep within the crossfire server. "
1844 . "I'll try to bring you back to the map you were before. "
1845 . "Please report this to the dungeon master",
1846 cf::NDI_UNIQUE | cf::NDI_RED);
1847
1848 warn "ERROR in enter_exit: $@";
1849 $self->leave_link;
1850 }
1851 })->prio (1);
1852}
1853
1854=head3 cf::client
1855
1856=over 4
1857
1858=item $client->send_drawinfo ($text, $flags)
1859
1860Sends a drawinfo packet to the client. Circumvents output buffering so
1861should not be used under normal circumstances.
1862
1863=cut
1864
1865sub cf::client::send_drawinfo {
1866 my ($self, $text, $flags) = @_;
1867
1868 utf8::encode $text;
1869 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1870}
1871
1872
1873=item $success = $client->query ($flags, "text", \&cb)
1874
1875Queues a query to the client, calling the given callback with
1876the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1877C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1878
1879Queries can fail, so check the return code. Or don't, as queries will become
1880reliable at some point in the future.
1881
1882=cut
1883
1884sub cf::client::query {
1885 my ($self, $flags, $text, $cb) = @_;
1886
1887 return unless $self->state == ST_PLAYING
1888 || $self->state == ST_SETUP
1889 || $self->state == ST_CUSTOM;
1890
1891 $self->state (ST_CUSTOM);
1892
1893 utf8::encode $text;
1894 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1895
1896 $self->send_packet ($self->{query_queue}[0][0])
1897 if @{ $self->{query_queue} } == 1;
1898}
1899
1900cf::client->attach (
1901 on_reply => sub {
1902 my ($ns, $msg) = @_;
1903
1904 # this weird shuffling is so that direct followup queries
1905 # get handled first
1906 my $queue = delete $ns->{query_queue}
1907 or return; # be conservative, not sure how that can happen, but we saw a crash here
1908
1909 (shift @$queue)->[1]->($msg);
1910
1911 push @{ $ns->{query_queue} }, @$queue;
1912
1913 if (@{ $ns->{query_queue} } == @$queue) {
1914 if (@$queue) {
1915 $ns->send_packet ($ns->{query_queue}[0][0]);
1916 } else {
1917 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1918 }
1919 }
1920 },
1921);
1922
1923=item $client->async (\&cb)
1924
1925Create a new coroutine, running the specified callback. The coroutine will
1926be automatically cancelled when the client gets destroyed (e.g. on logout,
1927or loss of connection).
1928
1929=cut
1930
1931sub cf::client::async {
1932 my ($self, $cb) = @_;
1933
1934 my $coro = &Coro::async ($cb);
1935
1936 $coro->on_destroy (sub {
1937 delete $self->{_coro}{$coro+0};
1938 });
1939
1940 $self->{_coro}{$coro+0} = $coro;
1941
1942 $coro
1943}
1944
1945cf::client->attach (
1946 on_destroy => sub {
1947 my ($ns) = @_;
1948
1949 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1950 },
1951);
1952
1953=back
1954
1955
1956=head2 SAFE SCRIPTING
1957
1958Functions that provide a safe environment to compile and execute
1959snippets of perl code without them endangering the safety of the server
1960itself. Looping constructs, I/O operators and other built-in functionality
1961is not available in the safe scripting environment, and the number of
1962functions and methods that can be called is greatly reduced.
1963
1964=cut
845 1965
846our $safe = new Safe "safe"; 1966our $safe = new Safe "safe";
847our $safe_hole = new Safe::Hole; 1967our $safe_hole = new Safe::Hole;
848 1968
849$SIG{FPE} = 'IGNORE'; 1969$SIG{FPE} = 'IGNORE';
850 1970
851$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 1971$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
852 1972
853# here we export the classes and methods available to script code 1973# here we export the classes and methods available to script code
854 1974
1975=pod
1976
1977The following fucntions and emthods are available within a safe environment:
1978
1979 cf::object contr pay_amount pay_player map
1980 cf::object::player player
1981 cf::player peaceful
1982 cf::map trigger
1983
1984=cut
1985
855for ( 1986for (
856 ["cf::object" => qw(contr pay_amount pay_player)], 1987 ["cf::object" => qw(contr pay_amount pay_player map)],
857 ["cf::object::player" => qw(player)], 1988 ["cf::object::player" => qw(player)],
858 ["cf::player" => qw(peaceful)], 1989 ["cf::player" => qw(peaceful)],
1990 ["cf::map" => qw(trigger)],
859) { 1991) {
860 no strict 'refs'; 1992 no strict 'refs';
861 my ($pkg, @funs) = @$_; 1993 my ($pkg, @funs) = @$_;
862 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1994 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
863 for @funs; 1995 for @funs;
864} 1996}
1997
1998=over 4
1999
2000=item @retval = safe_eval $code, [var => value, ...]
2001
2002Compiled and executes the given perl code snippet. additional var/value
2003pairs result in temporary local (my) scalar variables of the given name
2004that are available in the code snippet. Example:
2005
2006 my $five = safe_eval '$first + $second', first => 1, second => 4;
2007
2008=cut
865 2009
866sub safe_eval($;@) { 2010sub safe_eval($;@) {
867 my ($code, %vars) = @_; 2011 my ($code, %vars) = @_;
868 2012
869 my $qcode = $code; 2013 my $qcode = $code;
892 } 2036 }
893 2037
894 wantarray ? @res : $res[0] 2038 wantarray ? @res : $res[0]
895} 2039}
896 2040
2041=item cf::register_script_function $function => $cb
2042
2043Register a function that can be called from within map/npc scripts. The
2044function should be reasonably secure and should be put into a package name
2045like the extension.
2046
2047Example: register a function that gets called whenever a map script calls
2048C<rent::overview>, as used by the C<rent> extension.
2049
2050 cf::register_script_function "rent::overview" => sub {
2051 ...
2052 };
2053
2054=cut
2055
897sub register_script_function { 2056sub register_script_function {
898 my ($fun, $cb) = @_; 2057 my ($fun, $cb) = @_;
899 2058
900 no strict 'refs'; 2059 no strict 'refs';
901 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2060 *{"safe::$fun"} = $safe_hole->wrap ($cb);
902} 2061}
903 2062
2063=back
2064
2065=cut
2066
2067#############################################################################
2068
2069=head2 EXTENSION DATABASE SUPPORT
2070
2071Crossfire maintains a very simple database for extension use. It can
2072currently store anything that can be serialised using Storable, which
2073excludes objects.
2074
2075The parameter C<$family> should best start with the name of the extension
2076using it, it should be unique.
2077
2078=over 4
2079
2080=item $hashref = cf::db_get $family
2081
2082Return a hashref for use by the extension C<$family>, which can be
2083modified. After modifications, you have to call C<cf::db_dirty> or
2084C<cf::db_sync>.
2085
2086=item $value = cf::db_get $family => $key
2087
2088Returns a single value from the database
2089
2090=item cf::db_put $family => $hashref
2091
2092Stores the given family hashref into the database. Updates are delayed, if
2093you want the data to be synced to disk immediately, use C<cf::db_sync>.
2094
2095=item cf::db_put $family => $key => $value
2096
2097Stores the given C<$value> in the family hash. Updates are delayed, if you
2098want the data to be synced to disk immediately, use C<cf::db_sync>.
2099
2100=item cf::db_dirty
2101
2102Marks the database as dirty, to be updated at a later time.
2103
2104=item cf::db_sync
2105
2106Immediately write the database to disk I<if it is dirty>.
2107
2108=cut
2109
2110our $DB;
2111
2112{
2113 my $path = cf::localdir . "/database.pst";
2114
2115 sub db_load() {
2116 $DB = stat $path ? Storable::retrieve $path : { };
2117 }
2118
2119 my $pid;
2120
2121 sub db_save() {
2122 waitpid $pid, 0 if $pid;
2123 if (0 == ($pid = fork)) {
2124 $DB->{_meta}{version} = 1;
2125 Storable::nstore $DB, "$path~";
2126 rename "$path~", $path;
2127 cf::_exit 0 if defined $pid;
2128 }
2129 }
2130
2131 my $dirty;
2132
2133 sub db_sync() {
2134 db_save if $dirty;
2135 undef $dirty;
2136 }
2137
2138 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2139 db_sync;
2140 });
2141
2142 sub db_dirty() {
2143 $dirty = 1;
2144 $idle->start;
2145 }
2146
2147 sub db_get($;$) {
2148 @_ >= 2
2149 ? $DB->{$_[0]}{$_[1]}
2150 : ($DB->{$_[0]} ||= { })
2151 }
2152
2153 sub db_put($$;$) {
2154 if (@_ >= 3) {
2155 $DB->{$_[0]}{$_[1]} = $_[2];
2156 } else {
2157 $DB->{$_[0]} = $_[1];
2158 }
2159 db_dirty;
2160 }
2161
2162 cf::global->attach (
2163 prio => 10000,
2164 on_cleanup => sub {
2165 db_sync;
2166 },
2167 );
2168}
2169
904############################################################################# 2170#############################################################################
905# the server's main() 2171# the server's main()
906 2172
2173sub cfg_load {
2174 open my $fh, "<:utf8", cf::confdir . "/config"
2175 or return;
2176
2177 local $/;
2178 *CFG = YAML::Syck::Load <$fh>;
2179
2180 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2181
2182 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2183 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2184
2185 if (exists $CFG{mlockall}) {
2186 eval {
2187 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2188 and die "WARNING: m(un)lockall failed: $!\n";
2189 };
2190 warn $@ if $@;
2191 }
2192}
2193
907sub main { 2194sub main {
2195 # we must not ever block the main coroutine
2196 local $Coro::idle = sub {
2197 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2198 async { Event::one_event };
2199 };
2200
2201 cfg_load;
2202 db_load;
2203 load_extensions;
908 Event::loop; 2204 Event::loop;
909} 2205}
910 2206
911############################################################################# 2207#############################################################################
912# initialisation 2208# initialisation and cleanup
2209
2210# install some emergency cleanup handlers
2211BEGIN {
2212 for my $signal (qw(INT HUP TERM)) {
2213 Event->signal (
2214 data => WF_AUTOCANCEL,
2215 signal => $signal,
2216 cb => sub {
2217 cf::cleanup "SIG$signal";
2218 },
2219 );
2220 }
2221}
2222
2223sub emergency_save() {
2224 my $freeze_guard = cf::freeze_mainloop;
2225
2226 warn "enter emergency perl save\n";
2227
2228 cf::sync_job {
2229 # use a peculiar iteration method to avoid tripping on perl
2230 # refcount bugs in for. also avoids problems with players
2231 # and maps saved/Destroyed asynchronously.
2232 warn "begin emergency player save\n";
2233 for my $login (keys %cf::PLAYER) {
2234 my $pl = $cf::PLAYER{$login} or next;
2235 $pl->valid or next;
2236 $pl->save;
2237 }
2238 warn "end emergency player save\n";
2239
2240 warn "begin emergency map save\n";
2241 for my $path (keys %cf::MAP) {
2242 my $map = $cf::MAP{$path} or next;
2243 $map->valid or next;
2244 $map->save;
2245 }
2246 warn "end emergency map save\n";
2247 };
2248
2249 warn "leave emergency perl save\n";
2250}
2251
2252sub reload() {
2253 # can/must only be called in main
2254 if ($Coro::current != $Coro::main) {
2255 warn "can only reload from main coroutine\n";
2256 return;
2257 }
2258
2259 warn "reloading...";
2260
2261 my $guard = freeze_mainloop;
2262 cf::emergency_save;
2263
2264 eval {
2265 # if anything goes wrong in here, we should simply crash as we already saved
2266
2267 # cancel all watchers
2268 for (Event::all_watchers) {
2269 $_->cancel if $_->data & WF_AUTOCANCEL;
2270 }
2271
2272 # cancel all extension coros
2273 $_->cancel for values %EXT_CORO;
2274 %EXT_CORO = ();
2275
2276 # unload all extensions
2277 for (@exts) {
2278 warn "unloading <$_>";
2279 unload_extension $_;
2280 }
2281
2282 # unload all modules loaded from $LIBDIR
2283 while (my ($k, $v) = each %INC) {
2284 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2285
2286 warn "removing <$k>";
2287 delete $INC{$k};
2288
2289 $k =~ s/\.pm$//;
2290 $k =~ s/\//::/g;
2291
2292 if (my $cb = $k->can ("unload_module")) {
2293 $cb->();
2294 }
2295
2296 Symbol::delete_package $k;
2297 }
2298
2299 # sync database to disk
2300 cf::db_sync;
2301 IO::AIO::flush;
2302
2303 # get rid of safe::, as good as possible
2304 Symbol::delete_package "safe::$_"
2305 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2306
2307 # remove register_script_function callbacks
2308 # TODO
2309
2310 # unload cf.pm "a bit"
2311 delete $INC{"cf.pm"};
2312
2313 # don't, removes xs symbols, too,
2314 # and global variables created in xs
2315 #Symbol::delete_package __PACKAGE__;
2316
2317 # reload cf.pm
2318 warn "reloading cf.pm";
2319 require cf;
2320 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2321
2322 # load config and database again
2323 cf::cfg_load;
2324 cf::db_load;
2325
2326 # load extensions
2327 warn "load extensions";
2328 cf::load_extensions;
2329
2330 # reattach attachments to objects
2331 warn "reattach";
2332 _global_reattach;
2333 reattach $_ for values %MAP;
2334 };
2335
2336 if ($@) {
2337 warn $@;
2338 warn "error while reloading, exiting.";
2339 exit 1;
2340 }
2341
2342 warn "reloaded successfully";
2343};
2344
2345#############################################################################
2346
2347unless ($LINK_MAP) {
2348 $LINK_MAP = cf::map::new;
2349
2350 $LINK_MAP->width (41);
2351 $LINK_MAP->height (41);
2352 $LINK_MAP->alloc;
2353 $LINK_MAP->path ("{link}");
2354 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2355 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2356
2357 # dirty hack because... archetypes are not yet loaded
2358 Event->timer (
2359 after => 10,
2360 cb => sub {
2361 $_[0]->w->cancel;
2362
2363 # provide some exits "home"
2364 my $exit = cf::object::new "exit";
2365
2366 $exit->slaying ($EMERGENCY_POSITION->[0]);
2367 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2368 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2369
2370 $LINK_MAP->insert ($exit->clone, 19, 19);
2371 $LINK_MAP->insert ($exit->clone, 19, 20);
2372 $LINK_MAP->insert ($exit->clone, 19, 21);
2373 $LINK_MAP->insert ($exit->clone, 20, 19);
2374 $LINK_MAP->insert ($exit->clone, 20, 21);
2375 $LINK_MAP->insert ($exit->clone, 21, 19);
2376 $LINK_MAP->insert ($exit->clone, 21, 20);
2377 $LINK_MAP->insert ($exit->clone, 21, 21);
2378
2379 $exit->destroy;
2380 });
2381
2382 $LINK_MAP->{deny_save} = 1;
2383 $LINK_MAP->{deny_reset} = 1;
2384
2385 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2386}
913 2387
914register "<global>", __PACKAGE__; 2388register "<global>", __PACKAGE__;
915 2389
2390register_command "reload" => sub {
2391 my ($who, $arg) = @_;
2392
2393 if ($who->flag (FLAG_WIZ)) {
2394 $who->message ("start of reload.");
2395 reload;
2396 $who->message ("end of reload.");
2397 }
2398};
2399
916unshift @INC, $LIBDIR; 2400unshift @INC, $LIBDIR;
917 2401
918load_extensions;
919
920$TICK_WATCHER = Event->timer ( 2402$TICK_WATCHER = Event->timer (
2403 reentrant => 0,
921 prio => 1, 2404 prio => 0,
922 at => $NEXT_TICK || 1, 2405 at => $NEXT_TICK || $TICK,
2406 data => WF_AUTOCANCEL,
923 cb => sub { 2407 cb => sub {
924 cf::server_tick; # one server iteration 2408 cf::server_tick; # one server iteration
925 2409 $RUNTIME += $TICK;
926 my $NOW = Event::time;
927 $NEXT_TICK += $TICK; 2410 $NEXT_TICK += $TICK;
928 2411
2412 $WAIT_FOR_TICK->broadcast;
2413 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2414
929 # if we are delayed by four ticks, skip them all 2415 # if we are delayed by four ticks or more, skip them all
930 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2416 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
931 2417
932 $TICK_WATCHER->at ($NEXT_TICK); 2418 $TICK_WATCHER->at ($NEXT_TICK);
933 $TICK_WATCHER->start; 2419 $TICK_WATCHER->start;
934 }, 2420 },
935); 2421);
936 2422
937_reload_2; 2423IO::AIO::max_poll_time $TICK * 0.2;
2424
2425Event->io (
2426 fd => IO::AIO::poll_fileno,
2427 poll => 'r',
2428 prio => 5,
2429 data => WF_AUTOCANCEL,
2430 cb => \&IO::AIO::poll_cb,
2431);
2432
2433Event->timer (
2434 data => WF_AUTOCANCEL,
2435 after => 0,
2436 interval => 10,
2437 cb => sub {
2438 (Coro::unblock_sub {
2439 write_runtime
2440 or warn "ERROR: unable to write runtime file: $!";
2441 })->();
2442 },
2443);
2444
2445END { cf::emergency_save }
938 2446
9391 24471
940 2448

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines