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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines