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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.48 by root, Sun Aug 27 15:24:22 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;
15		19
16	_reload_1;	20	_init_vars;
17		21
18	our %COMMAND = ();	22	our %COMMAND = ();
19	our @EVENT;	23	our @EVENT;
20	our %PROP_TYPE;
21	our %PROP_IDX;
22	our $LIBDIR = maps_directory "perl";	24	our $LIBDIR = maps_directory "perl";
23		25
24	our $TICK = MAX_TIME * 1e-6;	26	our $TICK = MAX_TIME * 1e-6;
25	our $TICK_WATCHER;	27	our $TICK_WATCHER;
26	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
27		55
28	BEGIN {	56	BEGIN {
29	*CORE::GLOBAL::warn = sub {	57	*CORE::GLOBAL::warn = sub {
30	my $msg = join "", @_;	58	my $msg = join "", @_;
31	$msg .= "\n"	59	$msg .= "\n"
…		…
34	print STDERR "cfperl: $msg";	62	print STDERR "cfperl: $msg";
35	LOG llevError, "cfperl: $msg";	63	LOG llevError, "cfperl: $msg";
36	};	64	};
37	}	65	}
38		66
39	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
41	# generate property mutators
42	sub prop_gen {
43	my ($prefix, $class) = @_;
44
45	no strict 'refs';
46
47	for my $prop (keys %PROP_TYPE) {
48	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
49	my $sub = lc $1;
50
51	my $type = $PROP_TYPE{$prop};
52	my $idx = $PROP_IDX {$prop};
53
54	{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
55	$_[0]->get_property ($type, $idx)
56	};
57
58	*{"$class\::set_$sub"} = sub {
59	$_[0]->set_property ($type, $idx, $_[1]);
60	} unless $ignore_set{$prop};
61	}
62	}
63
64	# auto-generate most of the API
65
66	prop_gen OBJECT_PROP => "cf::object";
67	# CFAPI_OBJECT_ANIMATION?
68	prop_gen PLAYER_PROP => "cf::object::player";
69
70	prop_gen MAP_PROP => "cf::map";
71	prop_gen ARCH_PROP => "cf::arch";
72
73	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	67	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74		68
75	# 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
76	# within the Safe compartment.	70	# within the Safe compartment.
77	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)) {
78	no strict 'refs';	72	no strict 'refs';
79	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	73	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80	}	74	}
81		75
82	$Event::DIED = sub {	76	$Event::DIED = sub {
…		…
87	my @exts;	81	my @exts;
88	my @hook;	82	my @hook;
89	my %command;	83	my %command;
90	my %extcmd;	84	my %extcmd;
91		85
92	#############################################################################	86	=head2 UTILITY FUNCTIONS
93	# utility functions	87
		88	=over 4
		89
		90	=cut
94		91
95	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
96		99
97	sub from_json($) {	100	sub from_json($) {
98	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	101	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99	JSON::Syck::Load $_[0]	102	JSON::Syck::Load $_[0]
100	}	103	}
101		104
		105	=item $json = cf::to_json $ref
		106
		107	Converts a perl data structure into its JSON representation.
		108
		109	=cut
		110
102	sub to_json($) {	111	sub to_json($) {
103	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	112	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104	JSON::Syck::Dump $_[0]	113	JSON::Syck::Dump $_[0]
105	}	114	}
106		115
		116	=back
		117
		118	=cut
		119
107	#############################################################################	120	#############################################################################
108	# "new" plug-in system	121
		122	=head2 EVENTS AND OBJECT ATTACHMENTS
		123
		124	=over 4
109		125
110	=item $object->attach ($attachment, key => $value...)	126	=item $object->attach ($attachment, key => $value...)
111		127
		128	=item $object->detach ($attachment)
		129
112	Attach a pre-registered attachment to an object.	130	Attach/detach a pre-registered attachment to an object.
113		131
114	=item $player->attach ($attachment, key => $value...)	132	=item $player->attach ($attachment, key => $value...)
115		133
		134	=item $player->detach ($attachment)
		135
116	Attach a pre-registered attachment to a player.	136	Attach/detach a pre-registered attachment to a player.
117		137
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	138	=item $map->attach ($attachment, key => $value...)
119		139
		140	=item $map->detach ($attachment)
		141
120	Attach a pre-registered attachment to a map.	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.
121		151
122	=item cf::attach_global ...	152	=item cf::attach_global ...
123		153
124	Attach handlers for global events.	154	Attach handlers for global events.
125		155
…		…
173	=item cf::attach_to_maps ...	203	=item cf::attach_to_maps ...
174		204
175	Attach handlers to all maps.	205	Attach handlers to all maps.
176		206
177	=item cf:register_attachment $name, ...	207	=item cf:register_attachment $name, ...
		208
		209	Register an attachment by name through which objects can refer to this
		210	attachment.
		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.
178		221
179	=cut	222	=cut
180		223
181	# 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
182	our @CB_GLOBAL = (); # registry for all global events	225	our @CB_GLOBAL = (); # registry for all global events
…		…
247	}	290	}
248		291
249	sub _attach_attachment {	292	sub _attach_attachment {
250	my ($obj, $name, %arg) = @_;	293	my ($obj, $name, %arg) = @_;
251		294
		295	return if exists $obj->{_attachment}{$name};
		296
252	my $res;	297	my $res;
253		298
254	if (my $attach = $attachment{$name}) {	299	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	300	my $registry = $obj->registry;
256		301
…		…
262	$obj->{$name} = \%arg;	307	$obj->{$name} = \%arg;
263	} else {	308	} else {
264	warn "object uses attachment '$name' that is not available, postponing.\n";	309	warn "object uses attachment '$name' that is not available, postponing.\n";
265	}	310	}
266		311
267	push @{$obj->{_attachment}}, $name;	312	$obj->{_attachment}{$name} = undef;
268		313
269	$res->{attachment} = $name;	314	$res->{attachment} = $name;
270	$res	315	$res
271	}	316	}
272		317
273	sub cf::object::attach {	318	*cf::object::attach =
		319	*cf::player::attach =
		320	*cf::map::attach = sub {
274	my ($obj, $name, %arg) = @_;	321	my ($obj, $name, %arg) = @_;
275		322
276	_attach_attachment $obj, $name, %arg;	323	_attach_attachment $obj, $name, %arg;
277	}	324	};
278		325
		326	# all those should be optimised
		327	*cf::object::detach =
279	sub cf::player::attach {	328	*cf::player::detach =
		329	*cf::map::detach = sub {
280	my ($obj, $name, %arg) = @_;	330	my ($obj, $name) = @_;
281		331
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	332	delete $obj->{_attachment}{$name};
283	}	333	reattach ($obj);
		334	};
284		335
285	sub cf::map::attach {	336	*cf::object::attached =
		337	*cf::player::attached =
		338	*cf::map::attached = sub {
286	my ($obj, $name, %arg) = @_;	339	my ($obj, $name) = @_;
287		340
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	341	exists $obj->{_attachment}{$name}
289	}	342	};
290		343
291	sub attach_global {	344	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	345	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}	346	}
294		347
…		…
315	my $name = shift;	368	my $name = shift;
316		369
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	370	$attachment{$name} = [[KLASS_OBJECT, @_]];
318	}	371	}
319		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
		382	$attachment{$name} = [[KLASS_MAP, @_]];
		383	}
		384
320	our $override;	385	our $override;
321	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?
322		387
323	sub override {	388	sub override {
324	$override = 1;	389	$override = 1;
…		…
336	for (@$callbacks) {	401	for (@$callbacks) {
337	eval { &{$_->[1]} };	402	eval { &{$_->[1]} };
338		403
339	if ($@) {	404	if ($@) {
340	warn "$@";	405	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	406	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	407	override;
343	}	408	}
344		409
345	return 1 if $override;	410	return 1 if $override;
346	}	411	}
347		412
348	0	413	0
349	}	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;
350		455
351	#############################################################################	456	#############################################################################
352	# object support	457	# object support
353		458
354	sub instantiate {	459	sub instantiate {
…		…
356		461
357	$data = from_json $data;	462	$data = from_json $data;
358		463
359	for (@$data) {	464	for (@$data) {
360	my ($name, $args) = @$_;	465	my ($name, $args) = @$_;
		466
361	attach $obj, $name, %{$args \|\| {} };	467	$obj->attach ($name, %{$args \|\| {} });
362	}	468	}
363	}	469	}
364		470
365	# basically do the same as instantiate, without calling instantiate	471	# basically do the same as instantiate, without calling instantiate
366	sub reattach {	472	sub reattach {
367	my ($obj) = @_;	473	my ($obj) = @_;
368	my $registry = $obj->registry;	474	my $registry = $obj->registry;
369		475
370	@$registry = ();	476	@$registry = ();
371		477
		478	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
		479
372	for my $name (@{ $obj->{_attachment} }) {	480	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
373	if (my $attach = $attachment{$name}) {	481	if (my $attach = $attachment{$name}) {
374	for (@$attach) {	482	for (@$attach) {
375	my ($klass, @attach) = @$_;	483	my ($klass, @attach) = @$_;
376	_attach @$registry, $klass, @attach;	484	_attach @$registry, $klass, @attach;
377	}	485	}
…		…
380	}	488	}
381	}	489	}
382	}	490	}
383		491
384	sub object_freezer_save {	492	sub object_freezer_save {
385	my ($filename, $objs) = @_;	493	my ($filename, $rdata, $objs) = @_;
386		494
387	$filename .= ".pst";	495	if (length $$rdata) {
		496	warn sprintf "saving %s (%d,%d)\n",
		497	$filename, length $$rdata, scalar @$objs;
388		498
389	if (@$objs) {
390	open my $fh, ">:raw", "$filename~";	499	if (open my $fh, ">:raw", "$filename~") {
391	chmod $fh, SAVE_MODE;	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;
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	506	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393	close $fh;	507	close $fh;
		508	rename "$filename.pst~", "$filename.pst";
		509	} else {
		510	unlink "$filename.pst";
		511	}
		512
394	rename "$filename~", $filename;	513	rename "$filename~", $filename;
		514	} else {
		515	warn "FATAL: $filename~: $!\n";
		516	}
395	} else {	517	} else {
396	unlink $filename;	518	unlink $filename;
		519	unlink "$filename.pst";
397	}	520	}
398	}	521	}
399		522
400	sub object_thawer_load {	523	sub object_thawer_load {
401	my ($filename) = @_;	524	my ($filename) = @_;
402		525
		526	local $/;
		527
		528	my $av;
		529
		530	#TODO: use sysread etc.
		531	if (open my $data, "<:raw:perlio", $filename) {
		532	$data = <$data>;
403	open my $fh, "<:raw:perlio", "$filename.pst"	533	if (open my $pst, "<:raw:perlio", "$filename.pst") {
404	or return;	534	$av = eval { (Storable::thaw <$pst>)->{objs} };
		535	}
		536	return ($data, $av);
		537	}
405		538
406	eval { local $/; (Storable::thaw <$fh>)->{objs} }	539	()
407	}	540	}
408		541
409	attach_to_objects	542	attach_to_objects
410	prio => -1000000,	543	prio => -1000000,
411	on_clone => sub {	544	on_clone => sub {
…		…
413		546
414	@{$dst->registry} = @{$src->registry};	547	@{$dst->registry} = @{$src->registry};
415		548
416	%$dst = %$src;	549	%$dst = %$src;
417		550
418	$dst->{_attachment} = [@{ $src->{_attachment} }]	551	%{$dst->{_attachment}} = %{$src->{_attachment}}
419	if exists $src->{_attachment};	552	if exists $src->{_attachment};
420	},	553	},
421	;	554	;
422		555
423	#############################################################################	556	#############################################################################
…		…
557	load_extension $ext;	690	load_extension $ext;
558	1	691	1
559	} or warn "$ext not loaded: $@";	692	} or warn "$ext not loaded: $@";
560	}	693	}
561	}	694	}
562
563	sub _perl_reload(&) {
564	my ($msg) = @_;
565
566	$msg->("reloading...");
567
568	eval {
569	# 1. cancel all watchers
570	$_->cancel for Event::all_watchers;
571
572	# 2. unload all extensions
573	for (@exts) {
574	$msg->("unloading <$_>");
575	unload_extension $_;
576	}
577
578	# 3. unload all modules loaded from $LIBDIR
579	while (my ($k, $v) = each %INC) {
580	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582	$msg->("removing <$k>");
583	delete $INC{$k};
584
585	$k =~ s/\.pm$//;
586	$k =~ s/\//::/g;
587
588	if (my $cb = $k->can ("unload_module")) {
589	$cb->();
590	}
591
592	Symbol::delete_package $k;
593	}
594
595	# 4. get rid of safe::, as good as possible
596	Symbol::delete_package "safe::$_"
597	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599	# 5. remove register_script_function callbacks
600	# TODO
601
602	# 6. unload cf.pm "a bit"
603	delete $INC{"cf.pm"};
604
605	# don't, removes xs symbols, too,
606	# and global variables created in xs
607	#Symbol::delete_package __PACKAGE__;
608
609	# 7. reload cf.pm
610	$msg->("reloading cf.pm");
611	require cf;
612	};
613	$msg->($@) if $@;
614
615	$msg->("reloaded");
616	};
617
618	sub perl_reload() {
619	_perl_reload {
620	warn $_[0];
621	print "$_[0]\n";
622	};
623	}
624
625	register_command "perl-reload", 0, sub {
626	my ($who, $arg) = @_;
627
628	if ($who->flag (FLAG_WIZ)) {
629	_perl_reload {
630	warn $_[0];
631	$who->message ($_[0]);
632	};
633	}
634	};
635		695
636	#############################################################################	696	#############################################################################
637	# extcmd framework, basically convert ext <msg>	697	# extcmd framework, basically convert ext <msg>
638	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few	698	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639		699
…		…
664	my ($map) = @_;	724	my ($map) = @_;
665		725
666	my $path = $map->tmpname;	726	my $path = $map->tmpname;
667	defined $path or return;	727	defined $path or return;
668		728
669	unlink "$path.cfperl";
670	unlink "$path.pst";	729	unlink "$path.pst";
671	};	730	};
672		731
673	*cf::mapsupport::on_swapin =
674	*cf::mapsupport::on_load = sub {
675	my ($map) = @_;
676
677	my $path = $map->tmpname;
678	$path = $map->path unless defined $path;
679
680	open my $fh, "<:raw", "$path.cfperl"
681	or return; # no perl data
682
683	my $data = Storable::thaw do { local $/; <$fh> };
684
685	$data->{version} <= 1
686	or return; # too new
687
688	$map->_set_obs ($data->{obs});
689	};
690
691	attach_to_maps prio => -10000, package => cf::mapsupport::;	732	attach_to_maps prio => -10000, package => cf::mapsupport::;
692		733
693	#############################################################################	734	#############################################################################
694	# load/save perl data associated with player->ob objects	735	# load/save perl data associated with player->ob objects
695		736
696	sub all_objects(@) {	737	sub all_objects(@) {
697	@_, map all_objects ($_->inv), @_	738	@_, map all_objects ($_->inv), @_
698	}	739	}
699		740
		741	# TODO: compatibility cruft, remove when no longer needed
700	attach_to_players	742	attach_to_players
701	on_load => sub {	743	on_load => sub {
702	my ($pl, $path) = @_;	744	my ($pl, $path) = @_;
703		745
704	for my $o (all_objects $pl->ob) {	746	for my $o (all_objects $pl->ob) {
…		…
710	}	752	}
711	},	753	},
712	;	754	;
713		755
714	#############################################################################	756	#############################################################################
715	# core extensions - in perl	757
		758	=head2 CORE EXTENSIONS
		759
		760	Functions and methods that extend core crossfire objects.
		761
		762	=over 4
716		763
717	=item cf::player::exists $login	764	=item cf::player::exists $login
718		765
719	Returns true when the given account exists.	766	Returns true when the given account exists.
720		767
…		…
723	sub cf::player::exists($) {	770	sub cf::player::exists($) {
724	cf::player::find $_[0]	771	cf::player::find $_[0]
725	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;
726	}	773	}
727		774
728	=item $player->reply ($npc, $msg[, $flags])	775	=item $object->reply ($npc, $msg[, $flags])
729		776
730	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>
731	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
732	dialogue with the given NPC character.	779	dialogue with the given NPC character.
733		780
…		…
760	$msg{msgid} = $id;	807	$msg{msgid} = $id;
761		808
762	$self->send ("ext " . to_json \%msg);	809	$self->send ("ext " . to_json \%msg);
763	}	810	}
764		811
		812	=back
		813
		814	=cut
		815
765	#############################################################################	816	#############################################################################
766	# 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
767		827
768	our $safe = new Safe "safe";	828	our $safe = new Safe "safe";
769	our $safe_hole = new Safe::Hole;	829	our $safe_hole = new Safe::Hole;
770		830
771	$SIG{FPE} = 'IGNORE';	831	$SIG{FPE} = 'IGNORE';
772		832
773	$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));
774		834
775	# 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
776		846
777	for (	847	for (
778	["cf::object" => qw(contr pay_amount pay_player)],	848	["cf::object" => qw(contr pay_amount pay_player)],
779	["cf::object::player" => qw(player)],	849	["cf::object::player" => qw(player)],
780	["cf::player" => qw(peaceful)],	850	["cf::player" => qw(peaceful)],
…		…
783	my ($pkg, @funs) = @$_;	853	my ($pkg, @funs) = @$_;
784	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	854	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785	for @funs;	855	for @funs;
786	}	856	}
787		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
788	sub safe_eval($;@) {	870	sub safe_eval($;@) {
789	my ($code, %vars) = @_;	871	my ($code, %vars) = @_;
790		872
791	my $qcode = $code;	873	my $qcode = $code;
792	$qcode =~ s/"/‟/g; # not allowed in #line filenames	874	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
814	}	896	}
815		897
816	wantarray ? @res : $res[0]	898	wantarray ? @res : $res[0]
817	}	899	}
818		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
819	sub register_script_function {	916	sub register_script_function {
820	my ($fun, $cb) = @_;	917	my ($fun, $cb) = @_;
821		918
822	no strict 'refs';	919	no strict 'refs';
823	*{"safe::$fun"} = $safe_hole->wrap ($cb);	920	*{"safe::$fun"} = $safe_hole->wrap ($cb);
824	}	921	}
825		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
826	#############################################################################	1031	#############################################################################
827	# the server's main()	1032	# the server's main()
828		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
829	sub main {	1042	sub main {
		1043	cfg_load;
		1044	db_load;
		1045	load_extensions;
830	Event::loop;	1046	Event::loop;
831	}	1047	}
832		1048
833	#############################################################################	1049	#############################################################################
834	# initialisation	1050	# initialisation
835		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
836	register "<global>", __PACKAGE__;	1140	register "<global>", __PACKAGE__;
837		1141
838	unshift @INC, $LIBDIR;	1142	unshift @INC, $LIBDIR;
839
840	load_extensions;
841		1143
842	$TICK_WATCHER = Event->timer (	1144	$TICK_WATCHER = Event->timer (
843	prio => 1,	1145	prio => 1,
844	at => $NEXT_TICK \|\| 1,	1146	at => $NEXT_TICK \|\| 1,
845	cb => sub {	1147	cb => sub {
…		…
854	$TICK_WATCHER->at ($NEXT_TICK);	1156	$TICK_WATCHER->at ($NEXT_TICK);
855	$TICK_WATCHER->start;	1157	$TICK_WATCHER->start;
856	},	1158	},
857	);	1159	);
858		1160
859	_reload_2;
860
861	1	1161	1
862		1162

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.48 by root, Sun Aug 27 15:24:22 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.48 by root, Sun Aug 27 15:24:22 2006 UTC vs.
Revision 1.75 by root, Mon Oct 2 00:22:01 2006 UTC