[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.46 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.87 by root, Thu Dec 14 22:45:40 2006 UTC

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

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.46 by root, Sun Aug 27 16:15:12 2006 UTC vs. Revision 1.87 by root, Thu Dec 14 22:45:40 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.46 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.87 by root, Thu Dec 14 22:45:40 2006 UTC