[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.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
		136	=item $object->detach ($attachment)
		137
112	Attach a pre-registered attachment to an object.	138	Attach/detach a pre-registered attachment to an object.
113		139
114	=item $player->attach ($attachment, key => $value...)	140	=item $player->attach ($attachment, key => $value...)
115		141
		142	=item $player->detach ($attachment)
		143
116	Attach a pre-registered attachment to a player.	144	Attach/detach a pre-registered attachment to a player.
117		145
118	=item $map->attach ($attachment, key => $value...) # not yet persistent	146	=item $map->attach ($attachment, key => $value...)
119		147
		148	=item $map->detach ($attachment)
		149
120	Attach 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.
121		159
122	=item cf::attach_global ...	160	=item cf::attach_global ...
123		161
124	Attach handlers for global events.	162	Attach handlers for global events.
125		163
…		…
173	=item cf::attach_to_maps ...	211	=item cf::attach_to_maps ...
174		212
175	Attach handlers to all maps.	213	Attach handlers to all maps.
176		214
177	=item cf:register_attachment $name, ...	215	=item cf:register_attachment $name, ...
		216
		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
		223	attachment.
		224
		225	=item cf:register_map_attachment $name, ...
		226
		227	Register an attachment by name through which maps can refer to this
		228	attachment.
178		229
179	=cut	230	=cut
180		231
181	# the following variables are defined in .xs and must not be re-created	232	# the following variables are defined in .xs and must not be re-created
182	our @CB_GLOBAL = (); # registry for all global events	233	our @CB_GLOBAL = (); # registry for all global events
…		…
247	}	298	}
248		299
249	sub _attach_attachment {	300	sub _attach_attachment {
250	my ($obj, $name, %arg) = @_;	301	my ($obj, $name, %arg) = @_;
251		302
		303	return if exists $obj->{_attachment}{$name};
		304
252	my $res;	305	my $res;
253		306
254	if (my $attach = $attachment{$name}) {	307	if (my $attach = $attachment{$name}) {
255	my $registry = $obj->registry;	308	my $registry = $obj->registry;
256		309
…		…
268		321
269	$res->{attachment} = $name;	322	$res->{attachment} = $name;
270	$res	323	$res
271	}	324	}
272		325
273	sub cf::object::attach {	326	*cf::object::attach =
		327	*cf::player::attach =
		328	*cf::map::attach = sub {
274	my ($obj, $name, %arg) = @_;	329	my ($obj, $name, %arg) = @_;
275		330
276	_attach_attachment $obj, $name, %arg;	331	_attach_attachment $obj, $name, %arg;
277	}	332	};
278		333
		334	# all those should be optimised
		335	*cf::object::detach =
279	sub cf::player::attach {	336	*cf::player::detach =
		337	*cf::map::detach = sub {
280	my ($obj, $name, %arg) = @_;	338	my ($obj, $name) = @_;
281		339
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	340	delete $obj->{_attachment}{$name};
283	}	341	reattach ($obj);
		342	};
284		343
285	sub cf::map::attach {	344	*cf::object::attached =
		345	*cf::player::attached =
		346	*cf::map::attached = sub {
286	my ($obj, $name, %arg) = @_;	347	my ($obj, $name) = @_;
287		348
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	349	exists $obj->{_attachment}{$name}
289	}	350	};
290		351
291	sub attach_global {	352	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_	353	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}	354	}
294		355
…		…
315	my $name = shift;	376	my $name = shift;
316		377
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	378	$attachment{$name} = [[KLASS_OBJECT, @_]];
318	}	379	}
319		380
		381	sub register_player_attachment {
		382	my $name = shift;
		383
		384	$attachment{$name} = [[KLASS_PLAYER, @_]];
		385	}
		386
		387	sub register_map_attachment {
		388	my $name = shift;
		389
		390	$attachment{$name} = [[KLASS_MAP, @_]];
		391	}
		392
320	our $override;	393	our $override;
321	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	394	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322		395
323	sub override {	396	sub override {
324	$override = 1;	397	$override = 1;
…		…
336	for (@$callbacks) {	409	for (@$callbacks) {
337	eval { &{$_->[1]} };	410	eval { &{$_->[1]} };
338		411
339	if ($@) {	412	if ($@) {
340	warn "$@";	413	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	414	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	415	override;
343	}	416	}
344		417
345	return 1 if $override;	418	return 1 if $override;
346	}	419	}
347		420
348	0	421	0
349	}	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;
350		463
351	#############################################################################	464	#############################################################################
352	# object support	465	# object support
353		466
354	sub instantiate {	467	sub instantiate {
…		…
383	}	496	}
384	}	497	}
385	}	498	}
386		499
387	sub object_freezer_save {	500	sub object_freezer_save {
388	my ($filename, $objs) = @_;	501	my ($filename, $rdata, $objs) = @_;
389		502
390	$filename .= ".pst";	503	if (length $$rdata) {
		504	warn sprintf "saving %s (%d,%d)\n",
		505	$filename, length $$rdata, scalar @$objs;
391		506
392	if (@$objs) {
393	open my $fh, ">:raw", "$filename~";	507	if (open my $fh, ">:raw", "$filename~") {
394	chmod $fh, SAVE_MODE;	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;
395	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };	514	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
396	close $fh;	515	close $fh;
		516	rename "$filename.pst~", "$filename.pst";
		517	} else {
		518	unlink "$filename.pst";
		519	}
		520
397	rename "$filename~", $filename;	521	rename "$filename~", $filename;
		522	} else {
		523	warn "FATAL: $filename~: $!\n";
		524	}
398	} else {	525	} else {
399	unlink $filename;	526	unlink $filename;
		527	unlink "$filename.pst";
400	}	528	}
		529	}
		530
		531	sub object_freezer_as_string {
		532	my ($rdata, $objs) = @_;
		533
		534	use Data::Dumper;
		535
		536	$$rdata . Dumper $objs
401	}	537	}
402		538
403	sub object_thawer_load {	539	sub object_thawer_load {
404	my ($filename) = @_;	540	my ($filename) = @_;
405		541
		542	local $/;
		543
		544	my $av;
		545
		546	#TODO: use sysread etc.
		547	if (open my $data, "<:raw:perlio", $filename) {
		548	$data = <$data>;
406	open my $fh, "<:raw:perlio", "$filename.pst"	549	if (open my $pst, "<:raw:perlio", "$filename.pst") {
407	or return;	550	$av = eval { (Storable::thaw <$pst>)->{objs} };
		551	}
		552	return ($data, $av);
		553	}
408		554
409	eval { local $/; (Storable::thaw <$fh>)->{objs} }	555	()
410	}	556	}
411		557
412	attach_to_objects	558	attach_to_objects
413	prio => -1000000,	559	prio => -1000000,
414	on_clone => sub {	560	on_clone => sub {
…		…
422	if exists $src->{_attachment};	568	if exists $src->{_attachment};
423	},	569	},
424	;	570	;
425		571
426	#############################################################################	572	#############################################################################
427	# old plug-in events	573	# command handling &c
428		574
429	sub inject_event {	575	=item cf::register_command $name => \&callback($ob,$args);
430	my $extension = shift;
431	my $event_code = shift;
432		576
433	my $cb = $hook[$event_code]{$extension}	577	Register a callback for execution when the client sends the user command
434	or return;	578	$name.
435		579
436	&$cb	580	=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		581
458	sub register_command {	582	sub register_command {
459	my ($name, $time, $cb) = @_;	583	my ($name, $cb) = @_;
460		584
461	my $caller = caller;	585	my $caller = caller;
462	#warn "registering command '$name/$time' to '$caller'";	586	#warn "registering command '$name/$time' to '$caller'";
463		587
464	push @{ $command{$name} }, [$time, $cb, $caller];	588	push @{ $COMMAND{$name} }, [$caller, $cb];
465	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
466	}	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
467		599
468	sub register_extcmd {	600	sub register_extcmd {
469	my ($name, $cb) = @_;	601	my ($name, $cb) = @_;
470		602
471	my $caller = caller;	603	my $caller = caller;
472	#warn "registering extcmd '$name' to '$caller'";	604	#warn "registering extcmd '$name' to '$caller'";
473		605
474	$extcmd{$name} = [$cb, $caller];	606	$EXTCMD{$name} = [$cb, $caller];
475	}	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	;
476		640
477	sub register {	641	sub register {
478	my ($base, $pkg) = @_;	642	my ($base, $pkg) = @_;
479		643
480	#TODO	644	#TODO
…		…
499	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
500	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
501	. "\n};\n1";	665	. "\n};\n1";
502		666
503	eval $source	667	eval $source
504	or die "$path: $@";	668	or die $@ ? "$path: $@\n"
		669	: "extension disabled.\n";
505		670
506	push @exts, $pkg;	671	push @exts, $pkg;
507	$ext_pkg{$base} = $pkg;	672	$ext_pkg{$base} = $pkg;
508		673
509	# no strict 'refs';	674	# no strict 'refs';
…		…
522	# for my $idx (0 .. $#PLUGIN_EVENT) {	687	# for my $idx (0 .. $#PLUGIN_EVENT) {
523	# delete $hook[$idx]{$pkg};	688	# delete $hook[$idx]{$pkg};
524	# }	689	# }
525		690
526	# remove commands	691	# remove commands
527	for my $name (keys %command) {	692	for my $name (keys %COMMAND) {
528	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	693	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
529		694
530	if (@cb) {	695	if (@cb) {
531	$command{$name} = \@cb;	696	$COMMAND{$name} = \@cb;
532	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
533	} else {	697	} else {
534	delete $command{$name};
535	delete $COMMAND{"$name\000"};	698	delete $COMMAND{$name};
536	}	699	}
537	}	700	}
538		701
539	# remove extcmds	702	# remove extcmds
540	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	703	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
541	delete $extcmd{$name};	704	delete $EXTCMD{$name};
542	}	705	}
543		706
544	if (my $cb = $pkg->can ("unload")) {	707	if (my $cb = $pkg->can ("unload")) {
545	eval {	708	eval {
546	$cb->($pkg);	709	$cb->($pkg);
…		…
561	1	724	1
562	} or warn "$ext not loaded: $@";	725	} or warn "$ext not loaded: $@";
563	}	726	}
564	}	727	}
565		728
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	#############################################################################	729	#############################################################################
664	# load/save/clean perl data associated with a map	730	# load/save/clean perl data associated with a map
665		731
666	*cf::mapsupport::on_clean = sub {	732	*cf::mapsupport::on_clean = sub {
667	my ($map) = @_;	733	my ($map) = @_;
668		734
669	my $path = $map->tmpname;	735	my $path = $map->tmpname;
670	defined $path or return;	736	defined $path or return;
671		737
672	unlink "$path.cfperl";
673	unlink "$path.pst";	738	unlink "$path.pst";
674	};	739	};
675		740
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::;	741	attach_to_maps prio => -10000, package => cf::mapsupport::;
696		742
697	#############################################################################	743	#############################################################################
698	# load/save perl data associated with player->ob objects	744	# load/save perl data associated with player->ob objects
699		745
700	sub all_objects(@) {	746	sub all_objects(@) {
701	@_, map all_objects ($_->inv), @_	747	@_, map all_objects ($_->inv), @_
702	}	748	}
703		749
		750	# TODO: compatibility cruft, remove when no longer needed
704	attach_to_players	751	attach_to_players
705	on_load => sub {	752	on_load => sub {
706	my ($pl, $path) = @_;	753	my ($pl, $path) = @_;
707		754
708	for my $o (all_objects $pl->ob) {	755	for my $o (all_objects $pl->ob) {
…		…
714	}	761	}
715	},	762	},
716	;	763	;
717		764
718	#############################################################################	765	#############################################################################
719	# core extensions - in perl	766
		767	=head2 CORE EXTENSIONS
		768
		769	Functions and methods that extend core crossfire objects.
		770
		771	=over 4
720		772
721	=item cf::player::exists $login	773	=item cf::player::exists $login
722		774
723	Returns true when the given account exists.	775	Returns true when the given account exists.
724		776
…		…
727	sub cf::player::exists($) {	779	sub cf::player::exists($) {
728	cf::player::find $_[0]	780	cf::player::find $_[0]
729	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;
730	}	782	}
731		783
732	=item $player->reply ($npc, $msg[, $flags])	784	=item $player_object->reply ($npc, $msg[, $flags])
733		785
734	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>
735	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
736	dialogue with the given NPC character.	788	dialogue with the given NPC character.
737		789
…		…
764	$msg{msgid} = $id;	816	$msg{msgid} = $id;
765		817
766	$self->send ("ext " . to_json \%msg);	818	$self->send ("ext " . to_json \%msg);
767	}	819	}
768		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
769	#############################################################################	839	#############################################################################
770	# 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
771		850
772	our $safe = new Safe "safe";	851	our $safe = new Safe "safe";
773	our $safe_hole = new Safe::Hole;	852	our $safe_hole = new Safe::Hole;
774		853
775	$SIG{FPE} = 'IGNORE';	854	$SIG{FPE} = 'IGNORE';
776		855
777	$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));
778		857
779	# 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
780		869
781	for (	870	for (
782	["cf::object" => qw(contr pay_amount pay_player)],	871	["cf::object" => qw(contr pay_amount pay_player)],
783	["cf::object::player" => qw(player)],	872	["cf::object::player" => qw(player)],
784	["cf::player" => qw(peaceful)],	873	["cf::player" => qw(peaceful)],
…		…
787	my ($pkg, @funs) = @$_;	876	my ($pkg, @funs) = @$_;
788	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
789	for @funs;	878	for @funs;
790	}	879	}
791		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
792	sub safe_eval($;@) {	893	sub safe_eval($;@) {
793	my ($code, %vars) = @_;	894	my ($code, %vars) = @_;
794		895
795	my $qcode = $code;	896	my $qcode = $code;
796	$qcode =~ s/"/‟/g; # not allowed in #line filenames	897	$qcode =~ s/"/‟/g; # not allowed in #line filenames
…		…
818	}	919	}
819		920
820	wantarray ? @res : $res[0]	921	wantarray ? @res : $res[0]
821	}	922	}
822		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
823	sub register_script_function {	939	sub register_script_function {
824	my ($fun, $cb) = @_;	940	my ($fun, $cb) = @_;
825		941
826	no strict 'refs';	942	no strict 'refs';
827	*{"safe::$fun"} = $safe_hole->wrap ($cb);	943	*{"safe::$fun"} = $safe_hole->wrap ($cb);
828	}	944	}
829		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
830	#############################################################################	1055	#############################################################################
831	# the server's main()	1056	# the server's main()
832		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
833	sub main {	1066	sub main {
		1067	cfg_load;
		1068	db_load;
		1069	load_extensions;
834	Event::loop;	1070	Event::loop;
835	}	1071	}
836		1072
837	#############################################################################	1073	#############################################################################
838	# initialisation	1074	# initialisation
839		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
840	register "<global>", __PACKAGE__;	1153	register "<global>", __PACKAGE__;
841		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
842	unshift @INC, $LIBDIR;	1166	unshift @INC, $LIBDIR;
843		1167
844	load_extensions;
845
846	$TICK_WATCHER = Event->timer (	1168	$TICK_WATCHER = Event->timer (
847	prio => 1,	1169	prio => 1,
		1170	async => 1,
848	at => $NEXT_TICK \|\| 1,	1171	at => $NEXT_TICK \|\| 1,
849	cb => sub {	1172	cb => sub {
850	cf::server_tick; # one server iteration	1173	cf::server_tick; # one server iteration
851		1174
852	my $NOW = Event::time;	1175	my $NOW = Event::time;
853	$NEXT_TICK += $TICK;	1176	$NEXT_TICK += $TICK;
854		1177
855	# if we are delayed by four ticks, skip them all	1178	# if we are delayed by four ticks or more, skip them all
856	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1179	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
857		1180
858	$TICK_WATCHER->at ($NEXT_TICK);	1181	$TICK_WATCHER->at ($NEXT_TICK);
859	$TICK_WATCHER->start;	1182	$TICK_WATCHER->start;
860	},	1183	},
861	);	1184	);
862		1185
863	_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);
864		1192
865	1	1193	1
866		1194

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