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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines