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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs. Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.53 by root, Tue Aug 29 13:11:58 2006 UTC vs.
Revision 1.92 by root, Thu Dec 21 06:42:28 2006 UTC