[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.85 by root, Mon Dec 11 22:56:57 2006 UTC

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

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.85 by root, Mon Dec 11 22:56:57 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.85 by root, Mon Dec 11 22:56:57 2006 UTC