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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines