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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines