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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines