ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/ActiveDoc/ActiveDoc.pm

Comparing COMP/SCRAM/src/ActiveDoc/ActiveDoc.pm (file contents):
Revision 1.17 by williamc, Thu Jan 20 18:47:41 2000 UTC vs.
Revision 1.25.2.1.2.3 by williamc, Mon Aug 21 15:32:21 2000 UTC

#	Line 7 | Line 7
7		#
8		# Interface
9		# ---------
10	<	# new(ActiveConfig[,options])           : A new ActiveDoc object
10	>	# new(cache,dbstore)            : A new ActiveDoc object
11		# url()         : Return/set the docs url - essential
12		# file()        : Return the local filename of document
13	+	# ProcessFile() : Return the filename of PreProcessed document
14		#
15	<	# parse(parselabel): Parse the document file for the given parse level
15	<	# newparse(parselabel) : Create a new parse type
16	<	# addtag(parselabel,tagname,start,obj,text,obj,end,obj)
17	<	#                               : Add tags to the parse given by label
18	<	# checktag(tagname, hashref, param) : check for existence of param in
19	<	#                                       hashref from a tag call
20	<	# includeparse(local_parsename, objparsename, activedoc) : copy the parse from
21	<	#                                                       one object to another
22	<	# currentparsename([name]) : get/set current parse name
23	<	# newdoc(file)  : Return an new object of the appropriate type
15	>	# parent()         : return the object ref of the calling parent
16		# getfile(url)  : get a processedfile object given a url
17		# activatedoc(url) : Return the object ref for a doc described by the given url
26	–	#                    -- any parse called "init" will also be run
27	–	# config([ActiveConfig]) : Set up/return Configuration for the document
28	–	# basequery([ActiveConfig]) : Set up/return UserQuery for the doc
29	–	# copydocconfig(ActiveDoc) : Copy the basic configuration from the ActiveDoc
30	–	# copydocquery(ActiveDoc) : Copy the basicquery from the ActiveDoc
31	–	# userinterface()       : Return the defaullt userinterface
32	–	# option(var)           : return the value of the option var
33	–	# requestoption("message") : Ask the user to supply a value for an option
34	–	#                            if it dosnt already exist
18		#
19		# -- error methods --
20		# error(string)       : Report an general error to the user
21		# parseerror(string)  : Report an error during parsing a file
22	<	# line()              : Return the current line number of the document
23	<	#                       and the ProcessedFileObj it is in
22	>	# line([linenumber])     : Return the line number of the document
23	>	#                       and the ProcessedFileObj it is in corresponding to the
24	>	#                       supplied number of the expanded document
25	>	#                       If no number supplied - the currentparse number will be #                       used
26
27		package ActiveDoc::ActiveDoc;
28		require 5.004;
29	<	use ActiveDoc::Parse;
45	<	use ActiveDoc::ActiveConfig;
29	>	use ActiveDoc::SimpleURLDoc;
30		use ActiveDoc::PreProcessedFile;
31	<	use ObjectUtilities::StorableObject;
48	<	use URL::URLhandler;
31	>	use Utilities::Verbose;
32
33	<	@ISA = qw(ObjectUtilities::StorableObject);
33	>	@ISA = qw(ActiveDoc::SimpleURLDoc Utilities::Verbose);
34
35		sub new {
36		my $class=shift;
37	<	$self={};
37	>	my $self={};
38		bless $self, $class;
39	<	$self->config(shift);
40	<
41	<	# have some override options been passed
42	<	if ( @_ ) {
60	<	$self->basequery(shift);
61	<	}
62	<	else {
63	<	# --- is there a starter document?
64	<	my $basedoc=$self->config()->basedoc();
65	<	if ( defined $basedoc ) {
66	<	$self->copydocquery($basedoc);
67	<	}
68	<	else {
69	<	$self->error("Error : No base doc found");
70	<	}
71	<	}
72	<	$self->_init2();
73	<	}
74	<
75	<	sub _init2 {
76	<
77	<	my $self=shift;
78	<	# A URL handler per document
79	<	$self->{urlhandler}=URL::URLhandler->new($self->config()->cache());
80	<
81	<	# A default UserInterface
82	<	$self->{userinterface}=ActiveDoc::SimpleUserInterface->new();
83	<	$self->init(@_);
39	>	$self->cache(shift);
40	>	$self->{dbstore}=shift;
41	>	$self->_initdoc(@_);
42	>	#       $self->{switch}=ActiveDoc::SimpleURLDoc->new($self->{cache});
43		return $self;
85	–
86	–	}
87	–
88	–	# ----- parse related routines --------------
89	–	sub parse {
90	–	my $self=shift;
91	–	$parselabel=shift;
92	–
93	–	my $file=$self->file();
94	–	if ( $file ) {
95	–	if ( exists $self->{parsers}{$parselabel} ) {
96	–	$self->{currentparsename}=$parselabel;
97	–	$self->{currentparser}=$self->{parsers}{$parselabel};
98	–	$self->{parsers}{$parselabel}->parse($file,@_);
99	–	delete $self->{currentparser};
100	–	$self->{currentparsename}="";
101	–	}
102	–	}
103	–	else {
104	–	print "Cannot parse - file not known\n";
105	–	}
106	–	}
107	–
108	–	sub currentparsename {
109	–	my $self=shift;
110	–	@_?$self->{currentparsename}=shift
111	–	:$self->{currentparsename};
112	–	}
113	–
114	–	sub newparse {
115	–	my $self=shift;
116	–	my $parselabel=shift;
117	–
118	–	$self->{parsers}{$parselabel}=ActiveDoc::Parse->new();
119	–	$self->{parsers}{$parselabel}->addignoretags();
120	–	$self->{parsers}{$parselabel}->addgrouptags();
121	–	}
122	–
123	–	sub cleartags {
124	–	my $self=shift;
125	–	my $parselabel=shift;
126	–
127	–	$self->{parsers}{$parselabel}->cleartags();
128	–	}
129	–
130	–
131	–	sub includeparse {
132	–	my $self=shift;
133	–	my $parselabel=shift;
134	–	my $remoteparselabel=shift;
135	–	my $activedoc=shift;
136	–
137	–	# Some error trapping
138	–	if ( ! exists $self->{parsers}{$parselabel} ) {
139	–	$self->error("Unknown local parse name specified");
140	–	}
141	–	if ( ! exists $activedoc->{parsers}{$remoteparselabel} ) {
142	–	$self->error("Unknown parse name specified in remote obj $activedoc");
143	–	}
144	–
145	–	#
146	–	my $rp=$activedoc->{parsers}{$remoteparselabel};
147	–	$self->{parsers}{$parselabel}->includeparse($rp);
148	–	}
149	–
150	–	sub addtag {
151	–	my $self=shift;
152	–	my $parselabel=shift;
153	–	if ( $#_ != 6 ) {
154	–	$self->error("Incorrect addtags specification\n".
155	–	"called with :\n@_ \n");
156	–	}
157	–	$self->{parsers}{$parselabel}->addtag(@_);
158	–	}
159	–
160	–	sub addurltags {
161	–	my $self=shift;
162	–	my $parselabel=shift;
163	–
164	–	$self->{parsers}{$parselabel}->
165	–	addtag("Base", \&Base_start, $self, "", $self,
166	–	\&Base_end, $self);
44		}
45
46		sub url {
47		my $self=shift;
48		# get file & preprocess
49	<	if ( @_  ) {$self->{File}=$self->getfile(shift)}
50	<	$self->{File}->url();
51	<	}
52	<
53	<	sub copydocconfig {
54	<	my $self=shift;
178	<	my $ActiveDoc=shift;
179	<
180	<	$self->config($ActiveDoc->config());
181	<
182	<	}
183	<
184	<	sub copydocquery {
185	<	my $self=shift;
186	<	my $ActiveDoc=shift;
187	<
188	<	$self->basequery($ActiveDoc->basequery());
189	<	}
190	<
191	<	sub config {
192	<	my $self=shift;
193	<	@_?$self->{ActiveConfig}=shift
194	<	: $self->{ActiveConfig};
195	<	}
196	<
197	<	sub basequery {
198	<	my $self=shift;
199	<	@_ ? $self->{Query}=shift
200	<	: $self->{Query};
201	<	}
202	<
203	<	sub option {
204	<	my $self=shift;
205	<	my $param=shift;
206	<	if ( defined $self->basequery()) {
207	<	return $self->basequery()->getparam($param);
208	<	}
209	<	else {
210	<	return $undef;
49	>	if ( @_  ) {
50	>	$self->{File}=$self->getfile(shift);
51	>	$self->verbose("url downloaded to $self->{File}");
52	>	}
53	>	if ( defined $self->{File} ) {
54	>	return $self->{File}->url();
55		}
56	+	else { return "undefined"; }
57		}
58
59	<	sub requestoption {
215	<	my $self=shift;
216	<	my $param=shift;
217	<	my $string=shift;
218	<
219	<	my $par=undef;
220	<	if ( defined $self->basequery()) {
221	<	$par=$self->basequery()->getparam($param);
222	<	while ( ! defined $par ) {
223	<	$self->basequery()->querytype( $param, "basic");
224	<	$self->basequery()->querymessage( $param, $string);
225	<	$self->userinterface()->askuser($self->basequery());
226	<	$par=$self->basequery()->getparam($param);
227	<	}
228	<	}
229	<	return $par;
230	<	}
231	<
232	<	sub getfile() {
59	>	sub getfile {
60		my $self=shift;
61		my $origurl=shift;
62
63		my $fileref;
64	<	my ($url, $file)=$self->{urlhandler}->get($origurl);
64	>	my ($url, $file);
65	>	if ( 0 ) {
66	>	$self->verbose("Forced download of $origurl");
67	>	($url, $file)=$self->urldownload($origurl);
68	>	}
69	>	else {
70	>	$self->verbose("Attempting to get $origurl");
71	>	($url, $file)=$self->urlget($origurl);
72	>	}
73		# do we already have an appropriate object?
74	<	($fileref)=$self->config()->find($url);
240	<	#undef $fileref;
74	>	($fileref)=$self->{dbstore}->find($url);
75		if (  defined $fileref ) {
76	<	print "found $url in database ----\n";
76	>	$self->verbose("Found $url in database");
77		$fileref->update();
78		}
79		else {
80		if ( $file eq "" ) {
81		$self->parseerror("Unable to get $origurl");
82		}
83	<	#-- set up a new preprocess file
84	<	print "Making a new file $url----\n";
85	<	$fileref=ActiveDoc::PreProcessedFile->new($self->config());
83	>	# -- set up a new preprocess file
84	>	$self->verbose("Making a new preprocessed file $url");
85	>	$fileref=ActiveDoc::PreProcessedFile->new($self->{cache},
86	>	$self->{dbstore});
87		$fileref->url($url);
88		$fileref->update();
89		}
#	Line 260 | Line 95 | sub activatedoc {
95		my $url=shift;
96
97		# first get a preprocessed copy of the file
98	<	#       my $fileob=$self->getfile($url);
98	>	my $fileobj=$self->getfile($url);
99
100	<	# now parse it for the <DocType> tag
101	<	my $tempdoc=ActiveDoc::ActiveDoc->new($self->config());
102	<	$tempdoc->{urlhandler}=$self->{urlhandler};
103	<	my $fullurl=$tempdoc->url($url);
104	<	$url=$fullurl;
105	<	$tempdoc->{doctypefound}=0;
106	<	$tempdoc->newparse("doctype");
107	<	$tempdoc->addtag("doctype","Doc", \&Doc_Start, $tempdoc,
273	<	"", $tempdoc, "", $tempdoc);
274	<	$tempdoc->parse("doctype");
275	<
276	<	if ( ! defined $tempdoc->{docobject} ) {
277	<	print "No <Doc type=> Specified in ".$url."\n";
278	<	exit 1;
100	>	# now parse it for the <Doc> tag
101	>	my $tempdoc=ActiveDoc::SimpleURLDoc->new($self->{cache});
102	>	$tempdoc->filetoparse($fileobj->ProcessFile());
103	>	my ($doctype,$docversion)=$tempdoc->doctype();
104	>	undef $tempdoc;
105	>
106	>	if ( ! defined $doctype ) {
107	>	$self->parseerror("No <Doc type=> Specified in ".$url);
108		}
109	+	$self->verbose("doctype required is $doctype $docversion");
110	+
111		# Set up a new object of the specified type
112	<	eval "require $tempdoc->{docobject}";
112	>	eval "require $doctype";
113		die $@ if $@;
114	<	my $newobj=$tempdoc->{docobject}->new($self->config());
284	<	undef $tempdoc;
114	>	my $newobj=$doctype->new($self->{cache},$self->{dbstore});
115		$newobj->url($url);
116	<	$newobj->_initparse();
116	>	$newobj->parent($self);
117		return $newobj;
118		}
119
120	<	sub _initparse {
120	>	sub parent {
121		my $self=shift;
122
123	<	$self->parse("init");
123	>	@_?$self->{parent}=shift
124	>	:$self->{parent};
125		}
295	–	# -------- Error Handling and Error services --------------
296	–
297	–	sub error {
298	–	my $self=shift;
299	–	my $string=shift;
126
127	<	die $string."\n";
302	<	}
127	>	# -------- Error Handling and Error services --------------
128
129		sub parseerror {
130		my $self=shift;
131		my $string=shift;
132
133	<	($line, $file)=$self->line();
134	<	print "Parse Error in ".$file->url().", line ".
133	>	if ( $self->currentparsename() eq "" ) {
134	>	$self->error($string);
135	>	}
136	>	else {
137	>	($line, $file)=$self->line();
138	>	print "Parse Error in ".$file->url().", line ".
139		$line."\n";
140	<	print $string."\n";
141	<	die;
142	<	}
314	<
315	<	sub checktag {
316	<	my $self=shift;
317	<	my $tagname=shift;
318	<	my $hashref=shift;
319	<	my $param=shift;
320	<
321	<	if ( ! exists $$hashref{$param} ) {
322	<	$self->parseerror("Incomplete Tag <$tagname> : $param required");
323	<	}
140	>	print $string."\n";
141	>	exit;
142	>	}
143		}
144
145		sub line {
146		my $self=shift;
147	+	my $parseline;
148	+
149	+	if ( @_ ) {
150	+	$parseline=shift;
151	+	}
152	+	else {
153	+	$parseline=$self->{currentparser}->line();
154	+	}
155
156		my ($line, $fileobj)=
157	<	$self->{File}->realline($self->{currentparser}->line());
157	>	$self->{File}->realline($parseline);
158		return ($line, $fileobj);
159		}
160
#	Line 344 | Line 171 | sub file {
171		$self->{File}->file();
172		}
173
174	<	# --------------- Initialisation Methods ---------------------------
174	>	sub ProcessFile {
175	>	my $self=shift;
176
177	<	sub init {
350	<	# Dummy Routine - override for derived classes
177	>	return $self->{File}->ProcessedFile();
178		}
179
353	–	# ------------------- Tag Routines -----------------------------------
180		#
181	<	# Base - for setting url bases
181	>	# Delegate all else to the switch
182		#
183	<	sub Base_start {
184	<	my $self=shift;
359	<	my $name=shift;
360	<	my $hashref=shift;
183	>	#sub AUTOLOAD {
184	>	#        my $self=shift;
185
186	<	$self->checktag($name, $hashref, 'type' );
187	<	$self->checktag($name, $hashref, 'base' );
364	<
365	<	# Keep track of base tags
366	<	push @{$self->{basestack}}, $$hashref{"type"};
367	<	# Set the base
368	<	$self->{urlhandler}->setbase($$hashref{"type"},$hashref);
369	<	}
186	>	# dont propogate destroy methods
187	>	#        return if $AUTOLOAD=~/::DESTROY/;
188
189	<	sub Base_end {
190	<	my $self=shift;
191	<	my $name=shift;
192	<	my $type;
189	>	# remove this package name
190	>	#        ($name=$AUTOLOAD)=~s/ActiveDoc::ActiveDoc:://;
191	>
192	>	# pass the message to SimpleDoc
193	>	#        $self->{switch}->$name(@_);
194	>	#}
195
376	–	if ( $#{$self->{basestack}} == -1 ) {
377	–	print "Parse Error : unmatched </".$name."> on line ".
378	–	$self->line()."\n";
379	–	die;
380	–	}
381	–	else {
382	–	$type = pop @{$self->{basestack}};
383	–	$self->{urlhandler}->unsetbase($type);
384	–	}
385	–	}
196
197	+	# ------------------- Tag Routines -----------------------------------
198		sub Doc_Start {
199		my $self=shift;
200		my $name=shift;
#	Line 395 | Line 206 | sub Doc_Start {
206		$self->{docobject}=$$hashref{'type'};
207		}
208		}
398	–
399	–	sub userinterface {
400	–	my $self=shift;
401	–	@_?$self->{userinterface}=shift
402	–	:$self->{userinterface}
403	–	}

Diff Legend

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