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.64 by root, Sun Sep 10 00:51:24 2006 UTC vs.
Revision 1.94 by root, Thu Dec 21 23:02:54 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines