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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43: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;
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18
19use IO::AIO 2.3;
10use YAML::Syck (); 20use YAML::Syck ();
11use Time::HiRes; 21use Time::HiRes;
12use Event; 22
13$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
14 24
15# 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?
16$YAML::Syck::ImplicitUnicode = 1; 26$YAML::Syck::ImplicitUnicode = 1;
17 27
18use strict; 28$Coro::main->prio (Coro::PRIO_MIN);
19 29
20_init_vars; 30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
21 31
22our %COMMAND = (); 32our %COMMAND = ();
33our %COMMAND_TIME = ();
34our %EXTCMD = ();
35
23our @EVENT; 36our @EVENT;
24our $LIBDIR = maps_directory "perl"; 37our $LIBDIR = datadir . "/ext";
25 38
26our $TICK = MAX_TIME * 1e-6; 39our $TICK = MAX_TIME * 1e-6;
27our $TICK_WATCHER; 40our $TICK_WATCHER;
28our $NEXT_TICK; 41our $NEXT_TICK;
29 42
30our %CFG; 43our %CFG;
31 44
32our $uptime; 45our $UPTIME; $UPTIME ||= time;
33
34$uptime ||= time;
35 46
36############################################################################# 47#############################################################################
37 48
38=head2 GLOBAL VARIABLES 49=head2 GLOBAL VARIABLES
39 50
40=over 4 51=over 4
52
53=item $cf::UPTIME
54
55The timestamp of the server start (so not actually an uptime).
41 56
42=item $cf::LIBDIR 57=item $cf::LIBDIR
43 58
44The perl library directory, where extensions and cf-specific modules can 59The perl library directory, where extensions and cf-specific modules can
45be found. It will be added to C<@INC> automatically. 60be found. It will be added to C<@INC> automatically.
66 print STDERR "cfperl: $msg"; 81 print STDERR "cfperl: $msg";
67 LOG llevError, "cfperl: $msg"; 82 LOG llevError, "cfperl: $msg";
68 }; 83 };
69} 84}
70 85
86@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
87@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
88@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
89@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
90@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
71@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 91@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72 92
73# we bless all objects into (empty) derived classes to force a method lookup 93# we bless all objects into (empty) derived classes to force a method lookup
74# within the Safe compartment. 94# within the Safe compartment.
75for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 95for my $pkg (qw(
96 cf::global cf::attachable
97 cf::object cf::object::player
98 cf::client cf::player
99 cf::arch cf::living
100 cf::map cf::party cf::region
101)) {
76 no strict 'refs'; 102 no strict 'refs';
77 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 103 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78} 104}
79 105
80$Event::DIED = sub { 106$Event::DIED = sub {
82}; 108};
83 109
84my %ext_pkg; 110my %ext_pkg;
85my @exts; 111my @exts;
86my @hook; 112my @hook;
87my %command;
88my %extcmd;
89 113
90=head2 UTILITY FUNCTIONS 114=head2 UTILITY FUNCTIONS
91 115
92=over 4 116=over 4
93 117
121 145
122=cut 146=cut
123 147
124############################################################################# 148#############################################################################
125 149
126=head2 EVENTS AND OBJECT ATTACHMENTS 150=head2 ATTACHABLE OBJECTS
151
152Many objects in crossfire are so-called attachable objects. That means you can
153attach callbacks/event handlers (a collection of which is called an "attachment")
154to it. All such attachable objects support the following methods.
155
156In the following description, CLASS can be any of C<global>, C<object>
157C<player>, C<client> or C<map> (i.e. the attachable objects in
158crossfire+).
127 159
128=over 4 160=over 4
129 161
130=item $object->attach ($attachment, key => $value...)
131
132=item $object->detach ($attachment)
133
134Attach/detach a pre-registered attachment to an object.
135
136=item $player->attach ($attachment, key => $value...)
137
138=item $player->detach ($attachment)
139
140Attach/detach a pre-registered attachment to a player.
141
142=item $map->attach ($attachment, key => $value...) 162=item $attachable->attach ($attachment, key => $value...)
143 163
144=item $map->detach ($attachment) 164=item $attachable->detach ($attachment)
145 165
146Attach/detach a pre-registered attachment to a map. 166Attach/detach a pre-registered attachment to a specific object and give it
167the specified key/value pairs as arguments.
147 168
148=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
149 171
150=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
151 173
152=item $bool = $map->attached ($name) 174=item $bool = $attachable->attached ($name)
153 175
154Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
155 177
156=item cf::attach_global ... 178=item cf::CLASS->attach ...
157 179
158Attach handlers for global events. 180=item cf::CLASS->detach ...
159 181
160This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
161following handler/hook descriptions: 183CLASS. See the next function for an explanation of its arguments.
184
185You can attach to global events by using the C<cf::global> class.
186
187Example, log all player logins:
188
189 cf::player->attach (
190 on_login => sub {
191 my ($pl) = @_;
192 ...
193 },
194 );
195
196Example, attach to the jeweler skill:
197
198 cf::object->attach (
199 type => cf::SKILL,
200 subtype => cf::SK_JEWELER,
201 on_use_skill => sub {
202 my ($sk, $ob, $part, $dir, $msg) = @_;
203 ...
204 },
205 );
206
207=item cf::CLASS::attachment $name, ...
208
209Register an attachment by C<$name> through which attachable objects of the
210given CLASS can refer to this attachment.
211
212Some classes such as crossfire maps and objects can specify attachments
213that are attached at load/instantiate time, thus the need for a name.
214
215These calls expect any number of the following handler/hook descriptions:
162 216
163=over 4 217=over 4
164 218
165=item prio => $number 219=item prio => $number
166 220
168by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
169earlier. The default priority is C<0>, and many built-in handlers are 223earlier. The default priority is C<0>, and many built-in handlers are
170registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
171unless you know what you are doing. 225unless you know what you are doing.
172 226
227=item type => $type
228
229(Only for C<< cf::object->attach >> calls), limits the attachment to the
230given type of objects only (the additional parameter C<subtype> can be
231used to further limit to the given subtype).
232
173=item on_I<event> => \&cb 233=item on_I<event> => \&cb
174 234
175Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
176something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 236something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
177handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
186package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
187object/class are recognised. 247object/class are recognised.
188 248
189=back 249=back
190 250
191=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
192 253
193Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
194subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
195type. 256 my ($self, $victim) = @_;
196 257 ...
197=item cf::attach_to_objects ...
198
199Attach handlers to all objects. Do not use this except for debugging or
200very rare events, as handlers are (obviously) called for I<all> objects in
201the game.
202
203=item cf::attach_to_players ...
204
205Attach handlers to all players.
206
207=item cf::attach_to_maps ...
208
209Attach handlers to all maps.
210
211=item cf:register_attachment $name, ...
212
213Register an attachment by name through which objects can refer to this
214attachment.
215
216=item cf:register_player_attachment $name, ...
217
218Register an attachment by name through which players can refer to this
219attachment.
220
221=item cf:register_map_attachment $name, ...
222
223Register an attachment by name through which maps can refer to this
224attachment.
225
226=cut
227
228# the following variables are defined in .xs and must not be re-created
229our @CB_GLOBAL = (); # registry for all global events
230our @CB_OBJECT = (); # all objects (should not be used except in emergency)
231our @CB_PLAYER = ();
232our @CB_TYPE = (); # registry for type (cf-object class) based events
233our @CB_MAP = ();
234
235my %attachment;
236
237sub _attach_cb($\%$$$) {
238 my ($registry, $undo, $event, $prio, $cb) = @_;
239
240 use sort 'stable';
241
242 $cb = [$prio, $cb];
243
244 @{$registry->[$event]} = sort
245 { $a->[0] cmp $b->[0] }
246 @{$registry->[$event] || []}, $cb;
247
248 push @{$undo->{cb}}, [$event, $cb];
249}
250
251# attach handles attaching event callbacks
252# the only thing the caller has to do is pass the correct
253# registry (== where the callback attaches to).
254sub _attach(\@$@) {
255 my ($registry, $klass, @arg) = @_;
256
257 my $prio = 0;
258
259 my %undo = (
260 registry => $registry,
261 cb => [],
262 );
263
264 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
265
266 while (@arg) {
267 my $type = shift @arg;
268
269 if ($type eq "prio") {
270 $prio = shift @arg;
271
272 } elsif ($type eq "package") {
273 my $pkg = shift @arg;
274
275 while (my ($name, $id) = each %cb_id) {
276 if (my $cb = $pkg->can ($name)) {
277 _attach_cb $registry, %undo, $id, $prio, $cb;
278 }
279 } 258 }
280
281 } elsif (exists $cb_id{$type}) {
282 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
283
284 } elsif (ref $type) {
285 warn "attaching objects not supported, ignoring.\n";
286
287 } else {
288 shift @arg;
289 warn "attach argument '$type' not supported, ignoring.\n";
290 }
291 }
292
293 \%undo
294}
295
296sub _attach_attachment {
297 my ($obj, $name, %arg) = @_;
298
299 return if exists $obj->{_attachment}{$name};
300
301 my $res;
302
303 if (my $attach = $attachment{$name}) {
304 my $registry = $obj->registry;
305
306 for (@$attach) {
307 my ($klass, @attach) = @$_;
308 $res = _attach @$registry, $klass, @attach;
309 }
310
311 $obj->{$name} = \%arg;
312 } else {
313 warn "object uses attachment '$name' that is not available, postponing.\n";
314 }
315
316 $obj->{_attachment}{$name} = undef;
317
318 $res->{attachment} = $name;
319 $res
320}
321
322*cf::object::attach =
323*cf::player::attach =
324*cf::map::attach = sub {
325 my ($obj, $name, %arg) = @_;
326
327 _attach_attachment $obj, $name, %arg;
328};
329
330# all those should be optimised
331*cf::object::detach =
332*cf::player::detach =
333*cf::map::detach = sub {
334 my ($obj, $name) = @_;
335
336 delete $obj->{_attachment}{$name};
337 reattach ($obj);
338};
339
340*cf::object::attached =
341*cf::player::attached =
342*cf::map::attached = sub {
343 my ($obj, $name) = @_;
344
345 exists $obj->{_attachment}{$name}
346};
347
348sub attach_global {
349 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
350}
351
352sub attach_to_type {
353 my $type = shift;
354 my $subtype = shift;
355
356 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
357}
358
359sub attach_to_objects {
360 _attach @CB_OBJECT, KLASS_OBJECT, @_
361}
362
363sub attach_to_players {
364 _attach @CB_PLAYER, KLASS_PLAYER, @_
365}
366
367sub attach_to_maps {
368 _attach @CB_MAP, KLASS_MAP, @_
369}
370
371sub register_attachment {
372 my $name = shift;
373
374 $attachment{$name} = [[KLASS_OBJECT, @_]];
375}
376
377sub register_player_attachment {
378 my $name = shift;
379
380 $attachment{$name} = [[KLASS_PLAYER, @_]];
381}
382
383sub register_map_attachment {
384 my $name = shift;
385
386 $attachment{$name} = [[KLASS_MAP, @_]];
387}
388
389our $override;
390our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
391
392sub override {
393 $override = 1;
394 @invoke_results = ();
395}
396
397sub do_invoke {
398 my $event = shift;
399 my $callbacks = shift;
400
401 @invoke_results = ();
402
403 local $override;
404
405 for (@$callbacks) {
406 eval { &{$_->[1]} };
407
408 if ($@) {
409 warn "$@";
410 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
411 override;
412 }
413
414 return 1 if $override;
415 }
416
417 0 259 }
418}
419 260
420=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=item $attachable->valid
421
422=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
423
424=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
425
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments.
429
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
431removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly).
433
434=back
435
436=cut
437
438#############################################################################
439
440=head2 METHODS VALID FOR ALL CORE OBJECTS
441
442=over 4
443
444=item $object->valid, $player->valid, $map->valid
445 262
446Just because you have a perl object does not mean that the corresponding 263Just because you have a perl object does not mean that the corresponding
447C-level object still exists. If you try to access an object that has no 264C-level object still exists. If you try to access an object that has no
448valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
449can be used to test for existence of the C object part without causing an 266can be used to test for existence of the C object part without causing an
450exception. 267exception.
451 268
269=cut
270
271# the following variables are defined in .xs and must not be re-created
272our @CB_GLOBAL = (); # registry for all global events
273our @CB_ATTACHABLE = (); # registry for all attachables
274our @CB_OBJECT = (); # all objects (should not be used except in emergency)
275our @CB_PLAYER = ();
276our @CB_CLIENT = ();
277our @CB_TYPE = (); # registry for type (cf-object class) based events
278our @CB_MAP = ();
279
280my %attachment;
281
282sub _attach_cb($$$$) {
283 my ($registry, $event, $prio, $cb) = @_;
284
285 use sort 'stable';
286
287 $cb = [$prio, $cb];
288
289 @{$registry->[$event]} = sort
290 { $a->[0] cmp $b->[0] }
291 @{$registry->[$event] || []}, $cb;
292}
293
294# hack
295my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
296
297# attach handles attaching event callbacks
298# the only thing the caller has to do is pass the correct
299# registry (== where the callback attaches to).
300sub _attach {
301 my ($registry, $klass, @arg) = @_;
302
303 my $object_type;
304 my $prio = 0;
305 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
306
307 #TODO: get rid of this hack
308 if ($attachable_klass{$klass}) {
309 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
310 }
311
312 while (@arg) {
313 my $type = shift @arg;
314
315 if ($type eq "prio") {
316 $prio = shift @arg;
317
318 } elsif ($type eq "type") {
319 $object_type = shift @arg;
320 $registry = $CB_TYPE[$object_type] ||= [];
321
322 } elsif ($type eq "subtype") {
323 defined $object_type or Carp::croak "subtype specified without type";
324 my $object_subtype = shift @arg;
325 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
326
327 } elsif ($type eq "package") {
328 my $pkg = shift @arg;
329
330 while (my ($name, $id) = each %cb_id) {
331 if (my $cb = $pkg->can ($name)) {
332 _attach_cb $registry, $id, $prio, $cb;
333 }
334 }
335
336 } elsif (exists $cb_id{$type}) {
337 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
338
339 } elsif (ref $type) {
340 warn "attaching objects not supported, ignoring.\n";
341
342 } else {
343 shift @arg;
344 warn "attach argument '$type' not supported, ignoring.\n";
345 }
346 }
347}
348
349sub _object_attach {
350 my ($obj, $name, %arg) = @_;
351
352 return if exists $obj->{_attachment}{$name};
353
354 if (my $attach = $attachment{$name}) {
355 my $registry = $obj->registry;
356
357 for (@$attach) {
358 my ($klass, @attach) = @$_;
359 _attach $registry, $klass, @attach;
360 }
361
362 $obj->{$name} = \%arg;
363 } else {
364 warn "object uses attachment '$name' that is not available, postponing.\n";
365 }
366
367 $obj->{_attachment}{$name} = undef;
368}
369
370sub cf::attachable::attach {
371 if (ref $_[0]) {
372 _object_attach @_;
373 } else {
374 _attach shift->_attach_registry, @_;
375 }
376};
377
378# all those should be optimised
379sub cf::attachable::detach {
380 my ($obj, $name) = @_;
381
382 if (ref $obj) {
383 delete $obj->{_attachment}{$name};
384 reattach ($obj);
385 } else {
386 Carp::croak "cannot, currently, detach class attachments";
387 }
388};
389
390sub cf::attachable::attached {
391 my ($obj, $name) = @_;
392
393 exists $obj->{_attachment}{$name}
394}
395
396for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
397 eval "#line " . __LINE__ . " 'cf.pm'
398 sub cf::\L$klass\E::_attach_registry {
399 (\\\@CB_$klass, KLASS_$klass)
400 }
401
402 sub cf::\L$klass\E::attachment {
403 my \$name = shift;
404
405 \$attachment{\$name} = [[KLASS_$klass, \@_]];
406 }
407 ";
408 die if $@;
409}
410
411our $override;
412our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
413
414sub override {
415 $override = 1;
416 @invoke_results = ();
417}
418
419sub do_invoke {
420 my $event = shift;
421 my $callbacks = shift;
422
423 @invoke_results = ();
424
425 local $override;
426
427 for (@$callbacks) {
428 eval { &{$_->[1]} };
429
430 if ($@) {
431 warn "$@";
432 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
433 override;
434 }
435
436 return 1 if $override;
437 }
438
439 0
440}
441
442=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
443
444=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
445
446Generate an object-specific event with the given arguments.
447
448This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
449removed in future versions), and there is no public API to access override
450results (if you must, access C<@cf::invoke_results> directly).
451
452=back 452=back
453 453
454=cut 454=cut
455
456*cf::object::valid =
457*cf::player::valid =
458*cf::map::valid = \&cf::_valid;
459 455
460############################################################################# 456#############################################################################
461# object support 457# object support
462 458
463sub instantiate { 459cf::attachable->attach (
460 prio => -1000000,
461 on_instantiate => sub {
464 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
465 463
466 $data = from_json $data; 464 $data = from_json $data;
467 465
468 for (@$data) { 466 for (@$data) {
469 my ($name, $args) = @$_; 467 my ($name, $args) = @$_;
470 468
471 $obj->attach ($name, %{$args || {} }); 469 $obj->attach ($name, %{$args || {} });
470 }
472 } 471 },
473} 472 on_reattach => sub {
474
475# basically do the same as instantiate, without calling instantiate 473 # basically do the same as instantiate, without calling instantiate
476sub reattach {
477 my ($obj) = @_; 474 my ($obj) = @_;
478 my $registry = $obj->registry; 475 my $registry = $obj->registry;
479 476
480 @$registry = (); 477 @$registry = ();
481 478
482 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 479 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
483 480
484 for my $name (keys %{ $obj->{_attachment} || {} }) { 481 for my $name (keys %{ $obj->{_attachment} || {} }) {
485 if (my $attach = $attachment{$name}) { 482 if (my $attach = $attachment{$name}) {
486 for (@$attach) { 483 for (@$attach) {
487 my ($klass, @attach) = @$_; 484 my ($klass, @attach) = @$_;
488 _attach @$registry, $klass, @attach; 485 _attach $registry, $klass, @attach;
486 }
487 } else {
488 warn "object uses attachment '$name' that is not available, postponing.\n";
489 } 489 }
490 } else {
491 warn "object uses attachment '$name' that is not available, postponing.\n";
492 } 490 }
493 } 491 },
494} 492 on_clone => sub {
493 my ($src, $dst) = @_;
494
495 @{$dst->registry} = @{$src->registry};
496
497 %$dst = %$src;
498
499 %{$dst->{_attachment}} = %{$src->{_attachment}}
500 if exists $src->{_attachment};
501 },
502);
495 503
496sub object_freezer_save { 504sub object_freezer_save {
497 my ($filename, $rdata, $objs) = @_; 505 my ($filename, $rdata, $objs) = @_;
498 506
499 if (length $$rdata) { 507 if (length $$rdata) {
522 unlink $filename; 530 unlink $filename;
523 unlink "$filename.pst"; 531 unlink "$filename.pst";
524 } 532 }
525} 533}
526 534
535sub object_freezer_as_string {
536 my ($rdata, $objs) = @_;
537
538 use Data::Dumper;
539
540 $$rdata . Dumper $objs
541}
542
527sub object_thawer_load { 543sub object_thawer_load {
528 my ($filename) = @_; 544 my ($filename) = @_;
529 545
530 local $/; 546 local $/;
531 547
541 } 557 }
542 558
543 () 559 ()
544} 560}
545 561
546attach_to_objects
547 prio => -1000000,
548 on_clone => sub {
549 my ($src, $dst) = @_;
550
551 @{$dst->registry} = @{$src->registry};
552
553 %$dst = %$src;
554
555 %{$dst->{_attachment}} = %{$src->{_attachment}}
556 if exists $src->{_attachment};
557 },
558;
559
560############################################################################# 562#############################################################################
561# old plug-in events 563# command handling &c
562 564
563sub inject_event { 565=item cf::register_command $name => \&callback($ob,$args);
564 my $extension = shift;
565 my $event_code = shift;
566 566
567 my $cb = $hook[$event_code]{$extension} 567Register a callback for execution when the client sends the user command
568 or return; 568$name.
569 569
570 &$cb 570=cut
571}
572
573sub inject_global_event {
574 my $event = shift;
575
576 my $cb = $hook[$event]
577 or return;
578
579 List::Util::max map &$_, values %$cb
580}
581
582sub inject_command {
583 my ($name, $obj, $params) = @_;
584
585 for my $cmd (@{ $command{$name} }) {
586 $cmd->[1]->($obj, $params);
587 }
588
589 -1
590}
591 571
592sub register_command { 572sub register_command {
593 my ($name, $time, $cb) = @_; 573 my ($name, $cb) = @_;
594 574
595 my $caller = caller; 575 my $caller = caller;
596 #warn "registering command '$name/$time' to '$caller'"; 576 #warn "registering command '$name/$time' to '$caller'";
597 577
598 push @{ $command{$name} }, [$time, $cb, $caller]; 578 push @{ $COMMAND{$name} }, [$caller, $cb];
599 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
600} 579}
580
581=item cf::register_extcmd $name => \&callback($pl,$packet);
582
583Register a callbackf ro execution when the client sends an extcmd packet.
584
585If the callback returns something, it is sent back as if reply was being
586called.
587
588=cut
601 589
602sub register_extcmd { 590sub register_extcmd {
603 my ($name, $cb) = @_; 591 my ($name, $cb) = @_;
604 592
605 my $caller = caller; 593 my $caller = caller;
606 #warn "registering extcmd '$name' to '$caller'"; 594 #warn "registering extcmd '$name' to '$caller'";
607 595
608 $extcmd{$name} = [$cb, $caller]; 596 $EXTCMD{$name} = [$cb, $caller];
609} 597}
598
599cf::player->attach (
600 on_command => sub {
601 my ($pl, $name, $params) = @_;
602
603 my $cb = $COMMAND{$name}
604 or return;
605
606 for my $cmd (@$cb) {
607 $cmd->[1]->($pl->ob, $params);
608 }
609
610 cf::override;
611 },
612 on_extcmd => sub {
613 my ($pl, $buf) = @_;
614
615 my $msg = eval { from_json $buf };
616
617 if (ref $msg) {
618 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
619 if (my %reply = $cb->[0]->($pl, $msg)) {
620 $pl->ext_reply ($msg->{msgid}, %reply);
621 }
622 }
623 } else {
624 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
625 }
626
627 cf::override;
628 },
629);
610 630
611sub register { 631sub register {
612 my ($base, $pkg) = @_; 632 my ($base, $pkg) = @_;
613 633
614 #TODO 634 #TODO
633 . "#line 1 \"$path\"\n{\n" 653 . "#line 1 \"$path\"\n{\n"
634 . (do { local $/; <$fh> }) 654 . (do { local $/; <$fh> })
635 . "\n};\n1"; 655 . "\n};\n1";
636 656
637 eval $source 657 eval $source
638 or die "$path: $@"; 658 or die $@ ? "$path: $@\n"
659 : "extension disabled.\n";
639 660
640 push @exts, $pkg; 661 push @exts, $pkg;
641 $ext_pkg{$base} = $pkg; 662 $ext_pkg{$base} = $pkg;
642 663
643# no strict 'refs'; 664# no strict 'refs';
656# for my $idx (0 .. $#PLUGIN_EVENT) { 677# for my $idx (0 .. $#PLUGIN_EVENT) {
657# delete $hook[$idx]{$pkg}; 678# delete $hook[$idx]{$pkg};
658# } 679# }
659 680
660 # remove commands 681 # remove commands
661 for my $name (keys %command) { 682 for my $name (keys %COMMAND) {
662 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 683 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
663 684
664 if (@cb) { 685 if (@cb) {
665 $command{$name} = \@cb; 686 $COMMAND{$name} = \@cb;
666 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
667 } else { 687 } else {
668 delete $command{$name};
669 delete $COMMAND{"$name\000"}; 688 delete $COMMAND{$name};
670 } 689 }
671 } 690 }
672 691
673 # remove extcmds 692 # remove extcmds
674 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 693 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
675 delete $extcmd{$name}; 694 delete $EXTCMD{$name};
676 } 695 }
677 696
678 if (my $cb = $pkg->can ("unload")) { 697 if (my $cb = $pkg->can ("unload")) {
679 eval { 698 eval {
680 $cb->($pkg); 699 $cb->($pkg);
684 703
685 Symbol::delete_package $pkg; 704 Symbol::delete_package $pkg;
686} 705}
687 706
688sub load_extensions { 707sub load_extensions {
689 my $LIBDIR = maps_directory "perl";
690
691 for my $ext (<$LIBDIR/*.ext>) { 708 for my $ext (<$LIBDIR/*.ext>) {
692 next unless -r $ext; 709 next unless -r $ext;
693 eval { 710 eval {
694 load_extension $ext; 711 load_extension $ext;
695 1 712 1
696 } or warn "$ext not loaded: $@"; 713 } or warn "$ext not loaded: $@";
697 } 714 }
698} 715}
699 716
700############################################################################# 717#############################################################################
701# extcmd framework, basically convert ext <msg>
702# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
703
704attach_to_players
705 on_extcmd => sub {
706 my ($pl, $buf) = @_;
707
708 my $msg = eval { from_json $buf };
709
710 if (ref $msg) {
711 if (my $cb = $extcmd{$msg->{msgtype}}) {
712 if (my %reply = $cb->[0]->($pl, $msg)) {
713 $pl->ext_reply ($msg->{msgid}, %reply);
714 }
715 }
716 } else {
717 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
718 }
719
720 cf::override;
721 },
722;
723
724#############################################################################
725# load/save/clean perl data associated with a map 718# load/save/clean perl data associated with a map
726 719
727*cf::mapsupport::on_clean = sub { 720*cf::mapsupport::on_clean = sub {
728 my ($map) = @_; 721 my ($map) = @_;
729 722
731 defined $path or return; 724 defined $path or return;
732 725
733 unlink "$path.pst"; 726 unlink "$path.pst";
734}; 727};
735 728
736attach_to_maps prio => -10000, package => cf::mapsupport::; 729cf::map->attach (prio => -10000, package => cf::mapsupport::);
737 730
738############################################################################# 731#############################################################################
739# load/save perl data associated with player->ob objects 732# load/save perl data associated with player->ob objects
740 733
741sub all_objects(@) { 734sub all_objects(@) {
742 @_, map all_objects ($_->inv), @_ 735 @_, map all_objects ($_->inv), @_
743} 736}
744 737
745# TODO: compatibility cruft, remove when no longer needed 738# TODO: compatibility cruft, remove when no longer needed
746attach_to_players 739cf::player->attach (
747 on_load => sub { 740 on_load => sub {
748 my ($pl, $path) = @_; 741 my ($pl, $path) = @_;
749 742
750 for my $o (all_objects $pl->ob) { 743 for my $o (all_objects $pl->ob) {
751 if (my $value = $o->get_ob_key_value ("_perl_data")) { 744 if (my $value = $o->get_ob_key_value ("_perl_data")) {
753 746
754 %$o = %{ Storable::thaw pack "H*", $value }; 747 %$o = %{ Storable::thaw pack "H*", $value };
755 } 748 }
756 } 749 }
757 }, 750 },
758; 751);
759 752
760############################################################################# 753#############################################################################
761 754
762=head2 CORE EXTENSIONS 755=head2 CORE EXTENSIONS
763 756
764Functions and methods that extend core crossfire objects. 757Functions and methods that extend core crossfire objects.
758
759=head3 cf::player
765 760
766=over 4 761=over 4
767 762
768=item cf::player::exists $login 763=item cf::player::exists $login
769 764
774sub cf::player::exists($) { 769sub cf::player::exists($) {
775 cf::player::find $_[0] 770 cf::player::find $_[0]
776 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 771 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
777} 772}
778 773
774=item $player->ext_reply ($msgid, $msgtype, %msg)
775
776Sends an ext reply to the player.
777
778=cut
779
780sub cf::player::ext_reply($$$%) {
781 my ($self, $id, %msg) = @_;
782
783 $msg{msgid} = $id;
784
785 $self->send ("ext " . to_json \%msg);
786}
787
788=back
789
790=head3 cf::object::player
791
792=over 4
793
779=item $object->reply ($npc, $msg[, $flags]) 794=item $player_object->reply ($npc, $msg[, $flags])
780 795
781Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 796Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
782can be C<undef>. Does the right thing when the player is currently in a 797can be C<undef>. Does the right thing when the player is currently in a
783dialogue with the given NPC character. 798dialogue with the given NPC character.
784 799
785=cut 800=cut
786 801
787# rough implementation of a future "reply" method that works 802# rough implementation of a future "reply" method that works
788# with dialog boxes. 803# with dialog boxes.
804#TODO: the first argument must go, split into a $npc->reply_to ( method
789sub cf::object::player::reply($$$;$) { 805sub cf::object::player::reply($$$;$) {
790 my ($self, $npc, $msg, $flags) = @_; 806 my ($self, $npc, $msg, $flags) = @_;
791 807
792 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
793 809
797 $msg = $npc->name . " says: $msg" if $npc; 813 $msg = $npc->name . " says: $msg" if $npc;
798 $self->message ($msg, $flags); 814 $self->message ($msg, $flags);
799 } 815 }
800} 816}
801 817
802=item $player->ext_reply ($msgid, $msgtype, %msg) 818=item $player_object->may ("access")
803 819
804Sends an ext reply to the player. 820Returns wether the given player is authorized to access resource "access"
821(e.g. "command_wizcast").
805 822
806=cut 823=cut
807 824
808sub cf::player::ext_reply($$$%) { 825sub cf::object::player::may {
826 my ($self, $access) = @_;
827
828 $self->flag (cf::FLAG_WIZ) ||
829 (ref $cf::CFG{"may_$access"}
830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
831 : $cf::CFG{"may_$access"})
832}
833
834=head3 cf::client
835
836=over 4
837
838=item $client->send_drawinfo ($text, $flags)
839
840Sends a drawinfo packet to the client. Circumvents output buffering so
841should not be used under normal circumstances.
842
843=cut
844
845sub cf::client::send_drawinfo {
846 my ($self, $text, $flags) = @_;
847
848 utf8::encode $text;
849 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
850}
851
852
853=item $success = $client->query ($flags, "text", \&cb)
854
855Queues a query to the client, calling the given callback with
856the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
857C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
858
859Queries can fail, so check the return code. Or don't, as queries will become
860reliable at some point in the future.
861
862=cut
863
864sub cf::client::query {
865 my ($self, $flags, $text, $cb) = @_;
866
867 return unless $self->state == ST_PLAYING
868 || $self->state == ST_SETUP
869 || $self->state == ST_CUSTOM;
870
871 $self->state (ST_CUSTOM);
872
873 utf8::encode $text;
874 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
875
876 $self->send_packet ($self->{query_queue}[0][0])
877 if @{ $self->{query_queue} } == 1;
878}
879
880cf::client->attach (
881 on_reply => sub {
882 my ($ns, $msg) = @_;
883
884 # this weird shuffling is so that direct followup queries
885 # get handled first
886 my $queue = delete $ns->{query_queue};
887
888 (shift @$queue)->[1]->($msg);
889
890 push @{ $ns->{query_queue} }, @$queue;
891
892 if (@{ $ns->{query_queue} } == @$queue) {
893 if (@$queue) {
894 $ns->send_packet ($ns->{query_queue}[0][0]);
895 } else {
896 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
897 }
898 }
899 },
900);
901
902=item $client->coro (\&cb)
903
904Create a new coroutine, running the specified callback. The coroutine will
905be automatically cancelled when the client gets destroyed (e.g. on logout,
906or loss of connection).
907
908=cut
909
910sub cf::client::coro {
809 my ($self, $id, %msg) = @_; 911 my ($self, $cb) = @_;
810 912
811 $msg{msgid} = $id; 913 my $coro; $coro = async {
914 eval {
915 $cb->();
916 };
917 warn $@ if $@;
918 delete $self->{_coro}{$coro+0};
919 };
812 920
813 $self->send ("ext " . to_json \%msg); 921 $self->{_coro}{$coro+0} = $coro;
814} 922}
923
924cf::client->attach (
925 on_destroy => sub {
926 my ($ns) = @_;
927
928 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
929 },
930);
815 931
816=back 932=back
817 933
818=cut
819
820#############################################################################
821 934
822=head2 SAFE SCRIPTING 935=head2 SAFE SCRIPTING
823 936
824Functions that provide a safe environment to compile and execute 937Functions that provide a safe environment to compile and execute
825snippets of perl code without them endangering the safety of the server 938snippets of perl code without them endangering the safety of the server
826itself. Looping constructs, I/O operators and other built-in functionality 939itself. Looping constructs, I/O operators and other built-in functionality
827is not available in the safe scripting environment, and the number of 940is not available in the safe scripting environment, and the number of
828functions and methods that cna be called is greatly reduced. 941functions and methods that can be called is greatly reduced.
829 942
830=cut 943=cut
831 944
832our $safe = new Safe "safe"; 945our $safe = new Safe "safe";
833our $safe_hole = new Safe::Hole; 946our $safe_hole = new Safe::Hole;
840 953
841=pod 954=pod
842 955
843The following fucntions and emthods are available within a safe environment: 956The following fucntions and emthods are available within a safe environment:
844 957
845 cf::object contr pay_amount pay_player 958 cf::object contr pay_amount pay_player map
846 cf::object::player player 959 cf::object::player player
847 cf::player peaceful 960 cf::player peaceful
961 cf::map trigger
848 962
849=cut 963=cut
850 964
851for ( 965for (
852 ["cf::object" => qw(contr pay_amount pay_player)], 966 ["cf::object" => qw(contr pay_amount pay_player map)],
853 ["cf::object::player" => qw(player)], 967 ["cf::object::player" => qw(player)],
854 ["cf::player" => qw(peaceful)], 968 ["cf::player" => qw(peaceful)],
969 ["cf::map" => qw(trigger)],
855) { 970) {
856 no strict 'refs'; 971 no strict 'refs';
857 my ($pkg, @funs) = @$_; 972 my ($pkg, @funs) = @$_;
858 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 973 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
859 for @funs; 974 for @funs;
969 1084
970Immediately write the database to disk I<if it is dirty>. 1085Immediately write the database to disk I<if it is dirty>.
971 1086
972=cut 1087=cut
973 1088
1089our $DB;
1090
974{ 1091{
975 my $db;
976 my $path = cf::localdir . "/database.pst"; 1092 my $path = cf::localdir . "/database.pst";
977 1093
978 sub db_load() { 1094 sub db_load() {
979 warn "loading database $path\n";#d# remove later 1095 warn "loading database $path\n";#d# remove later
980 $db = stat $path ? Storable::retrieve $path : { }; 1096 $DB = stat $path ? Storable::retrieve $path : { };
981 } 1097 }
982 1098
983 my $pid; 1099 my $pid;
984 1100
985 sub db_save() { 1101 sub db_save() {
986 warn "saving database $path\n";#d# remove later 1102 warn "saving database $path\n";#d# remove later
987 waitpid $pid, 0 if $pid; 1103 waitpid $pid, 0 if $pid;
988 if (0 == ($pid = fork)) { 1104 if (0 == ($pid = fork)) {
989 $db->{_meta}{version} = 1; 1105 $DB->{_meta}{version} = 1;
990 Storable::nstore $db, "$path~"; 1106 Storable::nstore $DB, "$path~";
991 rename "$path~", $path; 1107 rename "$path~", $path;
992 cf::_exit 0 if defined $pid; 1108 cf::_exit 0 if defined $pid;
993 } 1109 }
994 } 1110 }
995 1111
998 sub db_sync() { 1114 sub db_sync() {
999 db_save if $dirty; 1115 db_save if $dirty;
1000 undef $dirty; 1116 undef $dirty;
1001 } 1117 }
1002 1118
1003 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 1119 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1004 db_sync; 1120 db_sync;
1005 }); 1121 });
1006 1122
1007 sub db_dirty() { 1123 sub db_dirty() {
1008 $dirty = 1; 1124 $dirty = 1;
1009 $idle->start; 1125 $idle->start;
1010 } 1126 }
1011 1127
1012 sub db_get($;$) { 1128 sub db_get($;$) {
1013 @_ >= 2 1129 @_ >= 2
1014 ? $db->{$_[0]}{$_[1]} 1130 ? $DB->{$_[0]}{$_[1]}
1015 : ($db->{$_[0]} ||= { }) 1131 : ($DB->{$_[0]} ||= { })
1016 } 1132 }
1017 1133
1018 sub db_put($$;$) { 1134 sub db_put($$;$) {
1019 if (@_ >= 3) { 1135 if (@_ >= 3) {
1020 $db->{$_[0]}{$_[1]} = $_[2]; 1136 $DB->{$_[0]}{$_[1]} = $_[2];
1021 } else { 1137 } else {
1022 $db->{$_[0]} = $_[1]; 1138 $DB->{$_[0]} = $_[1];
1023 } 1139 }
1024 db_dirty; 1140 db_dirty;
1025 } 1141 }
1026 1142
1027 attach_global 1143 cf::global->attach (
1028 prio => 10000, 1144 prio => 10000,
1029 on_cleanup => sub { 1145 on_cleanup => sub {
1030 db_sync; 1146 db_sync;
1031 }, 1147 },
1032 ; 1148 );
1033} 1149}
1034 1150
1035############################################################################# 1151#############################################################################
1036# the server's main() 1152# the server's main()
1037 1153
1058 1174
1059 $msg->("reloading..."); 1175 $msg->("reloading...");
1060 1176
1061 eval { 1177 eval {
1062 # cancel all watchers 1178 # cancel all watchers
1063 $_->cancel for Event::all_watchers; 1179 for (Event::all_watchers) {
1180 $_->cancel if $_->data & WF_AUTOCANCEL;
1181 }
1064 1182
1065 # unload all extensions 1183 # unload all extensions
1066 for (@exts) { 1184 for (@exts) {
1067 $msg->("unloading <$_>"); 1185 $msg->("unloading <$_>");
1068 unload_extension $_; 1186 unload_extension $_;
1103 #Symbol::delete_package __PACKAGE__; 1221 #Symbol::delete_package __PACKAGE__;
1104 1222
1105 # reload cf.pm 1223 # reload cf.pm
1106 $msg->("reloading cf.pm"); 1224 $msg->("reloading cf.pm");
1107 require cf; 1225 require cf;
1226 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1108 1227
1109 # load config and database again 1228 # load config and database again
1110 cf::cfg_load; 1229 cf::cfg_load;
1111 cf::db_load; 1230 cf::db_load;
1112 1231
1128 warn $_[0]; 1247 warn $_[0];
1129 print "$_[0]\n"; 1248 print "$_[0]\n";
1130 }; 1249 };
1131} 1250}
1132 1251
1252register "<global>", __PACKAGE__;
1253
1133register_command "perl-reload", 0, sub { 1254register_command "perl-reload" => sub {
1134 my ($who, $arg) = @_; 1255 my ($who, $arg) = @_;
1135 1256
1136 if ($who->flag (FLAG_WIZ)) { 1257 if ($who->flag (FLAG_WIZ)) {
1137 _perl_reload { 1258 _perl_reload {
1138 warn $_[0]; 1259 warn $_[0];
1139 $who->message ($_[0]); 1260 $who->message ($_[0]);
1140 }; 1261 };
1141 } 1262 }
1142}; 1263};
1143 1264
1144register "<global>", __PACKAGE__;
1145
1146unshift @INC, $LIBDIR; 1265unshift @INC, $LIBDIR;
1147 1266
1148$TICK_WATCHER = Event->timer ( 1267$TICK_WATCHER = Event->timer (
1149 prio => 1, 1268 prio => 0,
1150 at => $NEXT_TICK || 1, 1269 at => $NEXT_TICK || 1,
1270 data => WF_AUTOCANCEL,
1151 cb => sub { 1271 cb => sub {
1152 cf::server_tick; # one server iteration 1272 cf::server_tick; # one server iteration
1153 1273
1154 my $NOW = Event::time; 1274 my $NOW = Event::time;
1155 $NEXT_TICK += $TICK; 1275 $NEXT_TICK += $TICK;
1156 1276
1157 # if we are delayed by four ticks, skip them all 1277 # if we are delayed by four ticks or more, skip them all
1158 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1278 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1159 1279
1160 $TICK_WATCHER->at ($NEXT_TICK); 1280 $TICK_WATCHER->at ($NEXT_TICK);
1161 $TICK_WATCHER->start; 1281 $TICK_WATCHER->start;
1162 }, 1282 },
1163); 1283);
1164 1284
1285IO::AIO::max_poll_time $TICK * 0.2;
1286
1287Event->io (fd => IO::AIO::poll_fileno,
1288 poll => 'r',
1289 prio => 5,
1290 data => WF_AUTOCANCEL,
1291 cb => \&IO::AIO::poll_cb);
1292
11651 12931
1166 1294

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines