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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.50 by root, Mon Aug 28 07:07:42 2006 UTC vs.
Revision 1.89 by root, Fri Dec 15 19:59:20 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
		143	=item $object->detach ($attachment)
		144
112	Attach a pre-registered attachment to an object.	145	Attach/detach a pre-registered attachment to an object.
113		146
114	=item $player->attach ($attachment, key => $value...)	147	=item $player->attach ($attachment, key => $value...)
115		148
		149	=item $player->detach ($attachment)
		150
116	Attach a pre-registered attachment to a player.	151	Attach/detach a pre-registered attachment to a player.
117		152
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	153	=item $map->attach ($attachment, key => $value...)
119		154
		155	=item $map->detach ($attachment)
		156
120	Attach 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.
121		166
122	=item cf::attach_global ...	167	=item cf::attach_global ...
123		168
124	Attach handlers for global events.	169	Attach handlers for global events.
125		170
…		…
173	=item cf::attach_to_maps ...	218	=item cf::attach_to_maps ...
174		219
175	Attach handlers to all maps.	220	Attach handlers to all maps.
176		221
177	=item cf:register_attachment $name, ...	222	=item cf:register_attachment $name, ...
		223
		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
		230	attachment.
		231
		232	=item cf:register_map_attachment $name, ...
		233
		234	Register an attachment by name through which maps can refer to this
		235	attachment.
178		236
179	=cut	237	=cut
180		238
181	# the following variables are defined in .xs and must not be re-created	239	# the following variables are defined in .xs and must not be re-created
182	our @CB_GLOBAL = (); # registry for all global events	240	our @CB_GLOBAL = (); # registry for all global events
…		…
247	}	305	}
248		306
249	sub _attach_attachment {	307	sub _attach_attachment {
250	my ($obj, $name, %arg) = @_;	308	my ($obj, $name, %arg) = @_;
251		309
		310	return if exists $obj->{_attachment}{$name};
		311
252	my $res;	312	my $res;
253		313
254	if (my $attach = $attachment{$name}) {	314	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	315	my $registry = $obj->registry;
256		316
…		…
268		328
269	$res->{attachment} = $name;	329	$res->{attachment} = $name;
270	$res	330	$res
271	}	331	}
272		332
273	sub cf::object::attach {	333	*cf::object::attach =
		334	*cf::player::attach =
		335	*cf::map::attach = sub {
274	my ($obj, $name, %arg) = @_;	336	my ($obj, $name, %arg) = @_;
275		337
276	_attach_attachment $obj, $name, %arg;	338	_attach_attachment $obj, $name, %arg;
277	}	339	};
278		340
		341	# all those should be optimised
		342	*cf::object::detach =
279	sub cf::player::attach {	343	*cf::player::detach =
		344	*cf::map::detach = sub {
280	my ($obj, $name, %arg) = @_;	345	my ($obj, $name) = @_;
281		346
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	347	delete $obj->{_attachment}{$name};
283	}	348	reattach ($obj);
		349	};
284		350
285	sub cf::map::attach {	351	*cf::object::attached =
		352	*cf::player::attached =
		353	*cf::map::attached = sub {
286	my ($obj, $name, %arg) = @_;	354	my ($obj, $name) = @_;
287		355
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	356	exists $obj->{_attachment}{$name}
289	}	357	};
290		358
291	sub attach_global {	359	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	360	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}	361	}
294		362
…		…
315	my $name = shift;	383	my $name = shift;
316		384
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	385	$attachment{$name} = [[KLASS_OBJECT, @_]];
318	}	386	}
319		387
		388	sub register_player_attachment {
		389	my $name = shift;
		390
		391	$attachment{$name} = [[KLASS_PLAYER, @_]];
		392	}
		393
		394	sub register_map_attachment {
		395	my $name = shift;
		396
		397	$attachment{$name} = [[KLASS_MAP, @_]];
		398	}
		399
320	our $override;	400	our $override;
321	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	401	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322		402
323	sub override {	403	sub override {
324	$override = 1;	404	$override = 1;
…		…
336	for (@$callbacks) {	416	for (@$callbacks) {
337	eval { &{$_->[1]} };	417	eval { &{$_->[1]} };
338		418
339	if ($@) {	419	if ($@) {
340	warn "$@";	420	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	421	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	422	override;
343	}	423	}
344		424
345	return 1 if $override;	425	return 1 if $override;
346	}	426	}
347		427
348	0	428	0
349	}	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;
350		470
351	#############################################################################	471	#############################################################################
352	# object support	472	# object support
353		473
354	sub instantiate {	474	sub instantiate {
…		…
383	}	503	}
384	}	504	}
385	}	505	}
386		506
387	sub object_freezer_save {	507	sub object_freezer_save {
388	my ($filename, $objs) = @_;	508	my ($filename, $rdata, $objs) = @_;
389		509
390	$filename .= ".pst";	510	if (length $$rdata) {
		511	warn sprintf "saving %s (%d,%d)\n",
		512	$filename, length $$rdata, scalar @$objs;
391		513
392	if (@$objs) {
393	open my $fh, ">:raw", "$filename~";	514	if (open my $fh, ">:raw", "$filename~") {
394	chmod $fh, SAVE_MODE;	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;
395	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	521	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
396	close $fh;	522	close $fh;
		523	rename "$filename.pst~", "$filename.pst";
		524	} else {
		525	unlink "$filename.pst";
		526	}
		527
397	rename "$filename~", $filename;	528	rename "$filename~", $filename;
		529	} else {
		530	warn "FATAL: $filename~: $!\n";
		531	}
398	} else {	532	} else {
399	unlink $filename;	533	unlink $filename;
		534	unlink "$filename.pst";
400	}	535	}
		536	}
		537
		538	sub object_freezer_as_string {
		539	my ($rdata, $objs) = @_;
		540
		541	use Data::Dumper;
		542
		543	$$rdata . Dumper $objs
401	}	544	}
402		545
403	sub object_thawer_load {	546	sub object_thawer_load {
404	my ($filename) = @_;	547	my ($filename) = @_;
405		548
		549	local $/;
		550
		551	my $av;
		552
		553	#TODO: use sysread etc.
		554	if (open my $data, "<:raw:perlio", $filename) {
		555	$data = <$data>;
406	open my $fh, "<:raw:perlio", "$filename.pst"	556	if (open my $pst, "<:raw:perlio", "$filename.pst") {
407	or return;	557	$av = eval { (Storable::thaw <$pst>)->{objs} };
		558	}
		559	return ($data, $av);
		560	}
408		561
409	eval { local $/; (Storable::thaw <$fh>)->{objs} }	562	()
410	}	563	}
411		564
412	attach_to_objects	565	attach_to_objects
413	prio => -1000000,	566	prio => -1000000,
414	on_clone => sub {	567	on_clone => sub {
…		…
422	if exists $src->{_attachment};	575	if exists $src->{_attachment};
423	},	576	},
424	;	577	;
425		578
426	#############################################################################	579	#############################################################################
427	# old plug-in events	580	# command handling &c
428		581
429	sub inject_event {	582	=item cf::register_command $name => \&callback($ob,$args);
430	my $extension = shift;
431	my $event_code = shift;
432		583
433	my $cb = $hook[$event_code]{$extension}	584	Register a callback for execution when the client sends the user command
434	or return;	585	$name.
435		586
436	&$cb	587	=cut
437	}
438
439	sub inject_global_event {
440	my $event = shift;
441
442	my $cb = $hook[$event]
443	or return;
444
445	List::Util::max map &$_, values %$cb
446	}
447
448	sub inject_command {
449	my ($name, $obj, $params) = @_;
450
451	for my $cmd (@{ $command{$name} }) {
452	$cmd->[1]->($obj, $params);
453	}
454
455	-1
456	}
457		588
458	sub register_command {	589	sub register_command {
459	my ($name, $time, $cb) = @_;	590	my ($name, $cb) = @_;
460		591
461	my $caller = caller;	592	my $caller = caller;
462	#warn "registering command '$name/$time' to '$caller'";	593	#warn "registering command '$name/$time' to '$caller'";
463		594
464	push @{ $command{$name} }, [$time, $cb, $caller];	595	push @{ $COMMAND{$name} }, [$caller, $cb];
465	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
466	}	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
467		606
468	sub register_extcmd {	607	sub register_extcmd {
469	my ($name, $cb) = @_;	608	my ($name, $cb) = @_;
470		609
471	my $caller = caller;	610	my $caller = caller;
472	#warn "registering extcmd '$name' to '$caller'";	611	#warn "registering extcmd '$name' to '$caller'";
473		612
474	$extcmd{$name} = [$cb, $caller];	613	$EXTCMD{$name} = [$cb, $caller];
475	}	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	;
476		647
477	sub register {	648	sub register {
478	my ($base, $pkg) = @_;	649	my ($base, $pkg) = @_;
479		650
480	#TODO	651	#TODO
…		…
499	. "#line 1 \"$path\"\n{\n"	670	. "#line 1 \"$path\"\n{\n"
500	. (do { local $/; <$fh> })	671	. (do { local $/; <$fh> })
501	. "\n};\n1";	672	. "\n};\n1";
502		673
503	eval $source	674	eval $source
504	or die "$path: $@";	675	or die $@ ? "$path: $@\n"
		676	: "extension disabled.\n";
505		677
506	push @exts, $pkg;	678	push @exts, $pkg;
507	$ext_pkg{$base} = $pkg;	679	$ext_pkg{$base} = $pkg;
508		680
509	# no strict 'refs';	681	# no strict 'refs';
…		…
522	# for my $idx (0 .. $#PLUGIN_EVENT) {	694	# for my $idx (0 .. $#PLUGIN_EVENT) {
523	# delete $hook[$idx]{$pkg};	695	# delete $hook[$idx]{$pkg};
524	# }	696	# }
525		697
526	# remove commands	698	# remove commands
527	for my $name (keys %command) {	699	for my $name (keys %COMMAND) {
528	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	700	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
529		701
530	if (@cb) {	702	if (@cb) {
531	$command{$name} = \@cb;	703	$COMMAND{$name} = \@cb;
532	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
533	} else {	704	} else {
534	delete $command{$name};
535	delete $COMMAND{"$name\000"};	705	delete $COMMAND{$name};
536	}	706	}
537	}	707	}
538		708
539	# remove extcmds	709	# remove extcmds
540	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	710	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
541	delete $extcmd{$name};	711	delete $EXTCMD{$name};
542	}	712	}
543		713
544	if (my $cb = $pkg->can ("unload")) {	714	if (my $cb = $pkg->can ("unload")) {
545	eval {	715	eval {
546	$cb->($pkg);	716	$cb->($pkg);
…		…
550		720
551	Symbol::delete_package $pkg;	721	Symbol::delete_package $pkg;
552	}	722	}
553		723
554	sub load_extensions {	724	sub load_extensions {
555	my $LIBDIR = maps_directory "perl";
556
557	for my $ext (<$LIBDIR/*.ext>) {	725	for my $ext (<$LIBDIR/*.ext>) {
558	next unless -r $ext;	726	next unless -r $ext;
559	eval {	727	eval {
560	load_extension $ext;	728	load_extension $ext;
561	1	729	1
562	} or warn "$ext not loaded: $@";	730	} or warn "$ext not loaded: $@";
563	}	731	}
564	}	732	}
565		733
566	sub _perl_reload(&) {
567	my ($msg) = @_;
568
569	$msg->("reloading...");
570
571	eval {
572	# 1. cancel all watchers
573	$_->cancel for Event::all_watchers;
574
575	# 2. unload all extensions
576	for (@exts) {
577	$msg->("unloading <$_>");
578	unload_extension $_;
579	}
580
581	# 3. unload all modules loaded from $LIBDIR
582	while (my ($k, $v) = each %INC) {
583	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
584
585	$msg->("removing <$k>");
586	delete $INC{$k};
587
588	$k =~ s/\.pm$//;
589	$k =~ s/\//::/g;
590
591	if (my $cb = $k->can ("unload_module")) {
592	$cb->();
593	}
594
595	Symbol::delete_package $k;
596	}
597
598	# 4. get rid of safe::, as good as possible
599	Symbol::delete_package "safe::$_"
600	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
601
602	# 5. remove register_script_function callbacks
603	# TODO
604
605	# 6. unload cf.pm "a bit"
606	delete $INC{"cf.pm"};
607
608	# don't, removes xs symbols, too,
609	# and global variables created in xs
610	#Symbol::delete_package __PACKAGE__;
611
612	# 7. reload cf.pm
613	$msg->("reloading cf.pm");
614	require cf;
615	};
616	$msg->($@) if $@;
617
618	$msg->("reloaded");
619	};
620
621	sub perl_reload() {
622	_perl_reload {
623	warn $_[0];
624	print "$_[0]\n";
625	};
626	}
627
628	register_command "perl-reload", 0, sub {
629	my ($who, $arg) = @_;
630
631	if ($who->flag (FLAG_WIZ)) {
632	_perl_reload {
633	warn $_[0];
634	$who->message ($_[0]);
635	};
636	}
637	};
638
639	#############################################################################
640	# extcmd framework, basically convert ext <msg>
641	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
642
643	attach_to_players
644	on_extcmd => sub {
645	my ($pl, $buf) = @_;
646
647	my $msg = eval { from_json $buf };
648
649	if (ref $msg) {
650	if (my $cb = $extcmd{$msg->{msgtype}}) {
651	if (my %reply = $cb->[0]->($pl, $msg)) {
652	$pl->ext_reply ($msg->{msgid}, %reply);
653	}
654	}
655	} else {
656	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
657	}
658
659	cf::override;
660	},
661	;
662
663	#############################################################################	734	#############################################################################
664	# load/save/clean perl data associated with a map	735	# load/save/clean perl data associated with a map
665		736
666	*cf::mapsupport::on_clean = sub {	737	*cf::mapsupport::on_clean = sub {
667	my ($map) = @_;	738	my ($map) = @_;
668		739
669	my $path = $map->tmpname;	740	my $path = $map->tmpname;
670	defined $path or return;	741	defined $path or return;
671		742
672	unlink "$path.cfperl";
673	unlink "$path.pst";	743	unlink "$path.pst";
674	};	744	};
675		745
676	*cf::mapsupport::on_swapin =
677	*cf::mapsupport::on_load = sub {
678	my ($map) = @_;
679
680	my $path = $map->tmpname;
681	$path = $map->path unless defined $path;
682
683	open my $fh, "<:raw", "$path.cfperl"
684	or return; # no perl data
685
686	my $data = Storable::thaw do { local $/; <$fh> };
687
688	$data->{version} <= 1
689	or return; # too new
690
691	$map->_set_obs ($data->{obs});
692	$map->invoke (EVENT_MAP_UPGRADE);
693	};
694
695	attach_to_maps prio => -10000, package => cf::mapsupport::;	746	attach_to_maps prio => -10000, package => cf::mapsupport::;
696		747
697	#############################################################################	748	#############################################################################
698	# load/save perl data associated with player->ob objects	749	# load/save perl data associated with player->ob objects
699		750
700	sub all_objects(@) {	751	sub all_objects(@) {
701	@_, map all_objects ($_->inv), @_	752	@_, map all_objects ($_->inv), @_
702	}	753	}
703		754
		755	# TODO: compatibility cruft, remove when no longer needed
704	attach_to_players	756	attach_to_players
705	on_load => sub {	757	on_load => sub {
706	my ($pl, $path) = @_;	758	my ($pl, $path) = @_;
707		759
708	for my $o (all_objects $pl->ob) {	760	for my $o (all_objects $pl->ob) {
…		…
714	}	766	}
715	},	767	},
716	;	768	;
717		769
718	#############################################################################	770	#############################################################################
719	# core extensions - in perl	771
		772	=head2 CORE EXTENSIONS
		773
		774	Functions and methods that extend core crossfire objects.
		775
		776	=over 4
720		777
721	=item cf::player::exists $login	778	=item cf::player::exists $login
722		779
723	Returns true when the given account exists.	780	Returns true when the given account exists.
724		781
…		…
727	sub cf::player::exists($) {	784	sub cf::player::exists($) {
728	cf::player::find $_[0]	785	cf::player::find $_[0]
729	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;
730	}	787	}
731		788
732	=item $player->reply ($npc, $msg[, $flags])	789	=item $player_object->reply ($npc, $msg[, $flags])
733		790
734	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>
735	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
736	dialogue with the given NPC character.	793	dialogue with the given NPC character.
737		794
…		…
764	$msg{msgid} = $id;	821	$msg{msgid} = $id;
765		822
766	$self->send ("ext " . to_json \%msg);	823	$self->send ("ext " . to_json \%msg);
767	}	824	}
768		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
769	#############################################################################	844	#############################################################################
770	# 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
771		855
772	our $safe = new Safe "safe";	856	our $safe = new Safe "safe";
773	our $safe_hole = new Safe::Hole;	857	our $safe_hole = new Safe::Hole;
774		858
775	$SIG{FPE} = 'IGNORE';	859	$SIG{FPE} = 'IGNORE';
776		860
777	$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));
778		862
779	# 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
780		874
781	for (	875	for (
782	["cf::object" => qw(contr pay_amount pay_player)],	876	["cf::object" => qw(contr pay_amount pay_player)],
783	["cf::object::player" => qw(player)],	877	["cf::object::player" => qw(player)],
784	["cf::player" => qw(peaceful)],	878	["cf::player" => qw(peaceful)],
…		…
787	my ($pkg, @funs) = @$_;	881	my ($pkg, @funs) = @$_;
788	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	882	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
789	for @funs;	883	for @funs;
790	}	884	}
791		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
792	sub safe_eval($;@) {	898	sub safe_eval($;@) {
793	my ($code, %vars) = @_;	899	my ($code, %vars) = @_;
794		900
795	my $qcode = $code;	901	my $qcode = $code;
796	$qcode =~ s/"/‟/g; # not allowed in #line filenames	902	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
818	}	924	}
819		925
820	wantarray ? @res : $res[0]	926	wantarray ? @res : $res[0]
821	}	927	}
822		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
823	sub register_script_function {	944	sub register_script_function {
824	my ($fun, $cb) = @_;	945	my ($fun, $cb) = @_;
825		946
826	no strict 'refs';	947	no strict 'refs';
827	*{"safe::$fun"} = $safe_hole->wrap ($cb);	948	*{"safe::$fun"} = $safe_hole->wrap ($cb);
828	}	949	}
829		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
830	#############################################################################	1060	#############################################################################
831	# the server's main()	1061	# the server's main()
832		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
833	sub main {	1071	sub main {
		1072	cfg_load;
		1073	db_load;
		1074	load_extensions;
834	Event::loop;	1075	Event::loop;
835	}	1076	}
836		1077
837	#############################################################################	1078	#############################################################################
838	# initialisation	1079	# initialisation
839		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
840	register "<global>", __PACKAGE__;	1160	register "<global>", __PACKAGE__;
841		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
842	unshift @INC, $LIBDIR;	1173	unshift @INC, $LIBDIR;
843		1174
844	load_extensions;
845
846	$TICK_WATCHER = Event->timer (	1175	$TICK_WATCHER = Event->timer (
847	prio => 1,	1176	prio => 1,
		1177	async => 1,
848	at => $NEXT_TICK \|\| 1,	1178	at => $NEXT_TICK \|\| 1,
		1179	data => WF_AUTOCANCEL,
849	cb => sub {	1180	cb => sub {
850	cf::server_tick; # one server iteration	1181	cf::server_tick; # one server iteration
851		1182
852	my $NOW = Event::time;	1183	my $NOW = Event::time;
853	$NEXT_TICK += $TICK;	1184	$NEXT_TICK += $TICK;
854		1185
855	# if we are delayed by four ticks, skip them all	1186	# if we are delayed by four ticks or more, skip them all
856	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1187	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
857		1188
858	$TICK_WATCHER->at ($NEXT_TICK);	1189	$TICK_WATCHER->at ($NEXT_TICK);
859	$TICK_WATCHER->start;	1190	$TICK_WATCHER->start;
860	},	1191	},
861	);	1192	);
862		1193
863	_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);
864		1201
865	1	1202	1
866		1203

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.50 by root, Mon Aug 28 07:07:42 2006 UTC vs. Revision 1.89 by root, Fri Dec 15 19:59:20 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.50 by root, Mon Aug 28 07:07:42 2006 UTC vs.
Revision 1.89 by root, Fri Dec 15 19:59:20 2006 UTC