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

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.88 by root, Fri Dec 15 19:29:18 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.88 by root, Fri Dec 15 19:29:18 2006 UTC