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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines