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.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.105 by root, Sun Dec 31 17:17:23 2006 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 Fcntl;
10use IO::AIO (); 21use IO::AIO 2.31 ();
11use YAML::Syck (); 22use YAML::Syck ();
12use Time::HiRes; 23use Time::HiRes;
13use Event; 24
14$Event::Eval = 1; # no idea why this is required, but it is 25use Event; $Event::Eval = 1; # no idea why this is required, but it is
15 26
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 27# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 28$YAML::Syck::ImplicitUnicode = 1;
18 29
19use strict; 30$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20 31
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 32sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 33
23our %COMMAND = (); 34our %COMMAND = ();
24our %COMMAND_TIME = (); 35our %COMMAND_TIME = ();
25our %EXTCMD = (); 36our %EXTCMD = ();
26 37
27_init_vars;
28
29our @EVENT; 38our @EVENT;
30our $LIBDIR = datadir . "/ext"; 39our $LIBDIR = datadir . "/ext";
31 40
32our $TICK = MAX_TIME * 1e-6; 41our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER; 42our $TICK_WATCHER;
34our $NEXT_TICK; 43our $NEXT_TICK;
44our $NOW;
35 45
36our %CFG; 46our %CFG;
37 47
38our $UPTIME; $UPTIME ||= time; 48our $UPTIME; $UPTIME ||= time;
49our $RUNTIME;
50
51our %MAP; # all maps
52our $LINK_MAP; # the special {link} map
53our $FREEZE;
54
55binmode STDOUT;
56binmode STDERR;
57
58# read virtual server time, if available
59unless ($RUNTIME || !-e cf::localdir . "/runtime") {
60 open my $fh, "<", cf::localdir . "/runtime"
61 or die "unable to read runtime file: $!";
62 $RUNTIME = <$fh> + 0.;
63}
64
65mkdir cf::localdir;
66mkdir cf::localdir . "/" . cf::playerdir;
67mkdir cf::localdir . "/" . cf::tmpdir;
68mkdir cf::localdir . "/" . cf::uniquedir;
69
70our %EXT_CORO;
39 71
40############################################################################# 72#############################################################################
41 73
42=head2 GLOBAL VARIABLES 74=head2 GLOBAL VARIABLES
43 75
44=over 4 76=over 4
45 77
46=item $cf::UPTIME 78=item $cf::UPTIME
47 79
48The timestamp of the server start (so not actually an uptime). 80The timestamp of the server start (so not actually an uptime).
81
82=item $cf::RUNTIME
83
84The time this server has run, starts at 0 and is increased by $cf::TICK on
85every server tick.
49 86
50=item $cf::LIBDIR 87=item $cf::LIBDIR
51 88
52The perl library directory, where extensions and cf-specific modules can 89The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically. 90be found. It will be added to C<@INC> automatically.
91
92=item $cf::NOW
93
94The time of the last (current) server tick.
54 95
55=item $cf::TICK 96=item $cf::TICK
56 97
57The interval between server ticks, in seconds. 98The interval between server ticks, in seconds.
58 99
66=cut 107=cut
67 108
68BEGIN { 109BEGIN {
69 *CORE::GLOBAL::warn = sub { 110 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 111 my $msg = join "", @_;
112 utf8::encode $msg;
113
71 $msg .= "\n" 114 $msg .= "\n"
72 unless $msg =~ /\n$/; 115 unless $msg =~ /\n$/;
73 116
74 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 117 LOG llevError, "cfperl: $msg";
76 }; 118 };
77} 119}
78 120
121@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
122@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
123@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
124@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
125@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 126@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80 127
81# we bless all objects into (empty) derived classes to force a method lookup 128# we bless all objects into (empty) derived classes to force a method lookup
82# within the Safe compartment. 129# within the Safe compartment.
83for my $pkg (qw( 130for my $pkg (qw(
131 cf::global cf::attachable
84 cf::object cf::object::player 132 cf::object cf::object::player
85 cf::client cf::player 133 cf::client cf::player
86 cf::arch cf::living 134 cf::arch cf::living
87 cf::map cf::party cf::region 135 cf::map cf::party cf::region
88)) { 136)) {
126sub to_json($) { 174sub to_json($) {
127 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 175 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128 JSON::Syck::Dump $_[0] 176 JSON::Syck::Dump $_[0]
129} 177}
130 178
179# main coro must never ever "block" except in Event
180# sync_job ensures this by running the job in a coroutine
181# and waiting in Event while the server is otherwise frozen
182sub sync_job(&) {
183 my ($job) = @_;
184
185 my $busy = 1;
186 my @res;
187
188 local $FREEZE = 1;
189
190 my $coro = Coro::async {
191 @res = eval { $job->() };
192 warn $@ if $@;
193 undef $busy;
194 };
195
196 if ($Coro::current == $Coro::main) {
197 $coro->prio (Coro::PRIO_MAX);
198 while ($busy) {
199 Coro::cede_notself;
200 Event::one_event unless Coro::nready;
201 }
202 } else {
203 $coro->join;
204 }
205
206 wantarray ? @res : $res[0]
207}
208
209=item $coro = cf::coro { BLOCK }
210
211Creates and returns a new coro. This coro is automcatially being canceled
212when the extension calling this is being unloaded.
213
214=cut
215
216sub coro(&) {
217 my $cb = shift;
218
219 my $coro; $coro = async {
220 eval {
221 $cb->();
222 };
223 warn $@ if $@;
224 };
225
226 $coro->on_destroy (sub {
227 delete $EXT_CORO{$coro+0};
228 });
229 $EXT_CORO{$coro+0} = $coro;
230
231 $coro
232}
233
131=back 234=back
132 235
133=cut 236=cut
134 237
135############################################################################# 238#############################################################################
136 239
137=head2 EVENTS AND OBJECT ATTACHMENTS 240=head2 ATTACHABLE OBJECTS
241
242Many objects in crossfire are so-called attachable objects. That means you can
243attach callbacks/event handlers (a collection of which is called an "attachment")
244to it. All such attachable objects support the following methods.
245
246In the following description, CLASS can be any of C<global>, C<object>
247C<player>, C<client> or C<map> (i.e. the attachable objects in
248crossfire+).
138 249
139=over 4 250=over 4
140 251
141=item $object->attach ($attachment, key => $value...)
142
143=item $object->detach ($attachment)
144
145Attach/detach a pre-registered attachment to an object.
146
147=item $player->attach ($attachment, key => $value...)
148
149=item $player->detach ($attachment)
150
151Attach/detach a pre-registered attachment to a player.
152
153=item $map->attach ($attachment, key => $value...)
154
155=item $map->detach ($attachment)
156
157Attach/detach a pre-registered attachment to a client.
158
159=item $client->attach ($attachment, key => $value...) 252=item $attachable->attach ($attachment, key => $value...)
160 253
161=item $client->detach ($attachment) 254=item $attachable->detach ($attachment)
162 255
163Attach/detach a pre-registered attachment to a map. 256Attach/detach a pre-registered attachment to a specific object and give it
257the specified key/value pairs as arguments.
164 258
165=item $bool = $object->attached ($name) 259Example, attach a minesweeper attachment to the given object, making it a
26010x10 minesweeper game:
166 261
167=item $bool = $player->attached ($name) 262 $obj->attach (minesweeper => width => 10, height => 10);
168 263
169=item $bool = $client->attached ($name) 264=item $bool = $attachable->attached ($name)
170
171=item $bool = $map->attached ($name)
172 265
173Checks wether the named attachment is currently attached to the object. 266Checks wether the named attachment is currently attached to the object.
174 267
175=item cf::attach_global ... 268=item cf::CLASS->attach ...
176 269
177Attach handlers for global events. 270=item cf::CLASS->detach ...
178 271
179This and all following C<attach_*>-functions expect any number of the 272Define an anonymous attachment and attach it to all objects of the given
180following handler/hook descriptions: 273CLASS. See the next function for an explanation of its arguments.
274
275You can attach to global events by using the C<cf::global> class.
276
277Example, log all player logins:
278
279 cf::player->attach (
280 on_login => sub {
281 my ($pl) = @_;
282 ...
283 },
284 );
285
286Example, attach to the jeweler skill:
287
288 cf::object->attach (
289 type => cf::SKILL,
290 subtype => cf::SK_JEWELER,
291 on_use_skill => sub {
292 my ($sk, $ob, $part, $dir, $msg) = @_;
293 ...
294 },
295 );
296
297=item cf::CLASS::attachment $name, ...
298
299Register an attachment by C<$name> through which attachable objects of the
300given CLASS can refer to this attachment.
301
302Some classes such as crossfire maps and objects can specify attachments
303that are attached at load/instantiate time, thus the need for a name.
304
305These calls expect any number of the following handler/hook descriptions:
181 306
182=over 4 307=over 4
183 308
184=item prio => $number 309=item prio => $number
185 310
187by another C<prio> setting). Lower priority handlers get executed 312by another C<prio> setting). Lower priority handlers get executed
188earlier. The default priority is C<0>, and many built-in handlers are 313earlier. The default priority is C<0>, and many built-in handlers are
189registered at priority C<-1000>, so lower priorities should not be used 314registered at priority C<-1000>, so lower priorities should not be used
190unless you know what you are doing. 315unless you know what you are doing.
191 316
317=item type => $type
318
319(Only for C<< cf::object->attach >> calls), limits the attachment to the
320given type of objects only (the additional parameter C<subtype> can be
321used to further limit to the given subtype).
322
192=item on_I<event> => \&cb 323=item on_I<event> => \&cb
193 324
194Call the given code reference whenever the named event happens (event is 325Call the given code reference whenever the named event happens (event is
195something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 326something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
196handlers are recognised generally depends on the type of object these 327handlers are recognised generally depends on the type of object these
205package and register them. Only handlers for eevents supported by the 336package and register them. Only handlers for eevents supported by the
206object/class are recognised. 337object/class are recognised.
207 338
208=back 339=back
209 340
210=item cf::attach_to_type $object_type, $subtype, ... 341Example, define an attachment called "sockpuppet" that calls the given
342event handler when a monster attacks:
211 343
212Attach handlers for a specific object type (e.g. TRANSPORT) and 344 cf::object::attachment sockpuppet =>
213subtype. If C<$subtype> is zero or undef, matches all objects of the given 345 on_skill_attack => sub {
214type. 346 my ($self, $victim) = @_;
215 347 ...
216=item cf::attach_to_objects ...
217
218Attach handlers to all objects. Do not use this except for debugging or
219very rare events, as handlers are (obviously) called for I<all> objects in
220the game.
221
222=item cf::attach_to_players ...
223
224Attach handlers to all players.
225
226=item cf::attach_to_clients ...
227
228Attach handlers to all players.
229
230=item cf::attach_to_maps ...
231
232Attach handlers to all maps.
233
234=item cf:register_attachment $name, ...
235
236Register an attachment by name through which objects can refer to this
237attachment.
238
239=item cf:register_player_attachment $name, ...
240
241Register an attachment by name through which players can refer to this
242attachment.
243
244=item cf:register_map_attachment $name, ...
245
246Register an attachment by name through which maps can refer to this
247attachment.
248
249=cut
250
251# the following variables are defined in .xs and must not be re-created
252our @CB_GLOBAL = (); # registry for all global events
253our @CB_OBJECT = (); # all objects (should not be used except in emergency)
254our @CB_PLAYER = ();
255our @CB_CLIENT = ();
256our @CB_TYPE = (); # registry for type (cf-object class) based events
257our @CB_MAP = ();
258
259my %attachment;
260
261sub _attach_cb($\%$$$) {
262 my ($registry, $undo, $event, $prio, $cb) = @_;
263
264 use sort 'stable';
265
266 $cb = [$prio, $cb];
267
268 @{$registry->[$event]} = sort
269 { $a->[0] cmp $b->[0] }
270 @{$registry->[$event] || []}, $cb;
271
272 push @{$undo->{cb}}, [$event, $cb];
273}
274
275# attach handles attaching event callbacks
276# the only thing the caller has to do is pass the correct
277# registry (== where the callback attaches to).
278sub _attach(\@$@) {
279 my ($registry, $klass, @arg) = @_;
280
281 my $prio = 0;
282
283 my %undo = (
284 registry => $registry,
285 cb => [],
286 );
287
288 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
289
290 while (@arg) {
291 my $type = shift @arg;
292
293 if ($type eq "prio") {
294 $prio = shift @arg;
295
296 } elsif ($type eq "package") {
297 my $pkg = shift @arg;
298
299 while (my ($name, $id) = each %cb_id) {
300 if (my $cb = $pkg->can ($name)) {
301 _attach_cb $registry, %undo, $id, $prio, $cb;
302 }
303 } 348 }
304
305 } elsif (exists $cb_id{$type}) {
306 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
307
308 } elsif (ref $type) {
309 warn "attaching objects not supported, ignoring.\n";
310
311 } else {
312 shift @arg;
313 warn "attach argument '$type' not supported, ignoring.\n";
314 }
315 }
316
317 \%undo
318}
319
320sub _attach_attachment {
321 my ($obj, $name, %arg) = @_;
322
323 return if exists $obj->{_attachment}{$name};
324
325 my $res;
326
327 if (my $attach = $attachment{$name}) {
328 my $registry = $obj->registry;
329
330 for (@$attach) {
331 my ($klass, @attach) = @$_;
332 $res = _attach @$registry, $klass, @attach;
333 }
334
335 $obj->{$name} = \%arg;
336 } else {
337 warn "object uses attachment '$name' that is not available, postponing.\n";
338 }
339
340 $obj->{_attachment}{$name} = undef;
341
342 $res->{attachment} = $name;
343 $res
344}
345
346*cf::object::attach =
347*cf::player::attach =
348*cf::client::attach =
349*cf::map::attach = sub {
350 my ($obj, $name, %arg) = @_;
351
352 _attach_attachment $obj, $name, %arg;
353};
354
355# all those should be optimised
356*cf::object::detach =
357*cf::player::detach =
358*cf::client::detach =
359*cf::map::detach = sub {
360 my ($obj, $name) = @_;
361
362 delete $obj->{_attachment}{$name};
363 reattach ($obj);
364};
365
366*cf::object::attached =
367*cf::player::attached =
368*cf::client::attached =
369*cf::map::attached = sub {
370 my ($obj, $name) = @_;
371
372 exists $obj->{_attachment}{$name}
373};
374
375sub attach_global {
376 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
377}
378
379sub attach_to_type {
380 my $type = shift;
381 my $subtype = shift;
382
383 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
384}
385
386sub attach_to_objects {
387 _attach @CB_OBJECT, KLASS_OBJECT, @_
388}
389
390sub attach_to_players {
391 _attach @CB_PLAYER, KLASS_PLAYER, @_
392}
393
394sub attach_to_clients {
395 _attach @CB_CLIENT, KLASS_CLIENT, @_
396}
397
398sub attach_to_maps {
399 _attach @CB_MAP, KLASS_MAP, @_
400}
401
402sub register_attachment {
403 my $name = shift;
404
405 $attachment{$name} = [[KLASS_OBJECT, @_]];
406}
407
408sub register_player_attachment {
409 my $name = shift;
410
411 $attachment{$name} = [[KLASS_PLAYER, @_]];
412}
413
414sub register_client_attachment {
415 my $name = shift;
416
417 $attachment{$name} = [[KLASS_CLIENT, @_]];
418}
419
420sub register_map_attachment {
421 my $name = shift;
422
423 $attachment{$name} = [[KLASS_MAP, @_]];
424}
425
426our $override;
427our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
428
429sub override {
430 $override = 1;
431 @invoke_results = ();
432}
433
434sub do_invoke {
435 my $event = shift;
436 my $callbacks = shift;
437
438 @invoke_results = ();
439
440 local $override;
441
442 for (@$callbacks) {
443 eval { &{$_->[1]} };
444
445 if ($@) {
446 warn "$@";
447 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
448 override;
449 }
450
451 return 1 if $override;
452 }
453
454 0 349 }
455}
456 350
457=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 351=item $attachable->valid
458
459=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
460
461=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
462
463=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
464
465=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
466
467Generate a global/object/player/map-specific event with the given arguments.
468
469This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
470removed in future versions), and there is no public API to access override
471results (if you must, access C<@cf::invoke_results> directly).
472
473=back
474
475=cut
476
477#############################################################################
478
479=head2 METHODS VALID FOR ALL CORE OBJECTS
480
481=over 4
482
483=item $object->valid, $player->valid, $client->valid, $map->valid
484 352
485Just because you have a perl object does not mean that the corresponding 353Just because you have a perl object does not mean that the corresponding
486C-level object still exists. If you try to access an object that has no 354C-level object still exists. If you try to access an object that has no
487valid C counterpart anymore you get an exception at runtime. This method 355valid C counterpart anymore you get an exception at runtime. This method
488can be used to test for existence of the C object part without causing an 356can be used to test for existence of the C object part without causing an
489exception. 357exception.
490 358
359=cut
360
361# the following variables are defined in .xs and must not be re-created
362our @CB_GLOBAL = (); # registry for all global events
363our @CB_ATTACHABLE = (); # registry for all attachables
364our @CB_OBJECT = (); # all objects (should not be used except in emergency)
365our @CB_PLAYER = ();
366our @CB_CLIENT = ();
367our @CB_TYPE = (); # registry for type (cf-object class) based events
368our @CB_MAP = ();
369
370my %attachment;
371
372sub _attach_cb($$$$) {
373 my ($registry, $event, $prio, $cb) = @_;
374
375 use sort 'stable';
376
377 $cb = [$prio, $cb];
378
379 @{$registry->[$event]} = sort
380 { $a->[0] cmp $b->[0] }
381 @{$registry->[$event] || []}, $cb;
382}
383
384# hack
385my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
386
387# attach handles attaching event callbacks
388# the only thing the caller has to do is pass the correct
389# registry (== where the callback attaches to).
390sub _attach {
391 my ($registry, $klass, @arg) = @_;
392
393 my $object_type;
394 my $prio = 0;
395 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
396
397 #TODO: get rid of this hack
398 if ($attachable_klass{$klass}) {
399 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
400 }
401
402 while (@arg) {
403 my $type = shift @arg;
404
405 if ($type eq "prio") {
406 $prio = shift @arg;
407
408 } elsif ($type eq "type") {
409 $object_type = shift @arg;
410 $registry = $CB_TYPE[$object_type] ||= [];
411
412 } elsif ($type eq "subtype") {
413 defined $object_type or Carp::croak "subtype specified without type";
414 my $object_subtype = shift @arg;
415 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
416
417 } elsif ($type eq "package") {
418 my $pkg = shift @arg;
419
420 while (my ($name, $id) = each %cb_id) {
421 if (my $cb = $pkg->can ($name)) {
422 _attach_cb $registry, $id, $prio, $cb;
423 }
424 }
425
426 } elsif (exists $cb_id{$type}) {
427 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
428
429 } elsif (ref $type) {
430 warn "attaching objects not supported, ignoring.\n";
431
432 } else {
433 shift @arg;
434 warn "attach argument '$type' not supported, ignoring.\n";
435 }
436 }
437}
438
439sub _object_attach {
440 my ($obj, $name, %arg) = @_;
441
442 return if exists $obj->{_attachment}{$name};
443
444 if (my $attach = $attachment{$name}) {
445 my $registry = $obj->registry;
446
447 for (@$attach) {
448 my ($klass, @attach) = @$_;
449 _attach $registry, $klass, @attach;
450 }
451
452 $obj->{$name} = \%arg;
453 } else {
454 warn "object uses attachment '$name' that is not available, postponing.\n";
455 }
456
457 $obj->{_attachment}{$name} = undef;
458}
459
460sub cf::attachable::attach {
461 if (ref $_[0]) {
462 _object_attach @_;
463 } else {
464 _attach shift->_attach_registry, @_;
465 }
466};
467
468# all those should be optimised
469sub cf::attachable::detach {
470 my ($obj, $name) = @_;
471
472 if (ref $obj) {
473 delete $obj->{_attachment}{$name};
474 reattach ($obj);
475 } else {
476 Carp::croak "cannot, currently, detach class attachments";
477 }
478};
479
480sub cf::attachable::attached {
481 my ($obj, $name) = @_;
482
483 exists $obj->{_attachment}{$name}
484}
485
486for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
487 eval "#line " . __LINE__ . " 'cf.pm'
488 sub cf::\L$klass\E::_attach_registry {
489 (\\\@CB_$klass, KLASS_$klass)
490 }
491
492 sub cf::\L$klass\E::attachment {
493 my \$name = shift;
494
495 \$attachment{\$name} = [[KLASS_$klass, \@_]];
496 }
497 ";
498 die if $@;
499}
500
501our $override;
502our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
503
504sub override {
505 $override = 1;
506 @invoke_results = ();
507}
508
509sub do_invoke {
510 my $event = shift;
511 my $callbacks = shift;
512
513 @invoke_results = ();
514
515 local $override;
516
517 for (@$callbacks) {
518 eval { &{$_->[1]} };
519
520 if ($@) {
521 warn "$@";
522 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
523 override;
524 }
525
526 return 1 if $override;
527 }
528
529 0
530}
531
532=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
533
534=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
535
536Generate an object-specific event with the given arguments.
537
538This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
539removed in future versions), and there is no public API to access override
540results (if you must, access C<@cf::invoke_results> directly).
541
491=back 542=back
492 543
493=cut 544=cut
494
495*cf::object::valid =
496*cf::player::valid =
497*cf::client::valid =
498*cf::map::valid = \&cf::_valid;
499 545
500############################################################################# 546#############################################################################
501# object support 547# object support
502 548
503sub instantiate {
504 my ($obj, $data) = @_;
505
506 $data = from_json $data;
507
508 for (@$data) {
509 my ($name, $args) = @$_;
510
511 $obj->attach ($name, %{$args || {} });
512 }
513}
514
515# basically do the same as instantiate, without calling instantiate
516sub reattach { 549sub reattach {
550 # basically do the same as instantiate, without calling instantiate
517 my ($obj) = @_; 551 my ($obj) = @_;
552
518 my $registry = $obj->registry; 553 my $registry = $obj->registry;
519 554
520 @$registry = (); 555 @$registry = ();
521 556
522 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 557 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
523 558
524 for my $name (keys %{ $obj->{_attachment} || {} }) { 559 for my $name (keys %{ $obj->{_attachment} || {} }) {
525 if (my $attach = $attachment{$name}) { 560 if (my $attach = $attachment{$name}) {
526 for (@$attach) { 561 for (@$attach) {
527 my ($klass, @attach) = @$_; 562 my ($klass, @attach) = @$_;
528 _attach @$registry, $klass, @attach; 563 _attach $registry, $klass, @attach;
529 } 564 }
530 } else { 565 } else {
531 warn "object uses attachment '$name' that is not available, postponing.\n"; 566 warn "object uses attachment '$name' that is not available, postponing.\n";
532 } 567 }
533 } 568 }
534} 569}
535 570
536sub object_freezer_save { 571cf::attachable->attach (
537 my ($filename, $rdata, $objs) = @_;
538
539 if (length $$rdata) {
540 warn sprintf "saving %s (%d,%d)\n",
541 $filename, length $$rdata, scalar @$objs;
542
543 if (open my $fh, ">:raw", "$filename~") {
544 chmod SAVE_MODE, $fh;
545 syswrite $fh, $$rdata;
546 close $fh;
547
548 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
549 chmod SAVE_MODE, $fh;
550 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
551 close $fh;
552 rename "$filename.pst~", "$filename.pst";
553 } else {
554 unlink "$filename.pst";
555 }
556
557 rename "$filename~", $filename;
558 } else {
559 warn "FATAL: $filename~: $!\n";
560 }
561 } else {
562 unlink $filename;
563 unlink "$filename.pst";
564 }
565}
566
567sub object_freezer_as_string {
568 my ($rdata, $objs) = @_;
569
570 use Data::Dumper;
571
572 $$rdata . Dumper $objs
573}
574
575sub object_thawer_load {
576 my ($filename) = @_;
577
578 local $/;
579
580 my $av;
581
582 #TODO: use sysread etc.
583 if (open my $data, "<:raw:perlio", $filename) {
584 $data = <$data>;
585 if (open my $pst, "<:raw:perlio", "$filename.pst") {
586 $av = eval { (Storable::thaw <$pst>)->{objs} };
587 }
588 return ($data, $av);
589 }
590
591 ()
592}
593
594attach_to_objects
595 prio => -1000000, 572 prio => -1000000,
573 on_instantiate => sub {
574 my ($obj, $data) = @_;
575
576 $data = from_json $data;
577
578 for (@$data) {
579 my ($name, $args) = @$_;
580
581 $obj->attach ($name, %{$args || {} });
582 }
583 },
584 on_reattach => \&reattach,
596 on_clone => sub { 585 on_clone => sub {
597 my ($src, $dst) = @_; 586 my ($src, $dst) = @_;
598 587
599 @{$dst->registry} = @{$src->registry}; 588 @{$dst->registry} = @{$src->registry};
600 589
601 %$dst = %$src; 590 %$dst = %$src;
602 591
603 %{$dst->{_attachment}} = %{$src->{_attachment}} 592 %{$dst->{_attachment}} = %{$src->{_attachment}}
604 if exists $src->{_attachment}; 593 if exists $src->{_attachment};
605 }, 594 },
606; 595);
596
597sub object_freezer_save {
598 my ($filename, $rdata, $objs) = @_;
599
600 sync_job {
601 if (length $$rdata) {
602 warn sprintf "saving %s (%d,%d)\n",
603 $filename, length $$rdata, scalar @$objs;
604
605 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
606 chmod SAVE_MODE, $fh;
607 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
608 aio_fsync $fh;
609 close $fh;
610
611 if (@$objs) {
612 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
613 chmod SAVE_MODE, $fh;
614 my $data = Storable::nfreeze { version => 1, objs => $objs };
615 aio_write $fh, 0, (length $data), $data, 0;
616 aio_fsync $fh;
617 close $fh;
618 aio_rename "$filename.pst~", "$filename.pst";
619 }
620 } else {
621 aio_unlink "$filename.pst";
622 }
623
624 aio_rename "$filename~", $filename;
625 } else {
626 warn "FATAL: $filename~: $!\n";
627 }
628 } else {
629 aio_unlink $filename;
630 aio_unlink "$filename.pst";
631 }
632 }
633}
634
635sub object_freezer_as_string {
636 my ($rdata, $objs) = @_;
637
638 use Data::Dumper;
639
640 $$rdata . Dumper $objs
641}
642
643sub object_thawer_load {
644 my ($filename) = @_;
645
646 my ($data, $av);
647
648 (aio_load $filename, $data) >= 0
649 or return;
650
651 unless (aio_stat "$filename.pst") {
652 (aio_load "$filename.pst", $av) >= 0
653 or return;
654 $av = eval { (Storable::thaw <$av>)->{objs} };
655 }
656
657 return ($data, $av);
658}
607 659
608############################################################################# 660#############################################################################
609# command handling &c 661# command handling &c
610 662
611=item cf::register_command $name => \&callback($ob,$args); 663=item cf::register_command $name => \&callback($ob,$args);
640 #warn "registering extcmd '$name' to '$caller'"; 692 #warn "registering extcmd '$name' to '$caller'";
641 693
642 $EXTCMD{$name} = [$cb, $caller]; 694 $EXTCMD{$name} = [$cb, $caller];
643} 695}
644 696
645attach_to_players 697cf::player->attach (
646 on_command => sub { 698 on_command => sub {
647 my ($pl, $name, $params) = @_; 699 my ($pl, $name, $params) = @_;
648 700
649 my $cb = $COMMAND{$name} 701 my $cb = $COMMAND{$name}
650 or return; 702 or return;
670 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 722 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671 } 723 }
672 724
673 cf::override; 725 cf::override;
674 }, 726 },
675; 727);
676 728
677sub register { 729sub register {
678 my ($base, $pkg) = @_; 730 my ($base, $pkg) = @_;
679 731
680 #TODO 732 #TODO
770 defined $path or return; 822 defined $path or return;
771 823
772 unlink "$path.pst"; 824 unlink "$path.pst";
773}; 825};
774 826
775attach_to_maps prio => -10000, package => cf::mapsupport::; 827cf::map->attach (prio => -10000, package => cf::mapsupport::);
776 828
777############################################################################# 829#############################################################################
778# load/save perl data associated with player->ob objects 830# load/save perl data associated with player->ob objects
779 831
780sub all_objects(@) { 832sub all_objects(@) {
781 @_, map all_objects ($_->inv), @_ 833 @_, map all_objects ($_->inv), @_
782} 834}
783 835
784# TODO: compatibility cruft, remove when no longer needed 836# TODO: compatibility cruft, remove when no longer needed
785attach_to_players 837cf::player->attach (
786 on_load => sub { 838 on_load => sub {
787 my ($pl, $path) = @_; 839 my ($pl, $path) = @_;
788 840
789 for my $o (all_objects $pl->ob) { 841 for my $o (all_objects $pl->ob) {
790 if (my $value = $o->get_ob_key_value ("_perl_data")) { 842 if (my $value = $o->get_ob_key_value ("_perl_data")) {
792 844
793 %$o = %{ Storable::thaw pack "H*", $value }; 845 %$o = %{ Storable::thaw pack "H*", $value };
794 } 846 }
795 } 847 }
796 }, 848 },
797; 849);
798 850
799############################################################################# 851#############################################################################
800 852
801=head2 CORE EXTENSIONS 853=head2 CORE EXTENSIONS
802 854
803Functions and methods that extend core crossfire objects. 855Functions and methods that extend core crossfire objects.
856
857=head3 cf::player
804 858
805=over 4 859=over 4
806 860
807=item cf::player::exists $login 861=item cf::player::exists $login
808 862
813sub cf::player::exists($) { 867sub cf::player::exists($) {
814 cf::player::find $_[0] 868 cf::player::find $_[0]
815 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 869 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
816} 870}
817 871
872=item $player->ext_reply ($msgid, $msgtype, %msg)
873
874Sends an ext reply to the player.
875
876=cut
877
878sub cf::player::ext_reply($$$%) {
879 my ($self, $id, %msg) = @_;
880
881 $msg{msgid} = $id;
882
883 $self->send ("ext " . to_json \%msg);
884}
885
886=back
887
888=head3 cf::object::player
889
890=over 4
891
818=item $player_object->reply ($npc, $msg[, $flags]) 892=item $player_object->reply ($npc, $msg[, $flags])
819 893
820Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 894Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
821can be C<undef>. Does the right thing when the player is currently in a 895can be C<undef>. Does the right thing when the player is currently in a
822dialogue with the given NPC character. 896dialogue with the given NPC character.
823 897
824=cut 898=cut
825 899
826# rough implementation of a future "reply" method that works 900# rough implementation of a future "reply" method that works
827# with dialog boxes. 901# with dialog boxes.
902#TODO: the first argument must go, split into a $npc->reply_to ( method
828sub cf::object::player::reply($$$;$) { 903sub cf::object::player::reply($$$;$) {
829 my ($self, $npc, $msg, $flags) = @_; 904 my ($self, $npc, $msg, $flags) = @_;
830 905
831 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 906 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
832 907
836 $msg = $npc->name . " says: $msg" if $npc; 911 $msg = $npc->name . " says: $msg" if $npc;
837 $self->message ($msg, $flags); 912 $self->message ($msg, $flags);
838 } 913 }
839} 914}
840 915
841=item $player->ext_reply ($msgid, $msgtype, %msg)
842
843Sends an ext reply to the player.
844
845=cut
846
847sub cf::player::ext_reply($$$%) {
848 my ($self, $id, %msg) = @_;
849
850 $msg{msgid} = $id;
851
852 $self->send ("ext " . to_json \%msg);
853}
854
855=item $player_object->may ("access") 916=item $player_object->may ("access")
856 917
857Returns wether the given player is authorized to access resource "access" 918Returns wether the given player is authorized to access resource "access"
858(e.g. "command_wizcast"). 919(e.g. "command_wizcast").
859 920
866 (ref $cf::CFG{"may_$access"} 927 (ref $cf::CFG{"may_$access"}
867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 928 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868 : $cf::CFG{"may_$access"}) 929 : $cf::CFG{"may_$access"})
869} 930}
870 931
871=cut 932=head3 cf::client
872 933
873############################################################################# 934=over 4
935
936=item $client->send_drawinfo ($text, $flags)
937
938Sends a drawinfo packet to the client. Circumvents output buffering so
939should not be used under normal circumstances.
940
941=cut
942
943sub cf::client::send_drawinfo {
944 my ($self, $text, $flags) = @_;
945
946 utf8::encode $text;
947 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
948}
949
950
951=item $success = $client->query ($flags, "text", \&cb)
952
953Queues a query to the client, calling the given callback with
954the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
955C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
956
957Queries can fail, so check the return code. Or don't, as queries will become
958reliable at some point in the future.
959
960=cut
961
962sub cf::client::query {
963 my ($self, $flags, $text, $cb) = @_;
964
965 return unless $self->state == ST_PLAYING
966 || $self->state == ST_SETUP
967 || $self->state == ST_CUSTOM;
968
969 $self->state (ST_CUSTOM);
970
971 utf8::encode $text;
972 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
973
974 $self->send_packet ($self->{query_queue}[0][0])
975 if @{ $self->{query_queue} } == 1;
976}
977
978cf::client->attach (
979 on_reply => sub {
980 my ($ns, $msg) = @_;
981
982 # this weird shuffling is so that direct followup queries
983 # get handled first
984 my $queue = delete $ns->{query_queue};
985
986 (shift @$queue)->[1]->($msg);
987
988 push @{ $ns->{query_queue} }, @$queue;
989
990 if (@{ $ns->{query_queue} } == @$queue) {
991 if (@$queue) {
992 $ns->send_packet ($ns->{query_queue}[0][0]);
993 } else {
994 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
995 }
996 }
997 },
998);
999
1000=item $client->coro (\&cb)
1001
1002Create a new coroutine, running the specified callback. The coroutine will
1003be automatically cancelled when the client gets destroyed (e.g. on logout,
1004or loss of connection).
1005
1006=cut
1007
1008sub cf::client::coro {
1009 my ($self, $cb) = @_;
1010
1011 my $coro; $coro = async {
1012 eval {
1013 $cb->();
1014 };
1015 warn $@ if $@;
1016 };
1017
1018 $coro->on_destroy (sub {
1019 delete $self->{_coro}{$coro+0};
1020 });
1021
1022 $self->{_coro}{$coro+0} = $coro;
1023
1024 $coro
1025}
1026
1027cf::client->attach (
1028 on_destroy => sub {
1029 my ($ns) = @_;
1030
1031 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1032 },
1033);
1034
1035=back
1036
874 1037
875=head2 SAFE SCRIPTING 1038=head2 SAFE SCRIPTING
876 1039
877Functions that provide a safe environment to compile and execute 1040Functions that provide a safe environment to compile and execute
878snippets of perl code without them endangering the safety of the server 1041snippets of perl code without them endangering the safety of the server
1078 $DB->{$_[0]} = $_[1]; 1241 $DB->{$_[0]} = $_[1];
1079 } 1242 }
1080 db_dirty; 1243 db_dirty;
1081 } 1244 }
1082 1245
1083 attach_global 1246 cf::global->attach (
1084 prio => 10000, 1247 prio => 10000,
1085 on_cleanup => sub { 1248 on_cleanup => sub {
1086 db_sync; 1249 db_sync;
1087 }, 1250 },
1088 ; 1251 );
1089} 1252}
1090 1253
1091############################################################################# 1254#############################################################################
1092# the server's main() 1255# the server's main()
1093 1256
1107} 1270}
1108 1271
1109############################################################################# 1272#############################################################################
1110# initialisation 1273# initialisation
1111 1274
1112sub _perl_reload(&) { 1275sub _perl_reload() {
1113 my ($msg) = @_; 1276 warn "reloading...";
1114
1115 $msg->("reloading...");
1116 1277
1117 eval { 1278 eval {
1279 local $FREEZE = 1;
1280
1281 cf::emergency_save;
1282
1118 # cancel all watchers 1283 # cancel all watchers
1119 for (Event::all_watchers) { 1284 for (Event::all_watchers) {
1120 $_->cancel if $_->data & WF_AUTOCANCEL; 1285 $_->cancel if $_->data & WF_AUTOCANCEL;
1121 } 1286 }
1122 1287
1288 # cancel all extension coros
1289 $_->cancel for values %EXT_CORO;
1290 %EXT_CORO = ();
1291
1123 # unload all extensions 1292 # unload all extensions
1124 for (@exts) { 1293 for (@exts) {
1125 $msg->("unloading <$_>"); 1294 warn "unloading <$_>";
1126 unload_extension $_; 1295 unload_extension $_;
1127 } 1296 }
1128 1297
1129 # unload all modules loaded from $LIBDIR 1298 # unload all modules loaded from $LIBDIR
1130 while (my ($k, $v) = each %INC) { 1299 while (my ($k, $v) = each %INC) {
1131 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1300 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1132 1301
1133 $msg->("removing <$k>"); 1302 warn "removing <$k>";
1134 delete $INC{$k}; 1303 delete $INC{$k};
1135 1304
1136 $k =~ s/\.pm$//; 1305 $k =~ s/\.pm$//;
1137 $k =~ s/\//::/g; 1306 $k =~ s/\//::/g;
1138 1307
1143 Symbol::delete_package $k; 1312 Symbol::delete_package $k;
1144 } 1313 }
1145 1314
1146 # sync database to disk 1315 # sync database to disk
1147 cf::db_sync; 1316 cf::db_sync;
1317 IO::AIO::flush;
1148 1318
1149 # get rid of safe::, as good as possible 1319 # get rid of safe::, as good as possible
1150 Symbol::delete_package "safe::$_" 1320 Symbol::delete_package "safe::$_"
1151 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1321 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1152 1322
1153 # remove register_script_function callbacks 1323 # remove register_script_function callbacks
1154 # TODO 1324 # TODO
1155 1325
1156 # unload cf.pm "a bit" 1326 # unload cf.pm "a bit"
1159 # don't, removes xs symbols, too, 1329 # don't, removes xs symbols, too,
1160 # and global variables created in xs 1330 # and global variables created in xs
1161 #Symbol::delete_package __PACKAGE__; 1331 #Symbol::delete_package __PACKAGE__;
1162 1332
1163 # reload cf.pm 1333 # reload cf.pm
1164 $msg->("reloading cf.pm"); 1334 warn "reloading cf.pm";
1165 require cf; 1335 require cf;
1336 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1166 1337
1167 # load config and database again 1338 # load config and database again
1168 cf::cfg_load; 1339 cf::cfg_load;
1169 cf::db_load; 1340 cf::db_load;
1170 1341
1171 # load extensions 1342 # load extensions
1172 $msg->("load extensions"); 1343 warn "load extensions";
1173 cf::load_extensions; 1344 cf::load_extensions;
1174 1345
1175 # reattach attachments to objects 1346 # reattach attachments to objects
1176 $msg->("reattach"); 1347 warn "reattach";
1177 _global_reattach; 1348 _global_reattach;
1178 }; 1349 };
1179 $msg->($@) if $@; 1350 warn $@ if $@;
1180 1351
1181 $msg->("reloaded"); 1352 warn "reloaded";
1182}; 1353};
1183 1354
1184sub perl_reload() { 1355sub perl_reload() {
1185 _perl_reload { 1356 _perl_reload;
1186 warn $_[0];
1187 print "$_[0]\n";
1188 };
1189} 1357}
1190 1358
1191register "<global>", __PACKAGE__; 1359register "<global>", __PACKAGE__;
1192 1360
1193register_command "perl-reload" => sub { 1361register_command "perl-reload" => sub {
1194 my ($who, $arg) = @_; 1362 my ($who, $arg) = @_;
1195 1363
1196 if ($who->flag (FLAG_WIZ)) { 1364 if ($who->flag (FLAG_WIZ)) {
1365 $who->message ("reloading...");
1197 _perl_reload { 1366 _perl_reload;
1198 warn $_[0];
1199 $who->message ($_[0]);
1200 };
1201 } 1367 }
1202}; 1368};
1203 1369
1204unshift @INC, $LIBDIR; 1370unshift @INC, $LIBDIR;
1205 1371
1206$TICK_WATCHER = Event->timer ( 1372$TICK_WATCHER = Event->timer (
1373 reentrant => 0,
1207 prio => 0, 1374 prio => 0,
1208 at => $NEXT_TICK || 1, 1375 at => $NEXT_TICK || $TICK,
1209 data => WF_AUTOCANCEL, 1376 data => WF_AUTOCANCEL,
1210 cb => sub { 1377 cb => sub {
1378 unless ($FREEZE) {
1211 cf::server_tick; # one server iteration 1379 cf::server_tick; # one server iteration
1380 $RUNTIME += $TICK;
1381 }
1212 1382
1213 my $NOW = Event::time;
1214 $NEXT_TICK += $TICK; 1383 $NEXT_TICK += $TICK;
1215 1384
1216 # if we are delayed by four ticks or more, skip them all 1385 # if we are delayed by four ticks or more, skip them all
1217 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1386 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1218 1387
1219 $TICK_WATCHER->at ($NEXT_TICK); 1388 $TICK_WATCHER->at ($NEXT_TICK);
1220 $TICK_WATCHER->start; 1389 $TICK_WATCHER->start;
1221 }, 1390 },
1222); 1391);
1227 poll => 'r', 1396 poll => 'r',
1228 prio => 5, 1397 prio => 5,
1229 data => WF_AUTOCANCEL, 1398 data => WF_AUTOCANCEL,
1230 cb => \&IO::AIO::poll_cb); 1399 cb => \&IO::AIO::poll_cb);
1231 1400
1401# we must not ever block the main coroutine
1402$Coro::idle = sub {
1403 #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1404 warn "FATAL: Coro::idle was called, major BUG\n";
1405 (Coro::unblock_sub {
1406 Event::one_event;
1407 })->();
1408};
1409
12321 14101
1233 1411

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines