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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines