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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.184 by root, Fri Jan 19 22:47:57 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines