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.86 by root, Thu Dec 14 05:09:32 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( 128for my $pkg (qw(
129 cf::global cf::attachable
82 cf::object cf::object::player 130 cf::object cf::object::player
83 cf::client_socket cf::player 131 cf::client cf::player
84 cf::arch cf::living 132 cf::arch cf::living
85 cf::map cf::party cf::region 133 cf::map cf::party cf::region
86)) { 134)) {
87 no strict 'refs'; 135 no strict 'refs';
88 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 136 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
124sub to_json($) { 172sub to_json($) {
125 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 173 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
126 JSON::Syck::Dump $_[0] 174 JSON::Syck::Dump $_[0]
127} 175}
128 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
129=back 202=back
130 203
131=cut 204=cut
132 205
133############################################################################# 206#############################################################################
134 207
135=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+).
136 217
137=over 4 218=over 4
138 219
139=item $object->attach ($attachment, key => $value...)
140
141=item $object->detach ($attachment)
142
143Attach/detach a pre-registered attachment to an object.
144
145=item $player->attach ($attachment, key => $value...)
146
147=item $player->detach ($attachment)
148
149Attach/detach a pre-registered attachment to a player.
150
151=item $map->attach ($attachment, key => $value...) 220=item $attachable->attach ($attachment, key => $value...)
152 221
153=item $map->detach ($attachment) 222=item $attachable->detach ($attachment)
154 223
155Attach/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.
156 226
157=item $bool = $object->attached ($name) 227Example, attach a minesweeper attachment to the given object, making it a
22810x10 minesweeper game:
158 229
159=item $bool = $player->attached ($name) 230 $obj->attach (minesweeper => width => 10, height => 10);
160 231
161=item $bool = $map->attached ($name) 232=item $bool = $attachable->attached ($name)
162 233
163Checks wether the named attachment is currently attached to the object. 234Checks wether the named attachment is currently attached to the object.
164 235
165=item cf::attach_global ... 236=item cf::CLASS->attach ...
166 237
167Attach handlers for global events. 238=item cf::CLASS->detach ...
168 239
169This and all following C<attach_*>-functions expect any number of the 240Define an anonymous attachment and attach it to all objects of the given
170following 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:
171 274
172=over 4 275=over 4
173 276
174=item prio => $number 277=item prio => $number
175 278
177by another C<prio> setting). Lower priority handlers get executed 280by another C<prio> setting). Lower priority handlers get executed
178earlier. 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
179registered at priority C<-1000>, so lower priorities should not be used 282registered at priority C<-1000>, so lower priorities should not be used
180unless you know what you are doing. 283unless you know what you are doing.
181 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
182=item on_I<event> => \&cb 291=item on_I<event> => \&cb
183 292
184Call the given code reference whenever the named event happens (event is 293Call the given code reference whenever the named event happens (event is
185something 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
186handlers are recognised generally depends on the type of object these 295handlers are recognised generally depends on the type of object these
195package and register them. Only handlers for eevents supported by the 304package and register them. Only handlers for eevents supported by the
196object/class are recognised. 305object/class are recognised.
197 306
198=back 307=back
199 308
200=item cf::attach_to_type $object_type, $subtype, ... 309Example, define an attachment called "sockpuppet" that calls the given
310event handler when a monster attacks:
201 311
202Attach handlers for a specific object type (e.g. TRANSPORT) and 312 cf::object::attachment sockpuppet =>
203subtype. If C<$subtype> is zero or undef, matches all objects of the given 313 on_skill_attack => sub {
204type. 314 my ($self, $victim) = @_;
205 315 ...
206=item cf::attach_to_objects ...
207
208Attach handlers to all objects. Do not use this except for debugging or
209very rare events, as handlers are (obviously) called for I<all> objects in
210the game.
211
212=item cf::attach_to_players ...
213
214Attach handlers to all players.
215
216=item cf::attach_to_maps ...
217
218Attach handlers to all maps.
219
220=item cf:register_attachment $name, ...
221
222Register an attachment by name through which objects can refer to this
223attachment.
224
225=item cf:register_player_attachment $name, ...
226
227Register an attachment by name through which players can refer to this
228attachment.
229
230=item cf:register_map_attachment $name, ...
231
232Register an attachment by name through which maps can refer to this
233attachment.
234
235=cut
236
237# the following variables are defined in .xs and must not be re-created
238our @CB_GLOBAL = (); # registry for all global events
239our @CB_OBJECT = (); # all objects (should not be used except in emergency)
240our @CB_PLAYER = ();
241our @CB_TYPE = (); # registry for type (cf-object class) based events
242our @CB_MAP = ();
243
244my %attachment;
245
246sub _attach_cb($\%$$$) {
247 my ($registry, $undo, $event, $prio, $cb) = @_;
248
249 use sort 'stable';
250
251 $cb = [$prio, $cb];
252
253 @{$registry->[$event]} = sort
254 { $a->[0] cmp $b->[0] }
255 @{$registry->[$event] || []}, $cb;
256
257 push @{$undo->{cb}}, [$event, $cb];
258}
259
260# attach handles attaching event callbacks
261# the only thing the caller has to do is pass the correct
262# registry (== where the callback attaches to).
263sub _attach(\@$@) {
264 my ($registry, $klass, @arg) = @_;
265
266 my $prio = 0;
267
268 my %undo = (
269 registry => $registry,
270 cb => [],
271 );
272
273 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
274
275 while (@arg) {
276 my $type = shift @arg;
277
278 if ($type eq "prio") {
279 $prio = shift @arg;
280
281 } elsif ($type eq "package") {
282 my $pkg = shift @arg;
283
284 while (my ($name, $id) = each %cb_id) {
285 if (my $cb = $pkg->can ($name)) {
286 _attach_cb $registry, %undo, $id, $prio, $cb;
287 }
288 } 316 }
289
290 } elsif (exists $cb_id{$type}) {
291 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
292
293 } elsif (ref $type) {
294 warn "attaching objects not supported, ignoring.\n";
295
296 } else {
297 shift @arg;
298 warn "attach argument '$type' not supported, ignoring.\n";
299 }
300 }
301
302 \%undo
303}
304
305sub _attach_attachment {
306 my ($obj, $name, %arg) = @_;
307
308 return if exists $obj->{_attachment}{$name};
309
310 my $res;
311
312 if (my $attach = $attachment{$name}) {
313 my $registry = $obj->registry;
314
315 for (@$attach) {
316 my ($klass, @attach) = @$_;
317 $res = _attach @$registry, $klass, @attach;
318 }
319
320 $obj->{$name} = \%arg;
321 } else {
322 warn "object uses attachment '$name' that is not available, postponing.\n";
323 }
324
325 $obj->{_attachment}{$name} = undef;
326
327 $res->{attachment} = $name;
328 $res
329}
330
331*cf::object::attach =
332*cf::player::attach =
333*cf::map::attach = sub {
334 my ($obj, $name, %arg) = @_;
335
336 _attach_attachment $obj, $name, %arg;
337};
338
339# all those should be optimised
340*cf::object::detach =
341*cf::player::detach =
342*cf::map::detach = sub {
343 my ($obj, $name) = @_;
344
345 delete $obj->{_attachment}{$name};
346 reattach ($obj);
347};
348
349*cf::object::attached =
350*cf::player::attached =
351*cf::map::attached = sub {
352 my ($obj, $name) = @_;
353
354 exists $obj->{_attachment}{$name}
355};
356
357sub attach_global {
358 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
359}
360
361sub attach_to_type {
362 my $type = shift;
363 my $subtype = shift;
364
365 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
366}
367
368sub attach_to_objects {
369 _attach @CB_OBJECT, KLASS_OBJECT, @_
370}
371
372sub attach_to_players {
373 _attach @CB_PLAYER, KLASS_PLAYER, @_
374}
375
376sub attach_to_maps {
377 _attach @CB_MAP, KLASS_MAP, @_
378}
379
380sub register_attachment {
381 my $name = shift;
382
383 $attachment{$name} = [[KLASS_OBJECT, @_]];
384}
385
386sub register_player_attachment {
387 my $name = shift;
388
389 $attachment{$name} = [[KLASS_PLAYER, @_]];
390}
391
392sub register_map_attachment {
393 my $name = shift;
394
395 $attachment{$name} = [[KLASS_MAP, @_]];
396}
397
398our $override;
399our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
400
401sub override {
402 $override = 1;
403 @invoke_results = ();
404}
405
406sub do_invoke {
407 my $event = shift;
408 my $callbacks = shift;
409
410 @invoke_results = ();
411
412 local $override;
413
414 for (@$callbacks) {
415 eval { &{$_->[1]} };
416
417 if ($@) {
418 warn "$@";
419 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
420 override;
421 }
422
423 return 1 if $override;
424 }
425
426 0 317 }
427}
428 318
429=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 319=item $attachable->valid
430
431=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
432
433=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
434
435=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
436
437Generate a global/object/player/map-specific event with the given arguments.
438
439This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
440removed in future versions), and there is no public API to access override
441results (if you must, access C<@cf::invoke_results> directly).
442
443=back
444
445=cut
446
447#############################################################################
448
449=head2 METHODS VALID FOR ALL CORE OBJECTS
450
451=over 4
452
453=item $object->valid, $player->valid, $map->valid
454 320
455Just 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
456C-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
457valid C counterpart anymore you get an exception at runtime. This method 323valid C counterpart anymore you get an exception at runtime. This method
458can 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
459exception. 325exception.
460 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
461=back 510=back
462 511
463=cut 512=cut
464
465*cf::object::valid =
466*cf::player::valid =
467*cf::map::valid = \&cf::_valid;
468 513
469############################################################################# 514#############################################################################
470# object support 515# object support
471 516
472sub instantiate {
473 my ($obj, $data) = @_;
474
475 $data = from_json $data;
476
477 for (@$data) {
478 my ($name, $args) = @$_;
479
480 $obj->attach ($name, %{$args || {} });
481 }
482}
483
484# basically do the same as instantiate, without calling instantiate
485sub reattach { 517sub reattach {
518 # basically do the same as instantiate, without calling instantiate
486 my ($obj) = @_; 519 my ($obj) = @_;
520
487 my $registry = $obj->registry; 521 my $registry = $obj->registry;
488 522
489 @$registry = (); 523 @$registry = ();
490 524
491 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 525 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
492 526
493 for my $name (keys %{ $obj->{_attachment} || {} }) { 527 for my $name (keys %{ $obj->{_attachment} || {} }) {
494 if (my $attach = $attachment{$name}) { 528 if (my $attach = $attachment{$name}) {
495 for (@$attach) { 529 for (@$attach) {
496 my ($klass, @attach) = @$_; 530 my ($klass, @attach) = @$_;
497 _attach @$registry, $klass, @attach; 531 _attach $registry, $klass, @attach;
498 } 532 }
499 } else { 533 } else {
500 warn "object uses attachment '$name' that is not available, postponing.\n"; 534 warn "object uses attachment '$name' that is not available, postponing.\n";
501 } 535 }
502 } 536 }
503} 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);
504 564
505sub object_freezer_save { 565sub object_freezer_save {
506 my ($filename, $rdata, $objs) = @_; 566 my ($filename, $rdata, $objs) = @_;
507 567
508 if (length $$rdata) { 568 if (length $$rdata) {
558 } 618 }
559 619
560 () 620 ()
561} 621}
562 622
563attach_to_objects
564 prio => -1000000,
565 on_clone => sub {
566 my ($src, $dst) = @_;
567
568 @{$dst->registry} = @{$src->registry};
569
570 %$dst = %$src;
571
572 %{$dst->{_attachment}} = %{$src->{_attachment}}
573 if exists $src->{_attachment};
574 },
575;
576
577############################################################################# 623#############################################################################
578# command handling &c 624# command handling &c
579 625
580=item cf::register_command $name => \&callback($ob,$args); 626=item cf::register_command $name => \&callback($ob,$args);
581 627
609 #warn "registering extcmd '$name' to '$caller'"; 655 #warn "registering extcmd '$name' to '$caller'";
610 656
611 $EXTCMD{$name} = [$cb, $caller]; 657 $EXTCMD{$name} = [$cb, $caller];
612} 658}
613 659
614attach_to_players 660cf::player->attach (
615 on_command => sub { 661 on_command => sub {
616 my ($pl, $name, $params) = @_; 662 my ($pl, $name, $params) = @_;
617 663
618 my $cb = $COMMAND{$name} 664 my $cb = $COMMAND{$name}
619 or return; 665 or return;
639 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 685 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
640 } 686 }
641 687
642 cf::override; 688 cf::override;
643 }, 689 },
644; 690);
645 691
646sub register { 692sub register {
647 my ($base, $pkg) = @_; 693 my ($base, $pkg) = @_;
648 694
649 #TODO 695 #TODO
718 764
719 Symbol::delete_package $pkg; 765 Symbol::delete_package $pkg;
720} 766}
721 767
722sub load_extensions { 768sub load_extensions {
723 my $LIBDIR = maps_directory "perl";
724
725 for my $ext (<$LIBDIR/*.ext>) { 769 for my $ext (<$LIBDIR/*.ext>) {
726 next unless -r $ext; 770 next unless -r $ext;
727 eval { 771 eval {
728 load_extension $ext; 772 load_extension $ext;
729 1 773 1
741 defined $path or return; 785 defined $path or return;
742 786
743 unlink "$path.pst"; 787 unlink "$path.pst";
744}; 788};
745 789
746attach_to_maps prio => -10000, package => cf::mapsupport::; 790cf::map->attach (prio => -10000, package => cf::mapsupport::);
747 791
748############################################################################# 792#############################################################################
749# load/save perl data associated with player->ob objects 793# load/save perl data associated with player->ob objects
750 794
751sub all_objects(@) { 795sub all_objects(@) {
752 @_, map all_objects ($_->inv), @_ 796 @_, map all_objects ($_->inv), @_
753} 797}
754 798
755# TODO: compatibility cruft, remove when no longer needed 799# TODO: compatibility cruft, remove when no longer needed
756attach_to_players 800cf::player->attach (
757 on_load => sub { 801 on_load => sub {
758 my ($pl, $path) = @_; 802 my ($pl, $path) = @_;
759 803
760 for my $o (all_objects $pl->ob) { 804 for my $o (all_objects $pl->ob) {
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 805 if (my $value = $o->get_ob_key_value ("_perl_data")) {
763 807
764 %$o = %{ Storable::thaw pack "H*", $value }; 808 %$o = %{ Storable::thaw pack "H*", $value };
765 } 809 }
766 } 810 }
767 }, 811 },
768; 812);
769 813
770############################################################################# 814#############################################################################
771 815
772=head2 CORE EXTENSIONS 816=head2 CORE EXTENSIONS
773 817
774Functions and methods that extend core crossfire objects. 818Functions and methods that extend core crossfire objects.
819
820=head3 cf::player
775 821
776=over 4 822=over 4
777 823
778=item cf::player::exists $login 824=item cf::player::exists $login
779 825
784sub cf::player::exists($) { 830sub cf::player::exists($) {
785 cf::player::find $_[0] 831 cf::player::find $_[0]
786 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;
787} 833}
788 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
789=item $player_object->reply ($npc, $msg[, $flags]) 855=item $player_object->reply ($npc, $msg[, $flags])
790 856
791Sends 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>
792can 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
793dialogue with the given NPC character. 859dialogue with the given NPC character.
794 860
795=cut 861=cut
796 862
797# rough implementation of a future "reply" method that works 863# rough implementation of a future "reply" method that works
798# with dialog boxes. 864# with dialog boxes.
865#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 866sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 867 my ($self, $npc, $msg, $flags) = @_;
801 868
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 869 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 870
807 $msg = $npc->name . " says: $msg" if $npc; 874 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 875 $self->message ($msg, $flags);
809 } 876 }
810} 877}
811 878
812=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814Sends an ext reply to the player.
815
816=cut
817
818sub cf::player::ext_reply($$$%) {
819 my ($self, $id, %msg) = @_;
820
821 $msg{msgid} = $id;
822
823 $self->send ("ext " . to_json \%msg);
824}
825
826=item $player_object->may ("access") 879=item $player_object->may ("access")
827 880
828Returns wether the given player is authorized to access resource "access" 881Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast"). 882(e.g. "command_wizcast").
830 883
837 (ref $cf::CFG{"may_$access"} 890 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 891 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 892 : $cf::CFG{"may_$access"})
840} 893}
841 894
842=cut 895=head3 cf::client
843 896
844############################################################################# 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
845 1000
846=head2 SAFE SCRIPTING 1001=head2 SAFE SCRIPTING
847 1002
848Functions that provide a safe environment to compile and execute 1003Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 1004snippets of perl code without them endangering the safety of the server
864 1019
865=pod 1020=pod
866 1021
867The following fucntions and emthods are available within a safe environment: 1022The following fucntions and emthods are available within a safe environment:
868 1023
869 cf::object contr pay_amount pay_player 1024 cf::object contr pay_amount pay_player map
870 cf::object::player player 1025 cf::object::player player
871 cf::player peaceful 1026 cf::player peaceful
1027 cf::map trigger
872 1028
873=cut 1029=cut
874 1030
875for ( 1031for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 1032 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 1033 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 1034 ["cf::player" => qw(peaceful)],
1035 ["cf::map" => qw(trigger)],
879) { 1036) {
880 no strict 'refs'; 1037 no strict 'refs';
881 my ($pkg, @funs) = @$_; 1038 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1039 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 1040 for @funs;
1023 sub db_sync() { 1180 sub db_sync() {
1024 db_save if $dirty; 1181 db_save if $dirty;
1025 undef $dirty; 1182 undef $dirty;
1026 } 1183 }
1027 1184
1028 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 {
1029 db_sync; 1186 db_sync;
1030 }); 1187 });
1031 1188
1032 sub db_dirty() { 1189 sub db_dirty() {
1033 $dirty = 1; 1190 $dirty = 1;
1047 $DB->{$_[0]} = $_[1]; 1204 $DB->{$_[0]} = $_[1];
1048 } 1205 }
1049 db_dirty; 1206 db_dirty;
1050 } 1207 }
1051 1208
1052 attach_global 1209 cf::global->attach (
1053 prio => 10000, 1210 prio => 10000,
1054 on_cleanup => sub { 1211 on_cleanup => sub {
1055 db_sync; 1212 db_sync;
1056 }, 1213 },
1057 ; 1214 );
1058} 1215}
1059 1216
1060############################################################################# 1217#############################################################################
1061# the server's main() 1218# the server's main()
1062 1219
1076} 1233}
1077 1234
1078############################################################################# 1235#############################################################################
1079# initialisation 1236# initialisation
1080 1237
1081sub _perl_reload(&) { 1238sub _perl_reload() {
1082 my ($msg) = @_; 1239 warn "reloading...";
1083
1084 $msg->("reloading...");
1085 1240
1086 eval { 1241 eval {
1242 local $FREEZE = 1;
1243
1244 cf::emergency_save;
1245
1087 # cancel all watchers 1246 # cancel all watchers
1088 $_->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 = ();
1089 1254
1090 # unload all extensions 1255 # unload all extensions
1091 for (@exts) { 1256 for (@exts) {
1092 $msg->("unloading <$_>"); 1257 warn "unloading <$_>";
1093 unload_extension $_; 1258 unload_extension $_;
1094 } 1259 }
1095 1260
1096 # unload all modules loaded from $LIBDIR 1261 # unload all modules loaded from $LIBDIR
1097 while (my ($k, $v) = each %INC) { 1262 while (my ($k, $v) = each %INC) {
1098 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1263 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1099 1264
1100 $msg->("removing <$k>"); 1265 warn "removing <$k>";
1101 delete $INC{$k}; 1266 delete $INC{$k};
1102 1267
1103 $k =~ s/\.pm$//; 1268 $k =~ s/\.pm$//;
1104 $k =~ s/\//::/g; 1269 $k =~ s/\//::/g;
1105 1270
1110 Symbol::delete_package $k; 1275 Symbol::delete_package $k;
1111 } 1276 }
1112 1277
1113 # sync database to disk 1278 # sync database to disk
1114 cf::db_sync; 1279 cf::db_sync;
1280 IO::AIO::flush;
1115 1281
1116 # get rid of safe::, as good as possible 1282 # get rid of safe::, as good as possible
1117 Symbol::delete_package "safe::$_" 1283 Symbol::delete_package "safe::$_"
1118 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);
1119 1285
1120 # remove register_script_function callbacks 1286 # remove register_script_function callbacks
1121 # TODO 1287 # TODO
1122 1288
1123 # unload cf.pm "a bit" 1289 # unload cf.pm "a bit"
1126 # don't, removes xs symbols, too, 1292 # don't, removes xs symbols, too,
1127 # and global variables created in xs 1293 # and global variables created in xs
1128 #Symbol::delete_package __PACKAGE__; 1294 #Symbol::delete_package __PACKAGE__;
1129 1295
1130 # reload cf.pm 1296 # reload cf.pm
1131 $msg->("reloading cf.pm"); 1297 warn "reloading cf.pm";
1132 require cf; 1298 require cf;
1299 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1133 1300
1134 # load config and database again 1301 # load config and database again
1135 cf::cfg_load; 1302 cf::cfg_load;
1136 cf::db_load; 1303 cf::db_load;
1137 1304
1138 # load extensions 1305 # load extensions
1139 $msg->("load extensions"); 1306 warn "load extensions";
1140 cf::load_extensions; 1307 cf::load_extensions;
1141 1308
1142 # reattach attachments to objects 1309 # reattach attachments to objects
1143 $msg->("reattach"); 1310 warn "reattach";
1144 _global_reattach; 1311 _global_reattach;
1145 }; 1312 };
1146 $msg->($@) if $@; 1313 warn $@ if $@;
1147 1314
1148 $msg->("reloaded"); 1315 warn "reloaded";
1149}; 1316};
1150 1317
1151sub perl_reload() { 1318sub perl_reload() {
1152 _perl_reload { 1319 _perl_reload;
1153 warn $_[0];
1154 print "$_[0]\n";
1155 };
1156} 1320}
1157 1321
1158register "<global>", __PACKAGE__; 1322register "<global>", __PACKAGE__;
1159 1323
1160register_command "perl-reload" => sub { 1324register_command "perl-reload" => sub {
1161 my ($who, $arg) = @_; 1325 my ($who, $arg) = @_;
1162 1326
1163 if ($who->flag (FLAG_WIZ)) { 1327 if ($who->flag (FLAG_WIZ)) {
1328 $who->message ("reloading...");
1164 _perl_reload { 1329 _perl_reload;
1165 warn $_[0];
1166 $who->message ($_[0]);
1167 };
1168 } 1330 }
1169}; 1331};
1170 1332
1171unshift @INC, $LIBDIR; 1333unshift @INC, $LIBDIR;
1172 1334
1173$TICK_WATCHER = Event->timer ( 1335$TICK_WATCHER = Event->timer (
1174 prio => 1, 1336 prio => 0,
1175 async => 1,
1176 at => $NEXT_TICK || 1, 1337 at => $NEXT_TICK || $TICK,
1338 data => WF_AUTOCANCEL,
1177 cb => sub { 1339 cb => sub {
1340 unless ($FREEZE) {
1178 cf::server_tick; # one server iteration 1341 cf::server_tick; # one server iteration
1342 $RUNTIME += $TICK;
1343 }
1179 1344
1180 my $NOW = Event::time;
1181 $NEXT_TICK += $TICK; 1345 $NEXT_TICK += $TICK;
1182 1346
1183 # 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
1184 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1348 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1185 1349
1186 $TICK_WATCHER->at ($NEXT_TICK); 1350 $TICK_WATCHER->at ($NEXT_TICK);
1187 $TICK_WATCHER->start; 1351 $TICK_WATCHER->start;
1188 }, 1352 },
1189); 1353);
1191IO::AIO::max_poll_time $TICK * 0.2; 1355IO::AIO::max_poll_time $TICK * 0.2;
1192 1356
1193Event->io (fd => IO::AIO::poll_fileno, 1357Event->io (fd => IO::AIO::poll_fileno,
1194 poll => 'r', 1358 poll => 'r',
1195 prio => 5, 1359 prio => 5,
1360 data => WF_AUTOCANCEL,
1196 cb => \&IO::AIO::poll_cb); 1361 cb => \&IO::AIO::poll_cb);
1197 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
11981 13721
1199 1373

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines