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.4 by williamc, Mon Sep 27 14:05:22 1999 UTC vs.
Revision 1.25.2.1.2.8 by williamc, Mon Aug 28 07:23:36 2000 UTC

#	Line 1 | Line 1
1		#
2	<	# The base functionality for the ActiveDocument - inherits from Basetags
2	>	# ActiveDoc.pm
3	>	#
4	>	# Originally Written by Christopher Williams
5	>	#
6	>	# Description
7		#
4	–	# Inherits from BaseTags
5	–	# --------
8		# Interface
9		# ---------
10	<	# new(filename, DOChandler): create a new object based on a file and
11	<	#                                 associate with a base DOChandler
12	<	# parse()                       : parse the input file
13	<	# include(url) : Activate include file mechanism, returns the object ref if OK
14	<	# treenode()   : return the associated TreeNode object reference
15	<	# getincludeObjectStore : Return a pointer to the ObectStore that contains all
16	<	#                         included objects
17	<	# find(string)  : find the object reference related to string in the associated
18	<	#                 tree. Mechanism for getting object references
19	<	# _addgroup()   : Add group functionality to document
20	<	# parseerror(String) : Report an error to the user
21	<	# userinterface()       : return the default User Interface object
22	<	# checktag($hashref, param , tagname) : Check a hash returned from switcher
23	<	#                                       for a given parameter
10	>	# new(ActiveStore)              : 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	>	# 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
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([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.001;
29	<	use ActiveDoc::DOChandler;
30	<	use ActiveDoc::TreeNode;
31	<	use ActiveDoc::UserQuery;
32	<	use ObjectStoreCont;
33	<
34	<	@ISA = qw(BaseTags);
28	>	require 5.004;
29	>	use ActiveDoc::SimpleURLDoc;
30	>	use ActiveDoc::PreProcessedFile;
31	>	use Utilities::Verbose;
32	>
33	>	@ISA = qw(ActiveDoc::SimpleURLDoc Utilities::Verbose);
34	>
35	>	sub new {
36	>	my $class=shift;
37	>	my $self={};
38	>	bless $self, $class;
39	>	$self->{Ostore}=shift;
40	>	$self->cache($self->{Ostore}->cache());
41	>	$self->{dbstore}=$self->{Ostore};
42	>	$self->_initdoc("doc",@_);
43	>	#       $self->{switch}=ActiveDoc::SimpleURLDoc->new($self->{cache});
44	>	return $self;
45	>	}
46	>
47	>	sub url {
48	>	my $self=shift;
49	>	# get file & preprocess
50	>	if ( @_  ) {
51	>	$self->{origurl}=shift;
52	>	$self->{File}=$self->getfile($self->{origurl});
53	>	$self->filetoparse($self->{File}->ProcessedFile());
54	>	$self->verbose("url downloaded to ".$self->{File}->ProcessedFile());
55	>	}
56	>	if ( defined $self->{File} ) {
57	>	return $self->{File}->url();
58	>	}
59	>	else { return "undefined"; }
60	>	}
61
62	<	# Initialise
33	<	sub _init {
62	>	sub getfile {
63		my $self=shift;
64	<	my $DOChandler=shift;
36	<	my $OC=shift;
37	<
38	<	$self->_addurl();
39	<	$self->{urlhandler}->setcache($DOChandler->defaultcache());
40	<	$self->{treenode}=ActiveDoc::TreeNode->new();
41	<	$self->{dochandler}=$DOChandler;
42	<	$self->{UserQuery}=$DOChandler->{UserQuery};
43	<	$self->{tags}->addtag("Use", \&Use_Start, "", "");
44	<	# Add the minimal functionality tag - feel free to override
45	<	$self->{tags}->addtag("Include", \&Include_Start, "", "");
46	<	$self->init();
47	<	}
64	>	my $origurl=shift;
65
66	<	sub init {
67	<	# Dummy Routine - override for derrived classes
68	<	}
69	<	#
70	<	# use mechanism
54	<	#
55	<	sub include {
56	<	my $self=shift;
57	<	my $url=shift;
58	<	my $linkfile=shift;
59	<	my $filename;
60	<	my $obj;
61	<
62	<	$file=$self->{urlhandler}->get($url);
63	<	if ( ( defined $linkfile) && ( $linkfile ne "" ) ) {
64	<	$filename=$file."/".$linkfile;
66	>	my $fileref;
67	>	my ($url, $file);
68	>	if ( 0 ) {
69	>	$self->verbose("Forced download of $origurl");
70	>	($url, $file)=$self->urldownload($origurl);
71		}
72		else {
73	<	$filename=$file;
73	>	$self->verbose("Attempting to get $origurl");
74	>	($url, $file)=$self->urlget($origurl);
75		}
76	<	$obj=$self->{dochandler}->newdoc($filename);
77	<
78	<	# Now Extend our tree
79	<	$self->{treenode}->grow($obj->treenode());
80	<	return $obj;
76	>	# do we already have an appropriate object?
77	>	($fileref)=$self->{dbstore}->find($url);
78	>	if (  defined $fileref ) {
79	>	$self->verbose("Found $url in database");
80	>	$fileref->update();
81	>	}
82	>	else {
83	>	if ( $file eq "" ) {
84	>	$self->parseerror("Unable to get $origurl");
85	>	}
86	>	# -- set up a new preprocess file
87	>	$self->verbose("Making a new preprocessed file $url");
88	>	$fileref=ActiveDoc::PreProcessedFile->new($self->{Ostore});
89	>	#$fileref->cache($self->{cache});
90	>	$fileref->url($url);
91	>	$fileref->update();
92	>	}
93	>	return $fileref;
94		}
95
96	<	sub userinterface {
96	>	sub activatedoc {
97		my $self=shift;
98	<	return $self->{dochandler}->{UserInterface};
98	>	my $url=shift;
99	>
100	>	# first get a preprocessed copy of the file
101	>	my $fileobj=$self->getfile($url);
102	>
103	>	# now parse it for the <Doc> tag
104	>	my $tempdoc=ActiveDoc::SimpleURLDoc->new($self->{cache});
105	>	$tempdoc->filetoparse($fileobj->ProcessFile());
106	>	my ($doctype,$docversion)=$tempdoc->doctype();
107	>	undef $tempdoc;
108	>
109	>	if ( ! defined $doctype ) {
110	>	$self->parseerror("No <Doc type=> Specified in ".$url);
111	>	}
112	>	$self->verbose("doctype required is $doctype $docversion");
113	>
114	>	# Set up a new object of the specified type
115	>	eval "require $doctype";
116	>	die $@ if $@;
117	>	my $newobj=$doctype->new($self->{Ostore}, $url);
118	>	$newobj->url($url);
119	>	#$newobj->parent($self);
120	>	return $newobj;
121		}
122
123	<	sub treenode {
123	>	sub parent {
124		my $self=shift;
83	–	return $self->{treenode};
84	–	}
125
126	<	sub getincludeObjectStore {
127	<	my $self=shift;
88	<	return $self->{includeOS};
126	>	@_?$self->{parent}=shift
127	>	:$self->{parent};
128		}
129
130	<	sub find($) {
131	<	my $self=shift;
132	<	my $string=shift;
133	<	my $tn;
130	>	# -------- Error Handling and Error services --------------
131	>
132	>	sub parseerror {
133	>	my $self=shift;
134	>	my $string=shift;
135
136	<	$tn=$self->{treenode}->find($string);
137	<	if ( $tn eq "" ) {
98	<	$self->parseerror("Unable to find $string");
136	>	if ( $self->currentparsename() eq "" ) {
137	>	$self->error($string);
138		}
139	<	return $tn->associate();
139	>	elsif ( ! defined $self->{File} ) {
140	>	print "Parse Error in ".$self->filenameref()." line "
141	>	.$self->{currentparser}->line()."\n";
142	>	print $string."\n";
143	>	}
144	>	else {
145	>	($line, $file)=$self->line();
146	>	print "Parse Error in ".$file->url().", line ".
147	>	$line."\n";
148	>	print $string."\n";
149	>	}
150	>	exit;
151		}
152
153		sub line {
154		my $self=shift;
155	<	return $self->{switch}->line();
106	<	}
155	>	my $parseline;
156
157	<	sub error {
158	<	my $self=shift;
159	<	my $string=shift;
157	>	if ( @_ ) {
158	>	$parseline=shift;
159	>	}
160	>	else {
161	>	$parseline=$self->{currentparser}->line();
162	>	}
163
164	<	die $string."\n";
164	>	my ($line, $fileobj)=
165	>	$self->{File}->realline($parseline);
166	>	return ($line, $fileobj);
167	>	}
168
169	+	sub tagstartline {
170	+	my $self=shift;
171	+	my ($line, $fileobj)=$self->{File}->line(
172	+	$self->{currentparser}->tagstartline());
173	+	return ($line, $fileobj);
174		}
175	<	sub parseerror {
175	>
176	>	sub file {
177		my $self=shift;
117	–	my $string=shift;
178
179	<	print "Parse Error in $self->{url}, line ".
120	<	$self->line()."\n";
121	<	print $string."\n";
122	<	die;
179	>	$self->{File}->file();
180		}
181
182	<	sub checktag {
182	>	sub ProcessFile {
183		my $self=shift;
127	–	my $hashref=shift;
128	–	my $param=shift;
129	–	my $tagname=shift;
184
185	<	if ( ! exists $$hashref{$param} ) {
132	<	$self->parseerror("Incomplete Tag <$tagname> : $param required");
133	<	}
185	>	return $self->{File}->ProcessedFile();
186		}
187
136	–	# ------------------------ Tag Routines ------------------------------
188		#
189	<	# The Include tag
189	>	# Delegate all else to the switch
190		#
191	+	#sub AUTOLOAD {
192	+	#        my $self=shift;
193
194	<	sub Include_Start {
195	<	my $self=shift;
143	<	my $name=shift;
144	<	my $hashref=shift;
194	>	# dont propogate destroy methods
195	>	#        return if $AUTOLOAD=~/::DESTROY/;
196
197	<	$self->{switch}->checkparam( $name, "ref");
198	<	print "<Include> tag not yet implemented\n";
199	<	#        $self->include($$hashref{'ref'},$$hashref{'linkdoc'});
200	<	}
197	>	# remove this package name
198	>	#        ($name=$AUTOLOAD)=~s/ActiveDoc::ActiveDoc:://;
199	>
200	>	# pass the message to SimpleDoc
201	>	#        $self->{switch}->$name(@_);
202	>	#}
203
151	–	sub Use_Start {
152	–	my $self=shift;
153	–	my $name=shift;
154	–	my $hashref=shift;
204
205	<	print "<Use> tag not yet implemented\n";
205	>	# ------------------- Tag Routines -----------------------------------
206	>	sub Doc_Start {
207	>	my $self=shift;
208	>	my $name=shift;
209	>	my $hashref=shift;
210	>
211	>	$self->checktag($name, $hashref, "type");
212	>	$self->{doctypefound}++;
213	>	if ( $self->{doctypefound} == 1 ) { # only take first doctype
214	>	$self->{docobject}=$$hashref{'type'};
215	>	}
216		}

Diff Legend

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