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.61 by root, Sun Sep 3 22:45:56 2006 UTC vs.
Revision 1.173 by root, Sun Jan 14 18:00:34 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.3 ();
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_reload_1; 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 %PROP_TYPE; 45our $LIBDIR = datadir . "/ext";
21our %PROP_IDX;
22our $LIBDIR = maps_directory "perl";
23 46
24our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
25our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
26our $NEXT_TICK; 51our $NEXT_TICK;
52our $NOW;
53
54our %CFG;
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
88#############################################################################
89
90=head2 GLOBAL VARIABLES
91
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.
102
103=item $cf::LIBDIR
104
105The perl library directory, where extensions and cf-specific modules can
106be found. It will be added to C<@INC> automatically.
107
108=item $cf::NOW
109
110The time of the last (current) server tick.
111
112=item $cf::TICK
113
114The interval between server ticks, in seconds.
115
116=item %cf::CFG
117
118Configuration for the server, loaded from C</etc/crossfire/config>, or
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.
127
128=back
129
130=cut
27 131
28BEGIN { 132BEGIN {
29 *CORE::GLOBAL::warn = sub { 133 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 134 my $msg = join "", @_;
135 utf8::encode $msg;
136
31 $msg .= "\n" 137 $msg .= "\n"
32 unless $msg =~ /\n$/; 138 unless $msg =~ /\n$/;
33 139
34 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 140 LOG llevError, $msg;
36 }; 141 };
37} 142}
38 143
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40 145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41# generate property mutators 146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42sub prop_gen { 147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43 my ($prefix, $class) = @_; 148@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45 no strict 'refs';
46
47 for my $prop (keys %PROP_TYPE) {
48 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
49 my $sub = lc $1;
50
51 my $type = $PROP_TYPE{$prop};
52 my $idx = $PROP_IDX {$prop};
53
54 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55 $_[0]->get_property ($type, $idx)
56 };
57
58 *{"$class\::set_$sub"} = sub {
59 $_[0]->set_property ($type, $idx, $_[1]);
60 } unless $ignore_set{$prop};
61 }
62}
63
64# auto-generate most of the API
65
66prop_gen OBJECT_PROP => "cf::object";
67# CFAPI_OBJECT_ANIMATION?
68prop_gen PLAYER_PROP => "cf::object::player";
69
70prop_gen MAP_PROP => "cf::map";
71prop_gen ARCH_PROP => "cf::arch";
72
73@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 150
75# 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
76# within the Safe compartment. 152# within the Safe compartment.
77for 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)) {
78 no strict 'refs'; 160 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 161 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 162}
81 163
82$Event::DIED = sub { 164$Event::DIED = sub {
83 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
84}; 166};
85 167
86my %ext_pkg; 168=head2 UTILITY FUNCTIONS
87my @exts;
88my @hook;
89my %command;
90my %extcmd;
91 169
92############################################################################# 170=over 4
93# utility functions 171
172=item dumpval $ref
173
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}
94 194
95use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json
198
199Converts a JSON string into the corresponding perl data structure.
200
201=cut
96 202
97sub from_json($) { 203sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 205 JSON::Syck::Load $_[0]
100} 206}
101 207
208=item $json = cf::to_json $ref
209
210Converts a perl data structure into its JSON representation.
211
212=cut
213
102sub to_json($) { 214sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 216 JSON::Syck::Dump $_[0]
105} 217}
106 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
370=back
371
372=cut
373
107############################################################################# 374#############################################################################
108# "new" plug-in system
109 375
110=head3 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+).
111 385
112=over 4 386=over 4
113 387
114=item $object->attach ($attachment, key => $value...)
115
116=item $object->detach ($attachment)
117
118Attach/detach a pre-registered attachment to an object.
119
120=item $player->attach ($attachment, key => $value...)
121
122=item $player->detach ($attachment)
123
124Attach/detach a pre-registered attachment to a player.
125
126=item $map->attach ($attachment, key => $value...) 388=item $attachable->attach ($attachment, key => $value...)
127 389
128=item $map->detach ($attachment) 390=item $attachable->detach ($attachment)
129 391
130Attach/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.
131 394
132=item $bool = $object->attached ($name) 395Example, attach a minesweeper attachment to the given object, making it a
39610x10 minesweeper game:
133 397
134=item $bool = $player->attached ($name) 398 $obj->attach (minesweeper => width => 10, height => 10);
135 399
136=item $bool = $map->attached ($name) 400=item $bool = $attachable->attached ($name)
137 401
138Checks wether the named attachment is currently attached to the object. 402Checks wether the named attachment is currently attached to the object.
139 403
140=item cf::attach_global ... 404=item cf::CLASS->attach ...
141 405
142Attach handlers for global events. 406=item cf::CLASS->detach ...
143 407
144This and all following C<attach_*>-functions expect any number of the 408Define an anonymous attachment and attach it to all objects of the given
145following 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:
146 442
147=over 4 443=over 4
148 444
149=item prio => $number 445=item prio => $number
150 446
152by another C<prio> setting). Lower priority handlers get executed 448by another C<prio> setting). Lower priority handlers get executed
153earlier. 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
154registered at priority C<-1000>, so lower priorities should not be used 450registered at priority C<-1000>, so lower priorities should not be used
155unless you know what you are doing. 451unless you know what you are doing.
156 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
157=item on_I<event> => \&cb 459=item on_I<event> => \&cb
158 460
159Call the given code reference whenever the named event happens (event is 461Call the given code reference whenever the named event happens (event is
160something 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
161handlers are recognised generally depends on the type of object these 463handlers are recognised generally depends on the type of object these
170package and register them. Only handlers for eevents supported by the 472package and register them. Only handlers for eevents supported by the
171object/class are recognised. 473object/class are recognised.
172 474
173=back 475=back
174 476
175=item cf::attach_to_type $object_type, $subtype, ... 477Example, define an attachment called "sockpuppet" that calls the given
478event handler when a monster attacks:
176 479
177Attach handlers for a specific object type (e.g. TRANSPORT) and 480 cf::object::attachment sockpuppet =>
178subtype. If C<$subtype> is zero or undef, matches all objects of the given 481 on_skill_attack => sub {
179type. 482 my ($self, $victim) = @_;
180 483 ...
181=item cf::attach_to_objects ...
182
183Attach handlers to all objects. Do not use this except for debugging or
184very rare events, as handlers are (obviously) called for I<all> objects in
185the game.
186
187=item cf::attach_to_players ...
188
189Attach handlers to all players.
190
191=item cf::attach_to_maps ...
192
193Attach handlers to all maps.
194
195=item cf:register_attachment $name, ...
196
197Register an attachment by name through which objects can refer to this
198attachment.
199
200=item cf:register_player_attachment $name, ...
201
202Register an attachment by name through which players can refer to this
203attachment.
204
205=item cf:register_map_attachment $name, ...
206
207Register an attachment by name through which maps can refer to this
208attachment.
209
210=cut
211
212# the following variables are defined in .xs and must not be re-created
213our @CB_GLOBAL = (); # registry for all global events
214our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215our @CB_PLAYER = ();
216our @CB_TYPE = (); # registry for type (cf-object class) based events
217our @CB_MAP = ();
218
219my %attachment;
220
221sub _attach_cb($\%$$$) {
222 my ($registry, $undo, $event, $prio, $cb) = @_;
223
224 use sort 'stable';
225
226 $cb = [$prio, $cb];
227
228 @{$registry->[$event]} = sort
229 { $a->[0] cmp $b->[0] }
230 @{$registry->[$event] || []}, $cb;
231
232 push @{$undo->{cb}}, [$event, $cb];
233}
234
235# attach handles attaching event callbacks
236# the only thing the caller has to do is pass the correct
237# registry (== where the callback attaches to).
238sub _attach(\@$@) {
239 my ($registry, $klass, @arg) = @_;
240
241 my $prio = 0;
242
243 my %undo = (
244 registry => $registry,
245 cb => [],
246 );
247
248 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
249
250 while (@arg) {
251 my $type = shift @arg;
252
253 if ($type eq "prio") {
254 $prio = shift @arg;
255
256 } elsif ($type eq "package") {
257 my $pkg = shift @arg;
258
259 while (my ($name, $id) = each %cb_id) {
260 if (my $cb = $pkg->can ($name)) {
261 _attach_cb $registry, %undo, $id, $prio, $cb;
262 }
263 } 484 }
264
265 } elsif (exists $cb_id{$type}) {
266 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
267
268 } elsif (ref $type) {
269 warn "attaching objects not supported, ignoring.\n";
270
271 } else {
272 shift @arg;
273 warn "attach argument '$type' not supported, ignoring.\n";
274 }
275 }
276
277 \%undo
278}
279
280sub _attach_attachment {
281 my ($obj, $name, %arg) = @_;
282
283 return if exists $obj->{_attachment}{$name};
284
285 my $res;
286
287 if (my $attach = $attachment{$name}) {
288 my $registry = $obj->registry;
289
290 for (@$attach) {
291 my ($klass, @attach) = @$_;
292 $res = _attach @$registry, $klass, @attach;
293 }
294
295 $obj->{$name} = \%arg;
296 } else {
297 warn "object uses attachment '$name' that is not available, postponing.\n";
298 }
299
300 $obj->{_attachment}{$name} = undef;
301
302 $res->{attachment} = $name;
303 $res
304}
305
306*cf::object::attach =
307*cf::player::attach =
308*cf::map::attach = sub {
309 my ($obj, $name, %arg) = @_;
310
311 _attach_attachment $obj, $name, %arg;
312};
313
314# all those should be optimised
315*cf::object::detach =
316*cf::player::detach =
317*cf::map::detach = sub {
318 my ($obj, $name) = @_;
319
320 delete $obj->{_attachment}{$name};
321 reattach ($obj);
322};
323
324*cf::object::attached =
325*cf::player::attached =
326*cf::map::attached = sub {
327 my ($obj, $name) = @_;
328
329 exists $obj->{_attachment}{$name}
330};
331
332sub attach_global {
333 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
334}
335
336sub attach_to_type {
337 my $type = shift;
338 my $subtype = shift;
339
340 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
341}
342
343sub attach_to_objects {
344 _attach @CB_OBJECT, KLASS_OBJECT, @_
345}
346
347sub attach_to_players {
348 _attach @CB_PLAYER, KLASS_PLAYER, @_
349}
350
351sub attach_to_maps {
352 _attach @CB_MAP, KLASS_MAP, @_
353}
354
355sub register_attachment {
356 my $name = shift;
357
358 $attachment{$name} = [[KLASS_OBJECT, @_]];
359}
360
361sub register_player_attachment {
362 my $name = shift;
363
364 $attachment{$name} = [[KLASS_PLAYER, @_]];
365}
366
367sub register_map_attachment {
368 my $name = shift;
369
370 $attachment{$name} = [[KLASS_MAP, @_]];
371}
372
373our $override;
374our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
375
376sub override {
377 $override = 1;
378 @invoke_results = ();
379}
380
381sub do_invoke {
382 my $event = shift;
383 my $callbacks = shift;
384
385 @invoke_results = ();
386
387 local $override;
388
389 for (@$callbacks) {
390 eval { &{$_->[1]} };
391
392 if ($@) {
393 warn "$@";
394 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
395 override;
396 }
397
398 return 1 if $override;
399 }
400
401 0 485 }
402}
403 486
404=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 487=item $attachable->valid
405
406=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407
408=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
409
410=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411
412Generate a global/object/player/map-specific event with the given arguments.
413
414This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
415removed in future versions), and there is no public API to access override
416results (if you must, access C<@cf::invoke_results> directly).
417
418=back
419
420=head2 methods valid for all pointers
421
422=over 4
423
424=item $object->valid
425
426=item $player->valid
427
428=item $map->valid
429 488
430Just 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
431C-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
432valid C counterpart anymore you get an exception at runtime. This method 491valid C counterpart anymore you get an exception at runtime. This method
433can 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
434exception. 493exception.
435 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
436=back 684=back
437 685
438=cut 686=cut
439
440*cf::object::valid =
441*cf::player::valid =
442*cf::map::valid = \&cf::_valid;
443 687
444############################################################################# 688#############################################################################
445# object support 689# object support
446 690
447sub instantiate {
448 my ($obj, $data) = @_;
449
450 $data = from_json $data;
451
452 for (@$data) {
453 my ($name, $args) = @$_;
454
455 $obj->attach ($name, %{$args || {} });
456 }
457}
458
459# basically do the same as instantiate, without calling instantiate
460sub reattach { 691sub reattach {
692 # basically do the same as instantiate, without calling instantiate
461 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
696
462 my $registry = $obj->registry; 697 my $registry = $obj->registry;
463 698
464 @$registry = (); 699 @$registry = ();
465 700
466 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 701 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
467 702
468 for my $name (keys %{ $obj->{_attachment} || {} }) { 703 for my $name (keys %{ $obj->{_attachment} || {} }) {
469 if (my $attach = $attachment{$name}) { 704 if (my $attach = $attachment{$name}) {
470 for (@$attach) { 705 for (@$attach) {
471 my ($klass, @attach) = @$_; 706 my ($klass, @attach) = @$_;
472 _attach @$registry, $klass, @attach; 707 _attach $registry, $klass, @attach;
473 } 708 }
474 } else { 709 } else {
475 warn "object uses attachment '$name' that is not available, postponing.\n"; 710 warn "object uses attachment '$name' that is not available, postponing.\n";
476 } 711 }
477 } 712 }
478} 713}
479 714
480sub object_freezer_save { 715cf::attachable->attach (
481 my ($filename, $rdata, $objs) = @_;
482
483 if (length $$rdata) {
484 warn sprintf "saving %s (%d,%d)\n",
485 $filename, length $$rdata, scalar @$objs;
486
487 if (open my $fh, ">:raw", "$filename~") {
488 chmod SAVE_MODE, $fh;
489 syswrite $fh, $$rdata;
490 close $fh;
491
492 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
493 chmod SAVE_MODE, $fh;
494 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
495 close $fh;
496 rename "$filename.pst~", "$filename.pst";
497 } else {
498 unlink "$filename.pst";
499 }
500
501 rename "$filename~", $filename;
502 } else {
503 warn "FATAL: $filename~: $!\n";
504 }
505 } else {
506 unlink $filename;
507 unlink "$filename.pst";
508 }
509}
510
511sub object_thawer_load {
512 my ($filename) = @_;
513
514 local $/;
515
516 my $av;
517
518 #TODO: use sysread etc.
519 if (open my $data, "<:raw:perlio", $filename) {
520 $data = <$data>;
521 if (open my $pst, "<:raw:perlio", "$filename.pst") {
522 $av = eval { (Storable::thaw <$pst>)->{objs} };
523 }
524 return ($data, $av);
525 }
526
527 ()
528}
529
530attach_to_objects
531 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,
532 on_clone => sub { 729 on_clone => sub {
533 my ($src, $dst) = @_; 730 my ($src, $dst) = @_;
534 731
535 @{$dst->registry} = @{$src->registry}; 732 @{$dst->registry} = @{$src->registry};
536 733
537 %$dst = %$src; 734 %$dst = %$src;
538 735
539 %{$dst->{_attachment}} = %{$src->{_attachment}} 736 %{$dst->{_attachment}} = %{$src->{_attachment}}
540 if exists $src->{_attachment}; 737 if exists $src->{_attachment};
541 }, 738 },
542; 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}
543 805
544############################################################################# 806#############################################################################
545# old plug-in events 807# command handling &c
546 808
547sub inject_event { 809=item cf::register_command $name => \&callback($ob,$args);
548 my $extension = shift;
549 my $event_code = shift;
550 810
551 my $cb = $hook[$event_code]{$extension} 811Register a callback for execution when the client sends the user command
552 or return; 812$name.
553 813
554 &$cb 814=cut
555}
556
557sub inject_global_event {
558 my $event = shift;
559
560 my $cb = $hook[$event]
561 or return;
562
563 List::Util::max map &$_, values %$cb
564}
565
566sub inject_command {
567 my ($name, $obj, $params) = @_;
568
569 for my $cmd (@{ $command{$name} }) {
570 $cmd->[1]->($obj, $params);
571 }
572
573 -1
574}
575 815
576sub register_command { 816sub register_command {
577 my ($name, $time, $cb) = @_; 817 my ($name, $cb) = @_;
578 818
579 my $caller = caller; 819 my $caller = caller;
580 #warn "registering command '$name/$time' to '$caller'"; 820 #warn "registering command '$name/$time' to '$caller'";
581 821
582 push @{ $command{$name} }, [$time, $cb, $caller]; 822 push @{ $COMMAND{$name} }, [$caller, $cb];
583 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
584} 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
585 833
586sub register_extcmd { 834sub register_extcmd {
587 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
588 836
589 my $caller = caller; 837 $EXTCMD{$name} = $cb;
590 #warn "registering extcmd '$name' to '$caller'";
591
592 $extcmd{$name} = [$cb, $caller];
593} 838}
594 839
595sub register { 840cf::player->attach (
596 my ($base, $pkg) = @_; 841 on_command => sub {
842 my ($pl, $name, $params) = @_;
597 843
598 #TODO 844 my $cb = $COMMAND{$name}
599} 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);
600 871
601sub load_extension { 872sub load_extension {
602 my ($path) = @_; 873 my ($path) = @_;
603 874
604 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
605 my $base = $1; 876 my $base = $1;
606 my $pkg = $1; 877 my $pkg = $1;
607 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
608 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
609 880
610 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
611 882
612 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
613 or die "$path: $!"; 884 or die "$path: $!";
614 885
615 my $source = 886 my $source =
616 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
617 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
618 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
619 . "\n};\n1"; 890 . "\n};\n1";
620 891
621 eval $source 892 unless (eval $source) {
622 or die "$path: $@"; 893 my $msg = $@ ? "$path: $@\n"
623 894 : "extension disabled.\n";
624 push @exts, $pkg; 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
625 $ext_pkg{$base} = $pkg; 896 warn $@;
626 897 warn "mandatory extension failed to load, exiting.\n";
627# no strict 'refs'; 898 exit 1;
628# @{"$pkg\::ISA"} = ext::; 899 }
629 900 die $@;
630 register $base, $pkg;
631}
632
633sub unload_extension {
634 my ($pkg) = @_;
635
636 warn "removing extension $pkg\n";
637
638 # remove hooks
639 #TODO
640# for my $idx (0 .. $#PLUGIN_EVENT) {
641# delete $hook[$idx]{$pkg};
642# } 901 }
643 902
644 # remove commands 903 push @EXTS, $pkg;
645 for my $name (keys %command) {
646 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
647
648 if (@cb) {
649 $command{$name} = \@cb;
650 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
651 } else {
652 delete $command{$name};
653 delete $COMMAND{"$name\000"};
654 }
655 }
656
657 # remove extcmds
658 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
659 delete $extcmd{$name};
660 }
661
662 if (my $cb = $pkg->can ("unload")) {
663 eval {
664 $cb->($pkg);
665 1
666 } or warn "$pkg unloaded, but with errors: $@";
667 }
668
669 Symbol::delete_package $pkg;
670} 904}
671 905
672sub load_extensions { 906sub load_extensions {
673 my $LIBDIR = maps_directory "perl";
674
675 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
676 next unless -r $ext; 908 next unless -r $ext;
677 eval { 909 eval {
678 load_extension $ext; 910 load_extension $ext;
679 1 911 1
680 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
681 } 913 }
682} 914}
683 915
684sub _perl_reload(&) { 916#############################################################################
917
918=head2 CORE EXTENSIONS
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($) {
685 my ($msg) = @_; 959 my ($login) = @_;
686 960
687 $msg->("reloading..."); 961 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat $login }
963}
688 964
689 eval { 965sub find($) {
690 # 1. cancel all watchers 966 return $cf::PLAYER{$_[0]} || do {
691 $_->cancel for Event::all_watchers; 967 my $login = $_[0];
692 968
693 # 2. unload all extensions 969 my $guard = cf::lock_acquire "user_find:$login";
694 for (@exts) {
695 $msg->("unloading <$_>");
696 unload_extension $_;
697 }
698 970
699 # 3. unload all modules loaded from $LIBDIR 971 $cf::PLAYER{$_[0]} || do {
700 while (my ($k, $v) = each %INC) { 972 my $pl = load_pl path $login
701 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 973 or return;
702 974 $cf::PLAYER{$login} = $pl
703 $msg->("removing <$k>");
704 delete $INC{$k};
705
706 $k =~ s/\.pm$//;
707 $k =~ s/\//::/g;
708
709 if (my $cb = $k->can ("unload_module")) {
710 $cb->();
711 }
712
713 Symbol::delete_package $k;
714 }
715
716 # 4. get rid of safe::, as good as possible
717 Symbol::delete_package "safe::$_"
718 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
719
720 # 5. remove register_script_function callbacks
721 # TODO
722 975 }
723 # 6. unload cf.pm "a bit" 976 }
724 delete $INC{"cf.pm"}; 977}
725 978
726 # don't, removes xs symbols, too, 979sub save($) {
727 # and global variables created in xs 980 my ($pl) = @_;
728 #Symbol::delete_package __PACKAGE__;
729 981
730 # 7. reload cf.pm 982 return if $pl->{deny_save};
731 $msg->("reloading cf.pm");
732 require cf;
733 983
734 $msg->("load extensions"); 984 my $path = path $pl;
735 cf::load_extensions; 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 {
1412 my ($map) = @_;
1413
1414 my @diag; # diagonal neighbours
1415
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 }
1458};
1459
1460sub find_async {
1461 my ($path, $origin) = @_;
1462
1463 $path = normalise $path, $origin && $origin->{path};
1464
1465 if (my $map = $cf::MAP{$path}) {
1466 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1467 }
1468
1469 $MAP_PREFETCH{$path} = 0;
1470 $MAP_PREFETCHER->ready;
1471
1472 ()
1473}
1474
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;
736 }; 1495 };
737 $msg->($@) if $@;
738 1496
739 $msg->("reloaded"); 1497 if ($uniq) {
740}; 1498 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
741 1499 $self->_save_objects ($uniq, cf::IO_UNIQUES);
742sub perl_reload() { 1500 } else {
743 _perl_reload { 1501 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
744 warn $_[0];
745 print "$_[0]\n";
746 }; 1502 }
747} 1503}
748 1504
749register_command "perl-reload", 0, sub { 1505sub swap_out {
750 my ($who, $arg) = @_;
751
752 if ($who->flag (FLAG_WIZ)) {
753 _perl_reload {
754 warn $_[0];
755 $who->message ($_[0]);
756 };
757 }
758};
759
760#############################################################################
761# extcmd framework, basically convert ext <msg>
762# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
763
764attach_to_players
765 on_extcmd => sub {
766 my ($pl, $buf) = @_; 1506 my ($self) = @_;
767 1507
768 my $msg = eval { from_json $buf }; 1508 # save first because save cedes
1509 $self->save;
769 1510
770 if (ref $msg) { 1511 my $lock = cf::lock_acquire "map_data:" . $self->path;
771 if (my $cb = $extcmd{$msg->{msgtype}}) {
772 if (my %reply = $cb->[0]->($pl, $msg)) {
773 $pl->ext_reply ($msg->{msgid}, %reply);
774 }
775 }
776 } else {
777 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
778 }
779 1512
780 cf::override; 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 rename {
1541 my ($self, $new_path) = @_;
1542
1543 normalise $new_path;
1544
1545 $self->unlink_save;
1546
1547 delete $cf::MAP{$self->path};
1548 $self->{path} = $new_path; $self->path ($self->{path});
1549 $cf::MAP{$self->path} = $self;
1550
1551 $self->save;
1552}
1553
1554sub reset {
1555 my ($self) = @_;
1556
1557 my $lock = cf::lock_acquire "map_data:$self->{path}";
1558
1559 return if $self->players;
1560 return if $self->isa ("ext::map_per_player");#d#
1561
1562 warn "resetting map ", $self->path;#d#
1563
1564 delete $cf::MAP{$self->path};
1565
1566 $self->in_memory (cf::MAP_SWAPPED);
1567 $self->clear;
1568
1569 $_->clear_links_to ($self) for values %cf::MAP;
1570
1571 $self->unlink_save;
1572 $self->destroy;
1573}
1574
1575my $nuke_counter = "aaaa";
1576
1577sub nuke {
1578 my ($self) = @_;
1579
1580 $self->{deny_save} = 1;
1581 $self->reset_timeout (1);
1582 $self->rename ("{nuke}/" . ($nuke_counter++));
1583 $self->reset; # polite request, might not happen
1584}
1585
1586=item cf::map::unique_maps
1587
1588Returns an arrayref of paths of all shared maps that have
1589instantiated unique items. May block.
1590
1591=cut
1592
1593sub unique_maps() {
1594 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1595 or return;
1596
1597 my @paths;
1598
1599 for (@$files) {
1600 utf8::decode $_;
1601 next if /\.pst$/;
1602 next unless /^$PATH_SEP/o;
1603
1604 s/\.map$//;
1605 push @paths, $_;
781 }, 1606 }
782;
783 1607
784############################################################################# 1608 \@paths
785# load/save/clean perl data associated with a map
786
787*cf::mapsupport::on_clean = sub {
788 my ($map) = @_;
789
790 my $path = $map->tmpname;
791 defined $path or return;
792
793 unlink "$path.pst";
794};
795
796attach_to_maps prio => -10000, package => cf::mapsupport::;
797
798#############################################################################
799# load/save perl data associated with player->ob objects
800
801sub all_objects(@) {
802 @_, map all_objects ($_->inv), @_
803} 1609}
804 1610
805# TODO: compatibility cruft, remove when no longer needed 1611package cf;
806attach_to_players
807 on_load => sub {
808 my ($pl, $path) = @_;
809 1612
810 for my $o (all_objects $pl->ob) { 1613=back
811 if (my $value = $o->get_ob_key_value ("_perl_data")) {
812 $o->set_ob_key_value ("_perl_data");
813 1614
814 %$o = %{ Storable::thaw pack "H*", $value }; 1615=head3 cf::object
815 }
816 }
817 },
818;
819 1616
820#############################################################################
821# core extensions - in perl
822
823=item cf::player::exists $login
824
825Returns true when the given account exists.
826
827=cut 1617=cut
828 1618
829sub cf::player::exists($) { 1619package cf::object;
830 cf::player::find $_[0]
831 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
832}
833 1620
1621=over 4
1622
1623=item $ob->inv_recursive
1624
1625Returns the inventory of the object _and_ their inventories, recursively.
1626
1627=cut
1628
1629sub inv_recursive_;
1630sub inv_recursive_ {
1631 map { $_, inv_recursive_ $_->inv } @_
1632}
1633
1634sub inv_recursive {
1635 inv_recursive_ inv $_[0]
1636}
1637
1638package cf;
1639
1640=back
1641
1642=head3 cf::object::player
1643
1644=over 4
1645
834=item $player->reply ($npc, $msg[, $flags]) 1646=item $player_object->reply ($npc, $msg[, $flags])
835 1647
836Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1648Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
837can be C<undef>. Does the right thing when the player is currently in a 1649can be C<undef>. Does the right thing when the player is currently in a
838dialogue with the given NPC character. 1650dialogue with the given NPC character.
839 1651
840=cut 1652=cut
841 1653
842# rough implementation of a future "reply" method that works 1654# rough implementation of a future "reply" method that works
843# with dialog boxes. 1655# with dialog boxes.
1656#TODO: the first argument must go, split into a $npc->reply_to ( method
844sub cf::object::player::reply($$$;$) { 1657sub cf::object::player::reply($$$;$) {
845 my ($self, $npc, $msg, $flags) = @_; 1658 my ($self, $npc, $msg, $flags) = @_;
846 1659
847 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1660 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
848 1661
852 $msg = $npc->name . " says: $msg" if $npc; 1665 $msg = $npc->name . " says: $msg" if $npc;
853 $self->message ($msg, $flags); 1666 $self->message ($msg, $flags);
854 } 1667 }
855} 1668}
856 1669
857=item $player->ext_reply ($msgid, $msgtype, %msg) 1670=item $player_object->may ("access")
858 1671
859Sends an ext reply to the player. 1672Returns wether the given player is authorized to access resource "access"
1673(e.g. "command_wizcast").
860 1674
861=cut 1675=cut
862 1676
863sub cf::player::ext_reply($$$%) { 1677sub cf::object::player::may {
1678 my ($self, $access) = @_;
1679
1680 $self->flag (cf::FLAG_WIZ) ||
1681 (ref $cf::CFG{"may_$access"}
1682 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1683 : $cf::CFG{"may_$access"})
1684}
1685
1686=item $player_object->enter_link
1687
1688Freezes the player and moves him/her to a special map (C<{link}>).
1689
1690The player should be reasonably safe there for short amounts of time. You
1691I<MUST> call C<leave_link> as soon as possible, though.
1692
1693Will never block.
1694
1695=item $player_object->leave_link ($map, $x, $y)
1696
1697Moves the player out of the special C<{link}> map onto the specified
1698map. If the map is not valid (or omitted), the player will be moved back
1699to the location he/she was before the call to C<enter_link>, or, if that
1700fails, to the emergency map position.
1701
1702Might block.
1703
1704=cut
1705
1706sub link_map {
1707 unless ($LINK_MAP) {
1708 $LINK_MAP = cf::map::find "{link}"
1709 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1710 $LINK_MAP->load;
1711 }
1712
1713 $LINK_MAP
1714}
1715
1716sub cf::object::player::enter_link {
1717 my ($self) = @_;
1718
1719 $self->deactivate_recursive;
1720
1721 return if UNIVERSAL::isa $self->map, "ext::map_link";
1722
1723 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1724 if $self->map;
1725
1726 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1727}
1728
1729sub cf::object::player::leave_link {
1730 my ($self, $map, $x, $y) = @_;
1731
1732 my $link_pos = delete $self->{_link_pos};
1733
1734 unless ($map) {
1735 # restore original map position
1736 ($map, $x, $y) = @{ $link_pos || [] };
1737 $map = cf::map::find $map;
1738
1739 unless ($map) {
1740 ($map, $x, $y) = @$EMERGENCY_POSITION;
1741 $map = cf::map::find $map
1742 or die "FATAL: cannot load emergency map\n";
1743 }
1744 }
1745
1746 ($x, $y) = (-1, -1)
1747 unless (defined $x) && (defined $y);
1748
1749 # use -1 or undef as default coordinates, not 0, 0
1750 ($x, $y) = ($map->enter_x, $map->enter_y)
1751 if $x <=0 && $y <= 0;
1752
1753 $map->load;
1754 $map->load_diag;
1755
1756 return unless $self->contr->active;
1757 $self->activate_recursive;
1758 $self->enter_map ($map, $x, $y);
1759}
1760
1761cf::player->attach (
1762 on_logout => sub {
1763 my ($pl) = @_;
1764
1765 # abort map switching before logout
1766 if ($pl->ob->{_link_pos}) {
1767 cf::sync_job {
1768 $pl->ob->leave_link
1769 };
1770 }
1771 },
1772 on_login => sub {
1773 my ($pl) = @_;
1774
1775 # try to abort aborted map switching on player login :)
1776 # should happen only on crashes
1777 if ($pl->ob->{_link_pos}) {
1778 $pl->ob->enter_link;
1779 (async {
1780 # we need this sleep as the login has a concurrent enter_exit running
1781 # and this sleep increases chances of the player not ending up in scorn
1782 $pl->ob->reply (undef,
1783 "There was an internal problem at your last logout, "
1784 . "the server will try to bring you to your intended destination in a second.",
1785 cf::NDI_RED);
1786 Coro::Timer::sleep 1;
1787 $pl->ob->leave_link;
1788 })->prio (2);
1789 }
1790 },
1791);
1792
1793=item $player_object->goto ($path, $x, $y)
1794
1795=cut
1796
1797sub cf::object::player::goto {
1798 my ($self, $path, $x, $y) = @_;
1799
1800 $self->enter_link;
1801
1802 (async {
1803 my $map = cf::map::find $path;
1804 $map = $map->customise_for ($self) if $map;
1805
1806# warn "entering ", $map->path, " at ($x, $y)\n"
1807# if $map;
1808
1809 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1810
1811 $self->leave_link ($map, $x, $y);
1812 })->prio (1);
1813}
1814
1815=item $player_object->enter_exit ($exit_object)
1816
1817=cut
1818
1819sub parse_random_map_params {
1820 my ($spec) = @_;
1821
1822 my $rmp = { # defaults
1823 xsize => 10,
1824 ysize => 10,
1825 };
1826
1827 for (split /\n/, $spec) {
1828 my ($k, $v) = split /\s+/, $_, 2;
1829
1830 $rmp->{lc $k} = $v if (length $k) && (length $v);
1831 }
1832
1833 $rmp
1834}
1835
1836sub prepare_random_map {
1837 my ($exit) = @_;
1838
1839 # all this does is basically replace the /! path by
1840 # a new random map path (?random/...) with a seed
1841 # that depends on the exit object
1842
1843 my $rmp = parse_random_map_params $exit->msg;
1844
1845 if ($exit->map) {
1846 $rmp->{region} = $exit->map->region_name;
1847 $rmp->{origin_map} = $exit->map->path;
1848 $rmp->{origin_x} = $exit->x;
1849 $rmp->{origin_y} = $exit->y;
1850 }
1851
1852 $rmp->{random_seed} ||= $exit->random_seed;
1853
1854 my $data = cf::to_json $rmp;
1855 my $md5 = Digest::MD5::md5_hex $data;
1856
1857 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1858 aio_write $fh, 0, (length $data), $data, 0;
1859
1860 $exit->slaying ("?random/$md5");
1861 $exit->msg (undef);
1862 }
1863}
1864
1865sub cf::object::player::enter_exit {
864 my ($self, $id, %msg) = @_; 1866 my ($self, $exit) = @_;
865 1867
866 $msg{msgid} = $id; 1868 return unless $self->type == cf::PLAYER;
867 1869
868 $self->send ("ext " . to_json \%msg); 1870 $self->enter_link;
869}
870 1871
871############################################################################# 1872 (async {
872# map scripting support 1873 $self->deactivate_recursive; # just to be sure
1874 unless (eval {
1875 prepare_random_map $exit
1876 if $exit->slaying eq "/!";
1877
1878 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1879 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1880
1881 1;
1882 }) {
1883 $self->message ("Something went wrong deep within the crossfire server. "
1884 . "I'll try to bring you back to the map you were before. "
1885 . "Please report this to the dungeon master!",
1886 cf::NDI_UNIQUE | cf::NDI_RED);
1887
1888 warn "ERROR in enter_exit: $@";
1889 $self->leave_link;
1890 }
1891 })->prio (1);
1892}
1893
1894=head3 cf::client
1895
1896=over 4
1897
1898=item $client->send_drawinfo ($text, $flags)
1899
1900Sends a drawinfo packet to the client. Circumvents output buffering so
1901should not be used under normal circumstances.
1902
1903=cut
1904
1905sub cf::client::send_drawinfo {
1906 my ($self, $text, $flags) = @_;
1907
1908 utf8::encode $text;
1909 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1910}
1911
1912
1913=item $success = $client->query ($flags, "text", \&cb)
1914
1915Queues a query to the client, calling the given callback with
1916the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1917C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1918
1919Queries can fail, so check the return code. Or don't, as queries will become
1920reliable at some point in the future.
1921
1922=cut
1923
1924sub cf::client::query {
1925 my ($self, $flags, $text, $cb) = @_;
1926
1927 return unless $self->state == ST_PLAYING
1928 || $self->state == ST_SETUP
1929 || $self->state == ST_CUSTOM;
1930
1931 $self->state (ST_CUSTOM);
1932
1933 utf8::encode $text;
1934 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1935
1936 $self->send_packet ($self->{query_queue}[0][0])
1937 if @{ $self->{query_queue} } == 1;
1938}
1939
1940cf::client->attach (
1941 on_reply => sub {
1942 my ($ns, $msg) = @_;
1943
1944 # this weird shuffling is so that direct followup queries
1945 # get handled first
1946 my $queue = delete $ns->{query_queue}
1947 or return; # be conservative, not sure how that can happen, but we saw a crash here
1948
1949 (shift @$queue)->[1]->($msg);
1950
1951 push @{ $ns->{query_queue} }, @$queue;
1952
1953 if (@{ $ns->{query_queue} } == @$queue) {
1954 if (@$queue) {
1955 $ns->send_packet ($ns->{query_queue}[0][0]);
1956 } else {
1957 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1958 }
1959 }
1960 },
1961);
1962
1963=item $client->async (\&cb)
1964
1965Create a new coroutine, running the specified callback. The coroutine will
1966be automatically cancelled when the client gets destroyed (e.g. on logout,
1967or loss of connection).
1968
1969=cut
1970
1971sub cf::client::async {
1972 my ($self, $cb) = @_;
1973
1974 my $coro = &Coro::async ($cb);
1975
1976 $coro->on_destroy (sub {
1977 delete $self->{_coro}{$coro+0};
1978 });
1979
1980 $self->{_coro}{$coro+0} = $coro;
1981
1982 $coro
1983}
1984
1985cf::client->attach (
1986 on_destroy => sub {
1987 my ($ns) = @_;
1988
1989 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1990 },
1991);
1992
1993=back
1994
1995
1996=head2 SAFE SCRIPTING
1997
1998Functions that provide a safe environment to compile and execute
1999snippets of perl code without them endangering the safety of the server
2000itself. Looping constructs, I/O operators and other built-in functionality
2001is not available in the safe scripting environment, and the number of
2002functions and methods that can be called is greatly reduced.
2003
2004=cut
873 2005
874our $safe = new Safe "safe"; 2006our $safe = new Safe "safe";
875our $safe_hole = new Safe::Hole; 2007our $safe_hole = new Safe::Hole;
876 2008
877$SIG{FPE} = 'IGNORE'; 2009$SIG{FPE} = 'IGNORE';
878 2010
879$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2011$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
880 2012
881# here we export the classes and methods available to script code 2013# here we export the classes and methods available to script code
882 2014
2015=pod
2016
2017The following fucntions and emthods are available within a safe environment:
2018
2019 cf::object contr pay_amount pay_player map
2020 cf::object::player player
2021 cf::player peaceful
2022 cf::map trigger
2023
2024=cut
2025
883for ( 2026for (
884 ["cf::object" => qw(contr pay_amount pay_player)], 2027 ["cf::object" => qw(contr pay_amount pay_player map)],
885 ["cf::object::player" => qw(player)], 2028 ["cf::object::player" => qw(player)],
886 ["cf::player" => qw(peaceful)], 2029 ["cf::player" => qw(peaceful)],
2030 ["cf::map" => qw(trigger)],
887) { 2031) {
888 no strict 'refs'; 2032 no strict 'refs';
889 my ($pkg, @funs) = @$_; 2033 my ($pkg, @funs) = @$_;
890 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2034 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
891 for @funs; 2035 for @funs;
892} 2036}
2037
2038=over 4
2039
2040=item @retval = safe_eval $code, [var => value, ...]
2041
2042Compiled and executes the given perl code snippet. additional var/value
2043pairs result in temporary local (my) scalar variables of the given name
2044that are available in the code snippet. Example:
2045
2046 my $five = safe_eval '$first + $second', first => 1, second => 4;
2047
2048=cut
893 2049
894sub safe_eval($;@) { 2050sub safe_eval($;@) {
895 my ($code, %vars) = @_; 2051 my ($code, %vars) = @_;
896 2052
897 my $qcode = $code; 2053 my $qcode = $code;
920 } 2076 }
921 2077
922 wantarray ? @res : $res[0] 2078 wantarray ? @res : $res[0]
923} 2079}
924 2080
2081=item cf::register_script_function $function => $cb
2082
2083Register a function that can be called from within map/npc scripts. The
2084function should be reasonably secure and should be put into a package name
2085like the extension.
2086
2087Example: register a function that gets called whenever a map script calls
2088C<rent::overview>, as used by the C<rent> extension.
2089
2090 cf::register_script_function "rent::overview" => sub {
2091 ...
2092 };
2093
2094=cut
2095
925sub register_script_function { 2096sub register_script_function {
926 my ($fun, $cb) = @_; 2097 my ($fun, $cb) = @_;
927 2098
928 no strict 'refs'; 2099 no strict 'refs';
929 *{"safe::$fun"} = $safe_hole->wrap ($cb); 2100 *{"safe::$fun"} = $safe_hole->wrap ($cb);
930} 2101}
931 2102
2103=back
2104
2105=cut
2106
2107#############################################################################
2108
2109=head2 EXTENSION DATABASE SUPPORT
2110
2111Crossfire maintains a very simple database for extension use. It can
2112currently store anything that can be serialised using Storable, which
2113excludes objects.
2114
2115The parameter C<$family> should best start with the name of the extension
2116using it, it should be unique.
2117
2118=over 4
2119
2120=item $hashref = cf::db_get $family
2121
2122Return a hashref for use by the extension C<$family>, which can be
2123modified. After modifications, you have to call C<cf::db_dirty> or
2124C<cf::db_sync>.
2125
2126=item $value = cf::db_get $family => $key
2127
2128Returns a single value from the database
2129
2130=item cf::db_put $family => $hashref
2131
2132Stores the given family hashref into the database. Updates are delayed, if
2133you want the data to be synced to disk immediately, use C<cf::db_sync>.
2134
2135=item cf::db_put $family => $key => $value
2136
2137Stores the given C<$value> in the family hash. Updates are delayed, if you
2138want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140=item cf::db_dirty
2141
2142Marks the database as dirty, to be updated at a later time.
2143
2144=item cf::db_sync
2145
2146Immediately write the database to disk I<if it is dirty>.
2147
2148=cut
2149
2150our $DB;
2151
2152{
2153 my $path = cf::localdir . "/database.pst";
2154
2155 sub db_load() {
2156 $DB = stat $path ? Storable::retrieve $path : { };
2157 }
2158
2159 my $pid;
2160
2161 sub db_save() {
2162 waitpid $pid, 0 if $pid;
2163 if (0 == ($pid = fork)) {
2164 $DB->{_meta}{version} = 1;
2165 Storable::nstore $DB, "$path~";
2166 rename "$path~", $path;
2167 cf::_exit 0 if defined $pid;
2168 }
2169 }
2170
2171 my $dirty;
2172
2173 sub db_sync() {
2174 db_save if $dirty;
2175 undef $dirty;
2176 }
2177
2178 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2179 db_sync;
2180 });
2181
2182 sub db_dirty() {
2183 $dirty = 1;
2184 $idle->start;
2185 }
2186
2187 sub db_get($;$) {
2188 @_ >= 2
2189 ? $DB->{$_[0]}{$_[1]}
2190 : ($DB->{$_[0]} ||= { })
2191 }
2192
2193 sub db_put($$;$) {
2194 if (@_ >= 3) {
2195 $DB->{$_[0]}{$_[1]} = $_[2];
2196 } else {
2197 $DB->{$_[0]} = $_[1];
2198 }
2199 db_dirty;
2200 }
2201
2202 cf::global->attach (
2203 prio => 10000,
2204 on_cleanup => sub {
2205 db_sync;
2206 },
2207 );
2208}
2209
932############################################################################# 2210#############################################################################
933# the server's main() 2211# the server's main()
934 2212
2213sub cfg_load {
2214 open my $fh, "<:utf8", cf::confdir . "/config"
2215 or return;
2216
2217 local $/;
2218 *CFG = YAML::Syck::Load <$fh>;
2219
2220 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2221
2222 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2223 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2224
2225 if (exists $CFG{mlockall}) {
2226 eval {
2227 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2228 and die "WARNING: m(un)lockall failed: $!\n";
2229 };
2230 warn $@ if $@;
2231 }
2232}
2233
935sub main { 2234sub main {
2235 # we must not ever block the main coroutine
2236 local $Coro::idle = sub {
2237 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2238 async { Event::one_event };
2239 };
2240
2241 cfg_load;
2242 db_load;
936 load_extensions; 2243 load_extensions;
937 Event::loop; 2244 Event::loop;
938} 2245}
939 2246
940############################################################################# 2247#############################################################################
941# initialisation 2248# initialisation and cleanup
942 2249
943register "<global>", __PACKAGE__; 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
2292sub reload() {
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 }
2298
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;
2308
2309 eval {
2310 # if anything goes wrong in here, we should simply crash as we already saved
2311
2312 warn "cancel all watchers";
2313 for (Event::all_watchers) {
2314 $_->cancel if $_->data & WF_AUTOCANCEL;
2315 }
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
2327 warn "unload/nuke all extensions";
2328 for my $pkg (@EXTS) {
2329 warn "... unloading $pkg";
2330
2331 if (my $cb = $pkg->can ("unload")) {
2332 eval {
2333 $cb->($pkg);
2334 1
2335 } or warn "$pkg unloaded, but with errors: $@";
2336 }
2337
2338 warn "... nuking $pkg";
2339 Symbol::delete_package $pkg;
2340 }
2341
2342 warn "unload all perl modules loaded from $LIBDIR";
2343 while (my ($k, $v) = each %INC) {
2344 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2345
2346 warn "removing <$k>";
2347 delete $INC{$k};
2348
2349 $k =~ s/\.pm$//;
2350 $k =~ s/\//::/g;
2351
2352 if (my $cb = $k->can ("unload_module")) {
2353 $cb->();
2354 }
2355
2356 Symbol::delete_package $k;
2357 }
2358
2359 warn "get rid of safe::, as good as possible";
2360 Symbol::delete_package "safe::$_"
2361 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2362
2363 warn "unload cf.pm \"a bit\"";
2364 delete $INC{"cf.pm"};
2365
2366 # don't, removes xs symbols, too,
2367 # and global variables created in xs
2368 #Symbol::delete_package __PACKAGE__;
2369
2370 warn "reloading cf.pm";
2371 require cf;
2372 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2373
2374 warn "load config and database again";
2375 cf::cfg_load;
2376 cf::db_load;
2377
2378 warn "load extensions";
2379 cf::load_extensions;
2380
2381 warn "reattach attachments to objects/players";
2382 _global_reattach;
2383 warn "reattach attachments to maps";
2384 reattach $_ for values %MAP;
2385 };
2386
2387 if ($@) {
2388 warn $@;
2389 warn "error while reloading, exiting.";
2390 exit 1;
2391 }
2392
2393 warn "reloaded";
2394};
2395
2396register_command "reload" => sub {
2397 my ($who, $arg) = @_;
2398
2399 if ($who->flag (FLAG_WIZ)) {
2400 $who->message ("start of reload.");
2401 reload;
2402 $who->message ("end of reload.");
2403 }
2404};
944 2405
945unshift @INC, $LIBDIR; 2406unshift @INC, $LIBDIR;
946 2407
947$TICK_WATCHER = Event->timer ( 2408$TICK_WATCHER = Event->timer (
2409 reentrant => 0,
948 prio => 1, 2410 prio => 0,
949 at => $NEXT_TICK || 1, 2411 at => $NEXT_TICK || $TICK,
2412 data => WF_AUTOCANCEL,
950 cb => sub { 2413 cb => sub {
2414 $NOW = Event::time;
2415
951 cf::server_tick; # one server iteration 2416 cf::server_tick; # one server iteration
952 2417 $RUNTIME += $TICK;
953 my $NOW = Event::time;
954 $NEXT_TICK += $TICK; 2418 $NEXT_TICK += $TICK;
955 2419
2420 $WAIT_FOR_TICK->broadcast;
2421 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2422
956 # if we are delayed by four ticks, skip them all 2423 # if we are delayed by four ticks or more, skip them all
957 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2424 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
958 2425
959 $TICK_WATCHER->at ($NEXT_TICK); 2426 $TICK_WATCHER->at ($NEXT_TICK);
960 $TICK_WATCHER->start; 2427 $TICK_WATCHER->start;
961 }, 2428 },
962); 2429);
963 2430
964_reload_2; 2431IO::AIO::max_poll_time $TICK * 0.2;
2432
2433$AIO_POLL_WATCHER = Event->io (
2434 fd => IO::AIO::poll_fileno,
2435 poll => 'r',
2436 prio => 5,
2437 data => WF_AUTOCANCEL,
2438 cb => \&IO::AIO::poll_cb,
2439);
2440
2441$WRITE_RUNTIME_WATCHER = Event->timer (
2442 data => WF_AUTOCANCEL,
2443 after => 0,
2444 interval => 10,
2445 cb => sub {
2446 (Coro::unblock_sub {
2447 write_runtime
2448 or warn "ERROR: unable to write runtime file: $!";
2449 })->();
2450 },
2451);
2452
2453END { cf::emergency_save }
965 2454
9661 24551
967 2456

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines