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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines