[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.84 by root, Mon Dec 11 02:54:57 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;
		20
		21	_init_vars;
15		22
16	our %COMMAND = ();	23	our %COMMAND = ();
17	our @EVENT;	24	our @EVENT;
18	our %PROP_TYPE;
19	our %PROP_IDX;
20	our $LIBDIR = maps_directory "perl";	25	our $LIBDIR = maps_directory "perl";
21		26
22	our $TICK = MAX_TIME * 1e-6;	27	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	28	our $TICK_WATCHER;
24	our $NEXT_TICK;	29	our $NEXT_TICK;
		30
		31	our %CFG;
		32
		33	our $UPTIME; $UPTIME \|\|= time;
		34
		35	#############################################################################
		36
		37	=head2 GLOBAL VARIABLES
		38
		39	=over 4
		40
		41	=item $cf::UPTIME
		42
		43	The timestamp of the server start (so not actually an uptime).
		44
		45	=item $cf::LIBDIR
		46
		47	The perl library directory, where extensions and cf-specific modules can
		48	be found. It will be added to C<@INC> automatically.
		49
		50	=item $cf::TICK
		51
		52	The interval between server ticks, in seconds.
		53
		54	=item %cf::CFG
		55
		56	Configuration for the server, loaded from C</etc/crossfire/config>, or
		57	from wherever your confdir points to.
		58
		59	=back
		60
		61	=cut
25		62
26	BEGIN {	63	BEGIN {
27	*CORE::GLOBAL::warn = sub {	64	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	65	my $msg = join "", @_;
29	$msg .= "\n"	66	$msg .= "\n"
…		…
32	print STDERR "cfperl: $msg";	69	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	70	LOG llevError, "cfperl: $msg";
34	};	71	};
35	}	72	}
36		73
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';	74	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		75
73	# we bless all objects into (empty) derived classes to force a method lookup	76	# we bless all objects into (empty) derived classes to force a method lookup
74	# within the Safe compartment.	77	# within the Safe compartment.
75	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {	78	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';	79	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	80	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	81	}
79		82
80	$Event::DIED = sub {	83	$Event::DIED = sub {
…		…
85	my @exts;	88	my @exts;
86	my @hook;	89	my @hook;
87	my %command;	90	my %command;
88	my %extcmd;	91	my %extcmd;
89		92
90	#############################################################################	93	=head2 UTILITY FUNCTIONS
91	# utility functions	94
		95	=over 4
		96
		97	=cut
92		98
93	use JSON::Syck (); # TODO# replace by JSON::PC once working	99	use JSON::Syck (); # TODO# replace by JSON::PC once working
		100
		101	=item $ref = cf::from_json $json
		102
		103	Converts a JSON string into the corresponding perl data structure.
		104
		105	=cut
94		106
95	sub from_json($) {	107	sub from_json($) {
96	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	108	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
97	JSON::Syck::Load $_[0]	109	JSON::Syck::Load $_[0]
98	}	110	}
99		111
		112	=item $json = cf::to_json $ref
		113
		114	Converts a perl data structure into its JSON representation.
		115
		116	=cut
		117
100	sub to_json($) {	118	sub to_json($) {
101	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	119	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
102	JSON::Syck::Dump $_[0]	120	JSON::Syck::Dump $_[0]
103	}	121	}
104		122
		123	=back
		124
		125	=cut
		126
105	#############################################################################	127	#############################################################################
106	# "new" plug-in system
107		128
		129	=head2 EVENTS AND OBJECT ATTACHMENTS
		130
		131	=over 4
		132
		133	=item $object->attach ($attachment, key => $value...)
		134
108	=item $object->attach ($attachment, ...)	135	=item $object->detach ($attachment)
109		136
110	Attach a pre-registered attachment to an object.	137	Attach/detach a pre-registered attachment to an object.
111		138
		139	=item $player->attach ($attachment, key => $value...)
		140
112	=item $player->attach ($attachment, ...)	141	=item $player->detach ($attachment)
113		142
114	Attach a pre-registered attachment to a player.	143	Attach/detach a pre-registered attachment to a player.
115		144
116	=item $map->attach ($attachment, ...) # not yet persistent	145	=item $map->attach ($attachment, key => $value...)
117		146
		147	=item $map->detach ($attachment)
		148
118	Attach a pre-registered attachment to a map.	149	Attach/detach a pre-registered attachment to a map.
		150
		151	=item $bool = $object->attached ($name)
		152
		153	=item $bool = $player->attached ($name)
		154
		155	=item $bool = $map->attached ($name)
		156
		157	Checks wether the named attachment is currently attached to the object.
119		158
120	=item cf::attach_global ...	159	=item cf::attach_global ...
121		160
122	Attach handlers for global events.	161	Attach handlers for global events.
123		162
…		…
150	package and register them. Only handlers for eevents supported by the	189	package and register them. Only handlers for eevents supported by the
151	object/class are recognised.	190	object/class are recognised.
152		191
153	=back	192	=back
154		193
155	=item cf::attach_to_type $object_type, ...	194	=item cf::attach_to_type $object_type, $subtype, ...
156		195
157	Attach handlers for a specific object type (e.g. TRANSPORT).	196	Attach handlers for a specific object type (e.g. TRANSPORT) and
		197	subtype. If C<$subtype> is zero or undef, matches all objects of the given
		198	type.
158		199
159	=item cf::attach_to_objects ...	200	=item cf::attach_to_objects ...
160		201
161	Attach handlers to all objects. Do not use this except for debugging or	202	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	203	very rare events, as handlers are (obviously) called for I<all> objects in
…		…
169	=item cf::attach_to_maps ...	210	=item cf::attach_to_maps ...
170		211
171	Attach handlers to all maps.	212	Attach handlers to all maps.
172		213
173	=item cf:register_attachment $name, ...	214	=item cf:register_attachment $name, ...
		215
		216	Register an attachment by name through which objects can refer to this
		217	attachment.
		218
		219	=item cf:register_player_attachment $name, ...
		220
		221	Register an attachment by name through which players can refer to this
		222	attachment.
		223
		224	=item cf:register_map_attachment $name, ...
		225
		226	Register an attachment by name through which maps can refer to this
		227	attachment.
174		228
175	=cut	229	=cut
176		230
177	# the following variables are defined in .xs and must not be re-created	231	# the following variables are defined in .xs and must not be re-created
178	our @CB_GLOBAL = (); # registry for all global events	232	our @CB_GLOBAL = (); # registry for all global events
…		…
241		295
242	\%undo	296	\%undo
243	}	297	}
244		298
245	sub _attach_attachment {	299	sub _attach_attachment {
246	my ($klass, $obj, $name, @args) = q_;	300	my ($obj, $name, %arg) = @_;
		301
		302	return if exists $obj->{_attachment}{$name};
247		303
248	my $res;	304	my $res;
249		305
250	if (my $attach = $attachment{$name}) {	306	if (my $attach = $attachment{$name}) {
251	my $registry = $obj->registry;	307	my $registry = $obj->registry;
252		308
		309	for (@$attach) {
		310	my ($klass, @attach) = @$_;
253	$res = _attach @$registry, $klass, @$attach;	311	$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	}
263	}	312	}
		313
		314	$obj->{$name} = \%arg;
264	} else {	315	} else {
265	warn "object uses attachment '$name' that is not available, postponing.\n";	316	warn "object uses attachment '$name' that is not available, postponing.\n";
266	}	317	}
267		318
268	push @{$obj->{_attachment}}, $name;	319	$obj->{_attachment}{$name} = undef;
269		320
270	$res->{attachment} = $name;	321	$res->{attachment} = $name;
271	$res	322	$res
272	}	323	}
273		324
274	sub cf::object::attach {	325	*cf::object::attach =
		326	*cf::player::attach =
		327	*cf::map::attach = sub {
275	my ($obj, $name, @args) = @_;	328	my ($obj, $name, %arg) = @_;
276		329
277	_attach_attachment KLASS_OBJECT, $obj, $name, @args;	330	_attach_attachment $obj, $name, %arg;
278	}	331	};
279		332
		333	# all those should be optimised
		334	*cf::object::detach =
280	sub cf::player::attach {	335	*cf::player::detach =
		336	*cf::map::detach = sub {
281	my ($obj, $name, @args) = @_;	337	my ($obj, $name) = @_;
282		338
283	_attach_attachment KLASS_PLAYER, $obj, $name, @args;	339	delete $obj->{_attachment}{$name};
284	}	340	reattach ($obj);
		341	};
285		342
286	sub cf::map::attach {	343	*cf::object::attached =
		344	*cf::player::attached =
		345	*cf::map::attached = sub {
287	my ($obj, $name, @args) = @_;	346	my ($obj, $name) = @_;
288		347
289	_attach_attachment KLASS_MAP, $obj, $name, @args;	348	exists $obj->{_attachment}{$name}
290	}	349	};
291		350
292	sub attach_global {	351	sub attach_global {
293	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	352	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
294	}	353	}
295		354
296	sub attach_to_type {	355	sub attach_to_type {
297	my $type = shift;	356	my $type = shift;
		357	my $subtype = shift;
298		358
299	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_	359	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300	}	360	}
301		361
302	sub attach_to_objects {	362	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_	363	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}	364	}
…		…
312	}	372	}
313		373
314	sub register_attachment {	374	sub register_attachment {
315	my $name = shift;	375	my $name = shift;
316		376
		377	$attachment{$name} = [[KLASS_OBJECT, @_]];
		378	}
		379
		380	sub register_player_attachment {
		381	my $name = shift;
		382
		383	$attachment{$name} = [[KLASS_PLAYER, @_]];
		384	}
		385
		386	sub register_map_attachment {
		387	my $name = shift;
		388
317	$attachment{$name} = [@_];	389	$attachment{$name} = [[KLASS_MAP, @_]];
318	}	390	}
319		391
320	our $override;	392	our $override;
321	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	393	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322		394
…		…
336	for (@$callbacks) {	408	for (@$callbacks) {
337	eval { &{$_->[1]} };	409	eval { &{$_->[1]} };
338		410
339	if ($@) {	411	if ($@) {
340	warn "$@";	412	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	413	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	414	override;
343	}	415	}
344		416
345	return 1 if $override;	417	return 1 if $override;
346	}	418	}
347		419
348	0	420	0
349	}	421	}
350		422
		423	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
		424
		425	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
		426
		427	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
		428
		429	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
		430
		431	Generate a global/object/player/map-specific event with the given arguments.
		432
		433	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
		434	removed in future versions), and there is no public API to access override
		435	results (if you must, access C<@cf::invoke_results> directly).
		436
		437	=back
		438
		439	=cut
		440
		441	#############################################################################
		442
		443	=head2 METHODS VALID FOR ALL CORE OBJECTS
		444
		445	=over 4
		446
		447	=item $object->valid, $player->valid, $map->valid
		448
		449	Just because you have a perl object does not mean that the corresponding
		450	C-level object still exists. If you try to access an object that has no
		451	valid C counterpart anymore you get an exception at runtime. This method
		452	can be used to test for existence of the C object part without causing an
		453	exception.
		454
		455	=back
		456
		457	=cut
		458
		459	*cf::object::valid =
		460	*cf::player::valid =
		461	*cf::map::valid = \&cf::_valid;
		462
351	#############################################################################	463	#############################################################################
352	# object support	464	# object support
353		465
354	sub instantiate {	466	sub instantiate {
355	my ($obj, $data) = @_;	467	my ($obj, $data) = @_;
356		468
357	$data = from_json $data;	469	$data = from_json $data;
358		470
359	for (@$data) {	471	for (@$data) {
360	my ($name, $args) = @$_;	472	my ($name, $args) = @$_;
361	attach $obj, $name, @{$args \|\| [] };	473
		474	$obj->attach ($name, %{$args \|\| {} });
362	}	475	}
363	}	476	}
364		477
365	# basically do the same as instantiate, without calling instantiate	478	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	479	sub reattach {
367	warn "reattach<@_>\n";#d#
368	my ($obj) = @_;	480	my ($obj) = @_;
369	my $registry = $obj->registry;	481	my $registry = $obj->registry;
370		482
		483	@$registry = ();
		484
		485	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		486
371	for my $name (@{ $obj->{_attachment} }) {	487	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
372	if (my $attach = $attachment{$name}) {	488	if (my $attach = $attachment{$name}) {
		489	for (@$attach) {
		490	my ($klass, @attach) = @$_;
373	_attach @$registry, KLASS_OBJECT, @$attach;	491	_attach @$registry, $klass, @attach;
		492	}
374	} else {	493	} else {
375	warn "object uses attachment '$name' that is not available, postponing.\n";	494	warn "object uses attachment '$name' that is not available, postponing.\n";
376	}	495	}
377	}	496	}
378
379	warn "reattach<@_, $_>\n";
380	}	497	}
381		498
382	sub object_freezer_save {	499	sub object_freezer_save {
383	my ($filename, $objs) = @_;	500	my ($filename, $rdata, $objs) = @_;
384	warn "freeze $filename\n";#d#
385	use Data::Dumper; print Dumper $objs;
386		501
387	$filename .= ".pst";	502	if (length $$rdata) {
		503	warn sprintf "saving %s (%d,%d)\n",
		504	$filename, length $$rdata, scalar @$objs;
388		505
389	if (@$objs) {
390	open my $fh, ">:raw", "$filename~";	506	if (open my $fh, ">:raw", "$filename~") {
391	chmod $fh, SAVE_MODE;	507	chmod SAVE_MODE, $fh;
		508	syswrite $fh, $$rdata;
		509	close $fh;
		510
		511	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
		512	chmod SAVE_MODE, $fh;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	513	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393	close $fh;	514	close $fh;
		515	rename "$filename.pst~", "$filename.pst";
		516	} else {
		517	unlink "$filename.pst";
		518	}
		519
394	rename "$filename~", $filename;	520	rename "$filename~", $filename;
		521	} else {
		522	warn "FATAL: $filename~: $!\n";
		523	}
395	} else {	524	} else {
396	unlink $filename;	525	unlink $filename;
		526	unlink "$filename.pst";
397	}	527	}
		528	}
		529
		530	sub object_freezer_as_string {
		531	my ($rdata, $objs) = @_;
		532
		533	use Data::Dumper;
		534
		535	$$rdata . Dumper $objs
398	}	536	}
399		537
400	sub object_thawer_load {	538	sub object_thawer_load {
401	my ($filename) = @_;	539	my ($filename) = @_;
402		540
403	warn "thaw $filename\n";#d#	541	local $/;
404		542
		543	my $av;
		544
		545	#TODO: use sysread etc.
		546	if (open my $data, "<:raw:perlio", $filename) {
		547	$data = <$data>;
405	open my $fh, "<:raw:perlio", "$filename.pst"	548	if (open my $pst, "<:raw:perlio", "$filename.pst") {
406	or return;	549	$av = eval { (Storable::thaw <$pst>)->{objs} };
		550	}
		551	return ($data, $av);
		552	}
407		553
408	eval { local $/; (Storable::thaw <$fh>)->{objs} }	554	()
409	}	555	}
410		556
411	attach_to_objects	557	attach_to_objects
412	prio => -1000000,	558	prio => -1000000,
413	on_clone => sub {	559	on_clone => sub {
414	my ($src, $dst) = @_;	560	my ($src, $dst) = @_;
415		561
416	@{$dst->registry} = @{$src->registry};	562	@{$dst->registry} = @{$src->registry};
417	warn "registry clone ", join ":", @{$src->registry};#d#
418		563
419	%$dst = %$src;	564	%$dst = %$src;
420		565
421	$dst->{_attachment} = [@{ $src->{_attachment} }]	566	%{$dst->{_attachment}} = %{$src->{_attachment}}
422	if exists $src->{_attachment};	567	if exists $src->{_attachment};
423
424	warn "clone<@_>\n";#d#
425	},	568	},
426	;	569	;
427		570
428	#############################################################################	571	#############################################################################
429	# old plug-in events	572	# old plug-in events
…		…
501	. "#line 1 \"$path\"\n{\n"	644	. "#line 1 \"$path\"\n{\n"
502	. (do { local $/; <$fh> })	645	. (do { local $/; <$fh> })
503	. "\n};\n1";	646	. "\n};\n1";
504		647
505	eval $source	648	eval $source
506	or die "$path: $@";	649	or die $@ ? "$path: $@\n"
		650	: "extension disabled.\n";
507		651
508	push @exts, $pkg;	652	push @exts, $pkg;
509	$ext_pkg{$base} = $pkg;	653	$ext_pkg{$base} = $pkg;
510		654
511	# no strict 'refs';	655	# no strict 'refs';
…		…
562	load_extension $ext;	706	load_extension $ext;
563	1	707	1
564	} or warn "$ext not loaded: $@";	708	} or warn "$ext not loaded: $@";
565	}	709	}
566	}	710	}
567
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		711
641	#############################################################################	712	#############################################################################
642	# extcmd framework, basically convert ext <msg>	713	# extcmd framework, basically convert ext <msg>
643	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	714	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
644		715
…		…
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, 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	$_->cancel for Event::all_watchers;
		1091
		1092	# unload all extensions
		1093	for (@exts) {
		1094	$msg->("unloading <$_>");
		1095	unload_extension $_;
		1096	}
		1097
		1098	# unload all modules loaded from $LIBDIR
		1099	while (my ($k, $v) = each %INC) {
		1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		1101
		1102	$msg->("removing <$k>");
		1103	delete $INC{$k};
		1104
		1105	$k =~ s/\.pm$//;
		1106	$k =~ s/\//::/g;
		1107
		1108	if (my $cb = $k->can ("unload_module")) {
		1109	$cb->();
		1110	}
		1111
		1112	Symbol::delete_package $k;
		1113	}
		1114
		1115	# sync database to disk
		1116	cf::db_sync;
		1117
		1118	# get rid of safe::, as good as possible
		1119	Symbol::delete_package "safe::$_"
		1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
		1121
		1122	# remove register_script_function callbacks
		1123	# TODO
		1124
		1125	# unload cf.pm "a bit"
		1126	delete $INC{"cf.pm"};
		1127
		1128	# don't, removes xs symbols, too,
		1129	# and global variables created in xs
		1130	#Symbol::delete_package __PACKAGE__;
		1131
		1132	# reload cf.pm
		1133	$msg->("reloading cf.pm");
		1134	require cf;
		1135
		1136	# load config and database again
		1137	cf::cfg_load;
		1138	cf::db_load;
		1139
		1140	# load extensions
		1141	$msg->("load extensions");
		1142	cf::load_extensions;
		1143
		1144	# reattach attachments to objects
		1145	$msg->("reattach");
		1146	_global_reattach;
		1147	};
		1148	$msg->($@) if $@;
		1149
		1150	$msg->("reloaded");
		1151	};
		1152
		1153	sub perl_reload() {
		1154	_perl_reload {
		1155	warn $_[0];
		1156	print "$_[0]\n";
		1157	};
		1158	}
		1159
		1160	register_command "perl-reload", 0, sub {
		1161	my ($who, $arg) = @_;
		1162
		1163	if ($who->flag (FLAG_WIZ)) {
		1164	_perl_reload {
		1165	warn $_[0];
		1166	$who->message ($_[0]);
		1167	};
		1168	}
		1169	};
		1170
841	register "<global>", __PACKAGE__;	1171	register "<global>", __PACKAGE__;
842		1172
843	unshift @INC, $LIBDIR;	1173	unshift @INC, $LIBDIR;
844		1174
845	load_extensions;
846
847	$TICK_WATCHER = Event->timer (	1175	$TICK_WATCHER = Event->timer (
848	prio => 1,	1176	prio => 1,
		1177	async => 1,
849	at => $NEXT_TICK \|\| 1,	1178	at => $NEXT_TICK \|\| 1,
850	cb => sub {	1179	cb => sub {
851	cf::server_tick; # one server iteration	1180	cf::server_tick; # one server iteration
852		1181
853	my $NOW = Event::time;	1182	my $NOW = Event::time;
854	$NEXT_TICK += $TICK;	1183	$NEXT_TICK += $TICK;
855		1184
856	# if we are delayed by four ticks, skip them all	1185	# if we are delayed by four ticks or more, skip them all
857	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
858		1187
859	$TICK_WATCHER->at ($NEXT_TICK);	1188	$TICK_WATCHER->at ($NEXT_TICK);
860	$TICK_WATCHER->start;	1189	$TICK_WATCHER->start;
861	},	1190	},
862	);	1191	);
863		1192
		1193	IO::AIO::max_poll_time $TICK * 0.2;
		1194
		1195	Event->io (fd => IO::AIO::poll_fileno,
		1196	poll => 'r',
		1197	prio => 5,
		1198	cb => \&IO::AIO::poll_cb);
		1199
864	1	1200	1
865		1201

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.84 by root, Mon Dec 11 02:54:57 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.84 by root, Mon Dec 11 02:54:57 2006 UTC