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

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.77 by root, Sun Nov 5 11:13: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.77 by root, Sun Nov 5 11:13:01 2006 UTC