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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.75 by root, Mon Oct 2 00:22:01 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 YAML::Syck ();
10	use Time::HiRes;	11	use Time::HiRes;
11	use Event;	12	use Event;
12	$Event::Eval = 1; # no idea why this is required, but it is	13	$Event::Eval = 1; # no idea why this is required, but it is
13		14
		15	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		16	$YAML::Syck::ImplicitUnicode = 1;
		17
14	use strict;	18	use strict;
		19
		20	_init_vars;
15		21
16	our %COMMAND = ();	22	our %COMMAND = ();
17	our @EVENT;	23	our @EVENT;
18	our %PROP_TYPE;
19	our %PROP_IDX;
20	our $LIBDIR = maps_directory "perl";	24	our $LIBDIR = maps_directory "perl";
21		25
22	our $TICK = MAX_TIME * 1e-6;	26	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	27	our $TICK_WATCHER;
24	our $NEXT_TICK;	28	our $NEXT_TICK;
		29
		30	our %CFG;
		31
		32	#############################################################################
		33
		34	=head2 GLOBAL VARIABLES
		35
		36	=over 4
		37
		38	=item $cf::LIBDIR
		39
		40	The perl library directory, where extensions and cf-specific modules can
		41	be found. It will be added to C<@INC> automatically.
		42
		43	=item $cf::TICK
		44
		45	The interval between server ticks, in seconds.
		46
		47	=item %cf::CFG
		48
		49	Configuration for the server, loaded from C</etc/crossfire/config>, or
		50	from wherever your confdir points to.
		51
		52	=back
		53
		54	=cut
25		55
26	BEGIN {	56	BEGIN {
27	*CORE::GLOBAL::warn = sub {	57	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	58	my $msg = join "", @_;
29	$msg .= "\n"	59	$msg .= "\n"
…		…
32	print STDERR "cfperl: $msg";	62	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	63	LOG llevError, "cfperl: $msg";
34	};	64	};
35	}	65	}
36		66
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';	67	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		68
73	# we bless all objects into (empty) derived classes to force a method lookup	69	# we bless all objects into (empty) derived classes to force a method lookup
74	# within the Safe compartment.	70	# within the Safe compartment.
75	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	71	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
76	no strict 'refs';	72	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	73	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	74	}
79		75
80	$Event::DIED = sub {	76	$Event::DIED = sub {
…		…
85	my @exts;	81	my @exts;
86	my @hook;	82	my @hook;
87	my %command;	83	my %command;
88	my %extcmd;	84	my %extcmd;
89		85
90	#############################################################################	86	=head2 UTILITY FUNCTIONS
91	# utility functions	87
		88	=over 4
		89
		90	=cut
92		91
93	use JSON::Syck (); # TODO# replace by JSON::PC once working	92	use JSON::Syck (); # TODO# replace by JSON::PC once working
		93
		94	=item $ref = cf::from_json $json
		95
		96	Converts a JSON string into the corresponding perl data structure.
		97
		98	=cut
94		99
95	sub from_json($) {	100	sub from_json($) {
96	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	101	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
97	JSON::Syck::Load $_[0]	102	JSON::Syck::Load $_[0]
98	}	103	}
99		104
		105	=item $json = cf::to_json $ref
		106
		107	Converts a perl data structure into its JSON representation.
		108
		109	=cut
		110
100	sub to_json($) {	111	sub to_json($) {
101	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	112	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
102	JSON::Syck::Dump $_[0]	113	JSON::Syck::Dump $_[0]
103	}	114	}
104		115
105	#############################################################################	116	=back
106	# "new" plug-in system
107		117
108	=item cf::object::attach ... # NYI	118	=cut
		119
		120	#############################################################################
		121
		122	=head2 EVENTS AND OBJECT ATTACHMENTS
		123
		124	=over 4
		125
		126	=item $object->attach ($attachment, key => $value...)
		127
		128	=item $object->detach ($attachment)
		129
		130	Attach/detach a pre-registered attachment to an object.
		131
		132	=item $player->attach ($attachment, key => $value...)
		133
		134	=item $player->detach ($attachment)
		135
		136	Attach/detach a pre-registered attachment to a player.
		137
		138	=item $map->attach ($attachment, key => $value...)
		139
		140	=item $map->detach ($attachment)
		141
		142	Attach/detach a pre-registered attachment to a map.
		143
		144	=item $bool = $object->attached ($name)
		145
		146	=item $bool = $player->attached ($name)
		147
		148	=item $bool = $map->attached ($name)
		149
		150	Checks wether the named attachment is currently attached to the object.
109		151
110	=item cf::attach_global ...	152	=item cf::attach_global ...
111		153
		154	Attach handlers for global events.
		155
		156	This and all following C<attach_*>-functions expect any number of the
		157	following handler/hook descriptions:
		158
		159	=over 4
		160
		161	=item prio => $number
		162
		163	Set the priority for all following handlers/hooks (unless overwritten
		164	by another C<prio> setting). Lower priority handlers get executed
		165	earlier. The default priority is C<0>, and many built-in handlers are
		166	registered at priority C<-1000>, so lower priorities should not be used
		167	unless you know what you are doing.
		168
		169	=item on_I<event> => \&cb
		170
		171	Call the given code reference whenever the named event happens (event is
		172	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
		173	handlers are recognised generally depends on the type of object these
		174	handlers attach to).
		175
		176	See F<include/eventinc.h> for the full list of events supported, and their
		177	class.
		178
		179	=item package => package::
		180
		181	Look for sub functions of the name C<< on_I<event> >> in the given
		182	package and register them. Only handlers for eevents supported by the
		183	object/class are recognised.
		184
		185	=back
		186
112	=item cf::attach_to_type $object_type, ...	187	=item cf::attach_to_type $object_type, $subtype, ...
		188
		189	Attach handlers for a specific object type (e.g. TRANSPORT) and
		190	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		191	type.
113		192
114	=item cf::attach_to_objects ...	193	=item cf::attach_to_objects ...
115		194
		195	Attach handlers to all objects. Do not use this except for debugging or
		196	very rare events, as handlers are (obviously) called for I<all> objects in
		197	the game.
		198
116	=item cf::attach_to_players ...	199	=item cf::attach_to_players ...
117		200
		201	Attach handlers to all players.
		202
118	=item cf::attach_to_maps ...	203	=item cf::attach_to_maps ...
119		204
		205	Attach handlers to all maps.
		206
120	=item cf:register_attachment $name, ...	207	=item cf:register_attachment $name, ...
121		208
122	prio => $number, # lower is earlier	209	Register an attachment by name through which objects can refer to this
123	on_xxx => \&cb,	210	attachment.
124	package => package::,	211
		212	=item cf:register_player_attachment $name, ...
		213
		214	Register an attachment by name through which players can refer to this
		215	attachment.
		216
		217	=item cf:register_map_attachment $name, ...
		218
		219	Register an attachment by name through which maps can refer to this
		220	attachment.
125		221
126	=cut	222	=cut
127		223
128	# the following variables are defined in .xs and must not be re-created	224	# the following variables are defined in .xs and must not be re-created
129	our @CB_GLOBAL = (); # registry for all global events	225	our @CB_GLOBAL = (); # registry for all global events
…		…
191	}	287	}
192		288
193	\%undo	289	\%undo
194	}	290	}
195		291
		292	sub _attach_attachment {
		293	my ($obj, $name, %arg) = @_;
		294
		295	return if exists $obj->{_attachment}{$name};
		296
		297	my $res;
		298
		299	if (my $attach = $attachment{$name}) {
		300	my $registry = $obj->registry;
		301
		302	for (@$attach) {
		303	my ($klass, @attach) = @$_;
		304	$res = _attach @$registry, $klass, @attach;
		305	}
		306
		307	$obj->{$name} = \%arg;
		308	} else {
		309	warn "object uses attachment '$name' that is not available, postponing.\n";
		310	}
		311
		312	$obj->{_attachment}{$name} = undef;
		313
		314	$res->{attachment} = $name;
		315	$res
		316	}
		317
196	sub cf::object::attach {	318	*cf::object::attach =
197	die;	319	*cf::player::attach =
198	}	320	*cf::map::attach = sub {
		321	my ($obj, $name, %arg) = @_;
		322
		323	_attach_attachment $obj, $name, %arg;
		324	};
		325
		326	# all those should be optimised
		327	*cf::object::detach =
		328	*cf::player::detach =
		329	*cf::map::detach = sub {
		330	my ($obj, $name) = @_;
		331
		332	delete $obj->{_attachment}{$name};
		333	reattach ($obj);
		334	};
		335
		336	*cf::object::attached =
		337	*cf::player::attached =
		338	*cf::map::attached = sub {
		339	my ($obj, $name) = @_;
		340
		341	exists $obj->{_attachment}{$name}
		342	};
199		343
200	sub attach_global {	344	sub attach_global {
201	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	345	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
202	}	346	}
203		347
204	sub attach_to_type {	348	sub attach_to_type {
205	my $type = shift;	349	my $type = shift;
		350	my $subtype = shift;
206		351
207	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_	352	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
208	}	353	}
209		354
210	sub attach_to_objects {	355	sub attach_to_objects {
211	_attach @CB_OBJECT, KLASS_OBJECT, @_	356	_attach @CB_OBJECT, KLASS_OBJECT, @_
212	}	357	}
…		…
220	}	365	}
221		366
222	sub register_attachment {	367	sub register_attachment {
223	my $name = shift;	368	my $name = shift;
224		369
		370	$attachment{$name} = [[KLASS_OBJECT, @_]];
		371	}
		372
		373	sub register_player_attachment {
		374	my $name = shift;
		375
		376	$attachment{$name} = [[KLASS_PLAYER, @_]];
		377	}
		378
		379	sub register_map_attachment {
		380	my $name = shift;
		381
225	$attachment{$name} = [@_];	382	$attachment{$name} = [[KLASS_MAP, @_]];
226	}	383	}
227		384
228	our $override;	385	our $override;
229	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	386	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
230		387
…		…
244	for (@$callbacks) {	401	for (@$callbacks) {
245	eval { &{$_->[1]} };	402	eval { &{$_->[1]} };
246		403
247	if ($@) {	404	if ($@) {
248	warn "$@";	405	warn "$@";
249	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	406	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
250	override;	407	override;
251	}	408	}
252		409
253	return 1 if $override;	410	return 1 if $override;
254	}	411	}
255		412
256	0	413	0
257	}	414	}
		415
		416	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		417
		418	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		419
		420	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		421
		422	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		423
		424	Generate a global/object/player/map-specific event with the given arguments.
		425
		426	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		427	removed in future versions), and there is no public API to access override
		428	results (if you must, access C<@cf::invoke_results> directly).
		429
		430	=back
		431
		432	=cut
		433
		434	#############################################################################
		435
		436	=head2 METHODS VALID FOR ALL CORE OBJECTS
		437
		438	=over 4
		439
		440	=item $object->valid, $player->valid, $map->valid
		441
		442	Just because you have a perl object does not mean that the corresponding
		443	C-level object still exists. If you try to access an object that has no
		444	valid C counterpart anymore you get an exception at runtime. This method
		445	can be used to test for existence of the C object part without causing an
		446	exception.
		447
		448	=back
		449
		450	=cut
		451
		452	*cf::object::valid =
		453	*cf::player::valid =
		454	*cf::map::valid = \&cf::_valid;
258		455
259	#############################################################################	456	#############################################################################
260	# object support	457	# object support
261		458
262	sub instantiate {	459	sub instantiate {
263	my ($obj, $data) = @_;	460	my ($obj, $data) = @_;
264	my $registry = $obj->registry;
265		461
266	$data = from_json $data;	462	$data = from_json $data;
267		463
268	for (@$data) {	464	for (@$data) {
269	my ($pri, $name, @args) = @$_;	465	my ($name, $args) = @$_;
270		466
271	if (my $attach = $attachment{$name}) {	467	$obj->attach ($name, %{$args \|\| {} });
272	_attach @$registry, KLASS_OBJECT, @$attach;
273
274	if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
275	for (@$cb) {
276	eval { $_->[1]->($obj, @args); };
277	if ($@) {
278	warn "$@";
279	warn "... while processing '$name' instantiate with args <@args>\n";
280	}
281	}
282	}
283	} else {
284	warn "object uses attachment $name that is not available, postponing.\n";
285	}
286
287	push @{$obj->{_attachment}}, $name;
288	}	468	}
289	}	469	}
290		470
291	# basically do the same as instantiate, without calling instantiate	471	# basically do the same as instantiate, without calling instantiate
292	sub reattach {	472	sub reattach {
293	my ($obj) = @_;	473	my ($obj) = @_;
294	my $registry = $obj->registry;	474	my $registry = $obj->registry;
295		475
296	warn "reattach<@_, $_>\n";	476	@$registry = ();
		477
		478	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		479
		480	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
		481	if (my $attach = $attachment{$name}) {
		482	for (@$attach) {
		483	my ($klass, @attach) = @$_;
		484	_attach @$registry, $klass, @attach;
		485	}
		486	} else {
		487	warn "object uses attachment '$name' that is not available, postponing.\n";
		488	}
		489	}
		490	}
		491
		492	sub object_freezer_save {
		493	my ($filename, $rdata, $objs) = @_;
		494
		495	if (length $$rdata) {
		496	warn sprintf "saving %s (%d,%d)\n",
		497	$filename, length $$rdata, scalar @$objs;
		498
		499	if (open my $fh, ">:raw", "$filename~") {
		500	chmod SAVE_MODE, $fh;
		501	syswrite $fh, $$rdata;
		502	close $fh;
		503
		504	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		505	chmod SAVE_MODE, $fh;
		506	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
		507	close $fh;
		508	rename "$filename.pst~", "$filename.pst";
		509	} else {
		510	unlink "$filename.pst";
		511	}
		512
		513	rename "$filename~", $filename;
		514	} else {
		515	warn "FATAL: $filename~: $!\n";
		516	}
		517	} else {
		518	unlink $filename;
		519	unlink "$filename.pst";
		520	}
		521	}
		522
		523	sub object_thawer_load {
		524	my ($filename) = @_;
		525
		526	local $/;
		527
		528	my $av;
		529
		530	#TODO: use sysread etc.
		531	if (open my $data, "<:raw:perlio", $filename) {
		532	$data = <$data>;
		533	if (open my $pst, "<:raw:perlio", "$filename.pst") {
		534	$av = eval { (Storable::thaw <$pst>)->{objs} };
		535	}
		536	return ($data, $av);
		537	}
		538
		539	()
297	}	540	}
298		541
299	attach_to_objects	542	attach_to_objects
300	prio => -1000000,	543	prio => -1000000,
301	on_clone => sub {	544	on_clone => sub {
302	my ($src, $dst) = @_;	545	my ($src, $dst) = @_;
303		546
304	@{$dst->registry} = @{$src->registry};	547	@{$dst->registry} = @{$src->registry};
305	warn "registry clone ", join ":", @{$src->registry};#d#
306		548
307	%$dst = %$src;	549	%$dst = %$src;
308		550
309	$dst->{_attachment} = [@{ $src->{_attachment} }]	551	%{$dst->{_attachment}} = %{$src->{_attachment}}
310	if exists $src->{_attachment};	552	if exists $src->{_attachment};
311
312	warn "clone<@_>\n";#d#
313	},	553	},
314	;	554	;
315		555
316	#############################################################################	556	#############################################################################
317	# old plug-in events	557	# old plug-in events
…		…
450	load_extension $ext;	690	load_extension $ext;
451	1	691	1
452	} or warn "$ext not loaded: $@";	692	} or warn "$ext not loaded: $@";
453	}	693	}
454	}	694	}
455
456	sub _perl_reload(&) {
457	my ($msg) = @_;
458
459	$msg->("reloading...");
460
461	eval {
462	# 1. cancel all watchers
463	$_->cancel for Event::all_watchers;
464
465	# 2. unload all extensions
466	for (@exts) {
467	$msg->("unloading <$_>");
468	unload_extension $_;
469	}
470
471	# 3. unload all modules loaded from $LIBDIR
472	while (my ($k, $v) = each %INC) {
473	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
474
475	$msg->("removing <$k>");
476	delete $INC{$k};
477
478	$k =~ s/\.pm$//;
479	$k =~ s/\//::/g;
480
481	if (my $cb = $k->can ("unload_module")) {
482	$cb->();
483	}
484
485	Symbol::delete_package $k;
486	}
487
488	# 4. get rid of safe::, as good as possible
489	Symbol::delete_package "safe::$_"
490	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
491
492	# 5. remove register_script_function callbacks
493	# TODO
494
495	# 6. unload cf.pm "a bit"
496	delete $INC{"cf.pm"};
497
498	# don't, removes xs symbols, too,
499	# and global variables created in xs
500	#Symbol::delete_package __PACKAGE__;
501
502	# 7. reload cf.pm
503	$msg->("reloading cf.pm");
504	require cf;
505	};
506	$msg->($@) if $@;
507
508	$msg->("reloaded");
509	};
510
511	sub perl_reload() {
512	_perl_reload {
513	warn $_[0];
514	print "$_[0]\n";
515	};
516	}
517
518	register_command "perl-reload", 0, sub {
519	my ($who, $arg) = @_;
520
521	if ($who->flag (FLAG_WIZ)) {
522	_perl_reload {
523	warn $_[0];
524	$who->message ($_[0]);
525	};
526	}
527	};
528		695
529	#############################################################################	696	#############################################################################
530	# extcmd framework, basically convert ext <msg>	697	# extcmd framework, basically convert ext <msg>
531	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	698	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
532		699
…		…
557	my ($map) = @_;	724	my ($map) = @_;
558		725
559	my $path = $map->tmpname;	726	my $path = $map->tmpname;
560	defined $path or return;	727	defined $path or return;
561		728
562	unlink "$path.cfperl";	729	unlink "$path.pst";
563	};
564
565	*cf::mapsupport::on_swapin =
566	*cf::mapsupport::on_load = sub {
567	my ($map) = @_;
568
569	my $path = $map->tmpname;
570	$path = $map->path unless defined $path;
571
572	open my $fh, "<:raw", "$path.cfperl"
573	or return; # no perl data
574
575	my $data = Storable::thaw do { local $/; <$fh> };
576
577	$data->{version} <= 1
578	or return; # too new
579
580	$map->_set_obs ($data->{obs});
581	};
582
583	*cf::mapsupport::on_swapout = sub {
584	my ($map) = @_;
585
586	my $path = $map->tmpname;
587	$path = $map->path unless defined $path;
588
589	my $obs = $map->_get_obs;
590
591	if (defined $obs) {
592	open my $fh, ">:raw", "$path.cfperl"
593	or die "$path.cfperl: $!";
594
595	stat $path;
596
597	print $fh Storable::nfreeze {
598	size => (stat _)[7],
599	time => (stat _)[9],
600	version => 1,
601	obs => $obs,
602	};
603
604	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
605	} else {
606	unlink "$path.cfperl";
607	}
608	};	730	};
609		731
610	attach_to_maps prio => -10000, package => cf::mapsupport::;	732	attach_to_maps prio => -10000, package => cf::mapsupport::;
611		733
612	#############################################################################	734	#############################################################################
…		…
614		736
615	sub all_objects(@) {	737	sub all_objects(@) {
616	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
617	}	739	}
618		740
		741	# TODO: compatibility cruft, remove when no longer needed
619	attach_to_players	742	attach_to_players
620	on_load => sub {	743	on_load => sub {
621	my ($pl, $path) = @_;	744	my ($pl, $path) = @_;
622		745
623	for my $o (all_objects $pl->ob) {	746	for my $o (all_objects $pl->ob) {
…		…
626		749
627	%$o = %{ Storable::thaw pack "H*", $value };	750	%$o = %{ Storable::thaw pack "H*", $value };
628	}	751	}
629	}	752	}
630	},	753	},
631	on_save => sub {
632	my ($pl, $path) = @_;
633
634	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
635	for grep %$_, all_objects $pl->ob;
636	},
637	;	754	;
638		755
639	#############################################################################	756	#############################################################################
640	# core extensions - in perl	757
		758	=head2 CORE EXTENSIONS
		759
		760	Functions and methods that extend core crossfire objects.
		761
		762	=over 4
641		763
642	=item cf::player::exists $login	764	=item cf::player::exists $login
643		765
644	Returns true when the given account exists.	766	Returns true when the given account exists.
645		767
…		…
648	sub cf::player::exists($) {	770	sub cf::player::exists($) {
649	cf::player::find $_[0]	771	cf::player::find $_[0]
650	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	772	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
651	}	773	}
652		774
653	=item $player->reply ($npc, $msg[, $flags])	775	=item $object->reply ($npc, $msg[, $flags])
654		776
655	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	777	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
656	can be C<undef>. Does the right thing when the player is currently in a	778	can be C<undef>. Does the right thing when the player is currently in a
657	dialogue with the given NPC character.	779	dialogue with the given NPC character.
658		780
…		…
685	$msg{msgid} = $id;	807	$msg{msgid} = $id;
686		808
687	$self->send ("ext " . to_json \%msg);	809	$self->send ("ext " . to_json \%msg);
688	}	810	}
689		811
		812	=back
		813
		814	=cut
		815
690	#############################################################################	816	#############################################################################
691	# map scripting support	817
		818	=head2 SAFE SCRIPTING
		819
		820	Functions that provide a safe environment to compile and execute
		821	snippets of perl code without them endangering the safety of the server
		822	itself. Looping constructs, I/O operators and other built-in functionality
		823	is not available in the safe scripting environment, and the number of
		824	functions and methods that cna be called is greatly reduced.
		825
		826	=cut
692		827
693	our $safe = new Safe "safe";	828	our $safe = new Safe "safe";
694	our $safe_hole = new Safe::Hole;	829	our $safe_hole = new Safe::Hole;
695		830
696	$SIG{FPE} = 'IGNORE';	831	$SIG{FPE} = 'IGNORE';
697		832
698	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	833	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
699		834
700	# here we export the classes and methods available to script code	835	# here we export the classes and methods available to script code
		836
		837	=pod
		838
		839	The following fucntions and emthods are available within a safe environment:
		840
		841	cf::object contr pay_amount pay_player
		842	cf::object::player player
		843	cf::player peaceful
		844
		845	=cut
701		846
702	for (	847	for (
703	["cf::object" => qw(contr pay_amount pay_player)],	848	["cf::object" => qw(contr pay_amount pay_player)],
704	["cf::object::player" => qw(player)],	849	["cf::object::player" => qw(player)],
705	["cf::player" => qw(peaceful)],	850	["cf::player" => qw(peaceful)],
…		…
708	my ($pkg, @funs) = @$_;	853	my ($pkg, @funs) = @$_;
709	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	854	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
710	for @funs;	855	for @funs;
711	}	856	}
712		857
		858	=over 4
		859
		860	=item @retval = safe_eval $code, [var => value, ...]
		861
		862	Compiled and executes the given perl code snippet. additional var/value
		863	pairs result in temporary local (my) scalar variables of the given name
		864	that are available in the code snippet. Example:
		865
		866	my $five = safe_eval '$first + $second', first => 1, second => 4;
		867
		868	=cut
		869
713	sub safe_eval($;@) {	870	sub safe_eval($;@) {
714	my ($code, %vars) = @_;	871	my ($code, %vars) = @_;
715		872
716	my $qcode = $code;	873	my $qcode = $code;
717	$qcode =~ s/"/‟/g; # not allowed in #line filenames	874	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
739	}	896	}
740		897
741	wantarray ? @res : $res[0]	898	wantarray ? @res : $res[0]
742	}	899	}
743		900
		901	=item cf::register_script_function $function => $cb
		902
		903	Register a function that can be called from within map/npc scripts. The
		904	function should be reasonably secure and should be put into a package name
		905	like the extension.
		906
		907	Example: register a function that gets called whenever a map script calls
		908	C<rent::overview>, as used by the C<rent> extension.
		909
		910	cf::register_script_function "rent::overview" => sub {
		911	...
		912	};
		913
		914	=cut
		915
744	sub register_script_function {	916	sub register_script_function {
745	my ($fun, $cb) = @_;	917	my ($fun, $cb) = @_;
746		918
747	no strict 'refs';	919	no strict 'refs';
748	*{"safe::$fun"} = $safe_hole->wrap ($cb);	920	*{"safe::$fun"} = $safe_hole->wrap ($cb);
749	}	921	}
750		922
		923	=back
		924
		925	=cut
		926
		927	#############################################################################
		928
		929	=head2 EXTENSION DATABASE SUPPORT
		930
		931	Crossfire maintains a very simple database for extension use. It can
		932	currently store anything that can be serialised using Storable, which
		933	excludes objects.
		934
		935	The parameter C<$family> should best start with the name of the extension
		936	using it, it should be unique.
		937
		938	=over 4
		939
		940	=item $hashref = cf::db_get $family
		941
		942	Return a hashref for use by the extension C<$family>, which can be
		943	modified. After modifications, you have to call C<cf::db_dirty> or
		944	C<cf::db_sync>.
		945
		946	=item $value = cf::db_get $family => $key
		947
		948	Returns a single value from the database
		949
		950	=item cf::db_put $family => $hashref
		951
		952	Stores the given family hashref into the database. Updates are delayed, if
		953	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		954
		955	=item cf::db_put $family => $key => $value
		956
		957	Stores the given C<$value> in the family hash. Updates are delayed, if you
		958	want the data to be synced to disk immediately, use C<cf::db_sync>.
		959
		960	=item cf::db_dirty
		961
		962	Marks the database as dirty, to be updated at a later time.
		963
		964	=item cf::db_sync
		965
		966	Immediately write the database to disk I<if it is dirty>.
		967
		968	=cut
		969
		970	{
		971	my $db;
		972	my $path = cf::localdir . "/database.pst";
		973
		974	sub db_load() {
		975	warn "loading database $path\n";#d# remove later
		976	$db = stat $path ? Storable::retrieve $path : { };
		977	}
		978
		979	my $pid;
		980
		981	sub db_save() {
		982	warn "saving database $path\n";#d# remove later
		983	waitpid $pid, 0 if $pid;
		984	if (0 == ($pid = fork)) {
		985	$db->{_meta}{version} = 1;
		986	Storable::nstore $db, "$path~";
		987	rename "$path~", $path;
		988	cf::_exit 0 if defined $pid;
		989	}
		990	}
		991
		992	my $dirty;
		993
		994	sub db_sync() {
		995	db_save if $dirty;
		996	undef $dirty;
		997	}
		998
		999	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
		1000	db_sync;
		1001	});
		1002
		1003	sub db_dirty() {
		1004	$dirty = 1;
		1005	$idle->start;
		1006	}
		1007
		1008	sub db_get($;$) {
		1009	@_ >= 2
		1010	? $db->{$_[0]}{$_[1]}
		1011	: ($db->{$_[0]} \|\|= { })
		1012	}
		1013
		1014	sub db_put($$;$) {
		1015	if (@_ >= 3) {
		1016	$db->{$_[0]}{$_[1]} = $_[2];
		1017	} else {
		1018	$db->{$_[0]} = $_[1];
		1019	}
		1020	db_dirty;
		1021	}
		1022
		1023	attach_global
		1024	prio => 10000,
		1025	on_cleanup => sub {
		1026	db_sync;
		1027	},
		1028	;
		1029	}
		1030
751	#############################################################################	1031	#############################################################################
752	# the server's main()	1032	# the server's main()
753		1033
		1034	sub cfg_load {
		1035	open my $fh, "<:utf8", cf::confdir . "/config"
		1036	or return;
		1037
		1038	local $/;
		1039	*CFG = YAML::Syck::Load <$fh>;
		1040	}
		1041
754	sub main {	1042	sub main {
		1043	cfg_load;
		1044	db_load;
		1045	load_extensions;
755	Event::loop;	1046	Event::loop;
756	}	1047	}
757		1048
758	#############################################################################	1049	#############################################################################
759	# initialisation	1050	# initialisation
760		1051
		1052	sub _perl_reload(&) {
		1053	my ($msg) = @_;
		1054
		1055	$msg->("reloading...");
		1056
		1057	eval {
		1058	# cancel all watchers
		1059	$_->cancel for Event::all_watchers;
		1060
		1061	# unload all extensions
		1062	for (@exts) {
		1063	$msg->("unloading <$_>");
		1064	unload_extension $_;
		1065	}
		1066
		1067	# unload all modules loaded from $LIBDIR
		1068	while (my ($k, $v) = each %INC) {
		1069	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1070
		1071	$msg->("removing <$k>");
		1072	delete $INC{$k};
		1073
		1074	$k =~ s/\.pm$//;
		1075	$k =~ s/\//::/g;
		1076
		1077	if (my $cb = $k->can ("unload_module")) {
		1078	$cb->();
		1079	}
		1080
		1081	Symbol::delete_package $k;
		1082	}
		1083
		1084	# sync database to disk
		1085	cf::db_sync;
		1086
		1087	# get rid of safe::, as good as possible
		1088	Symbol::delete_package "safe::$_"
		1089	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1090
		1091	# remove register_script_function callbacks
		1092	# TODO
		1093
		1094	# unload cf.pm "a bit"
		1095	delete $INC{"cf.pm"};
		1096
		1097	# don't, removes xs symbols, too,
		1098	# and global variables created in xs
		1099	#Symbol::delete_package __PACKAGE__;
		1100
		1101	# reload cf.pm
		1102	$msg->("reloading cf.pm");
		1103	require cf;
		1104
		1105	# load config and database again
		1106	cf::cfg_load;
		1107	cf::db_load;
		1108
		1109	# load extensions
		1110	$msg->("load extensions");
		1111	cf::load_extensions;
		1112
		1113	# reattach attachments to objects
		1114	$msg->("reattach");
		1115	_global_reattach;
		1116	};
		1117	$msg->($@) if $@;
		1118
		1119	$msg->("reloaded");
		1120	};
		1121
		1122	sub perl_reload() {
		1123	_perl_reload {
		1124	warn $_[0];
		1125	print "$_[0]\n";
		1126	};
		1127	}
		1128
		1129	register_command "perl-reload", 0, sub {
		1130	my ($who, $arg) = @_;
		1131
		1132	if ($who->flag (FLAG_WIZ)) {
		1133	_perl_reload {
		1134	warn $_[0];
		1135	$who->message ($_[0]);
		1136	};
		1137	}
		1138	};
		1139
761	register "<global>", __PACKAGE__;	1140	register "<global>", __PACKAGE__;
762		1141
763	unshift @INC, $LIBDIR;	1142	unshift @INC, $LIBDIR;
764
765	load_extensions;
766		1143
767	$TICK_WATCHER = Event->timer (	1144	$TICK_WATCHER = Event->timer (
768	prio => 1,	1145	prio => 1,
769	at => $NEXT_TICK \|\| 1,	1146	at => $NEXT_TICK \|\| 1,
770	cb => sub {	1147	cb => sub {

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs. Revision 1.75 by root, Mon Oct 2 00:22:01 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.75 by root, Mon Oct 2 00:22:01 2006 UTC