7 |
|
# |
8 |
|
# Interface |
9 |
|
# --------- |
10 |
< |
# new(ActiveConfig[,options]) : A new ActiveDoc object |
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 |
– |
# parse(parselabel): Parse the document file for the given parse level |
15 |
|
# parent() : return the object ref of the calling parent |
17 |
– |
# newparse(parselabel) : Create a new parse type |
18 |
– |
# addtag(parselabel,tagname,start,obj,text,obj,end,obj) |
19 |
– |
# : Add tags to the parse given by label |
20 |
– |
# checktag(tagname, hashref, param) : check for existence of param in |
21 |
– |
# hashref from a tag call |
22 |
– |
# includeparse(local_parsename, objparsename, activedoc) : copy the parse from |
23 |
– |
# one object to another |
24 |
– |
# currentparsename([name]) : get/set current parse name |
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 |
27 |
– |
# -- any parse called "init" will also be run |
28 |
– |
# config([ActiveConfig]) : Set up/return Configuration for the document |
29 |
– |
# basequery([ActiveConfig]) : Set up/return UserQuery for the doc |
30 |
– |
# copydocconfig(ActiveDoc) : Copy the basic configuration from the ActiveDoc |
31 |
– |
# copydocquery(ActiveDoc) : Copy the basicquery from the ActiveDoc |
32 |
– |
# userinterface() : Return the defaullt userinterface |
33 |
– |
# option(var) : return the value of the option var ( or undef ) |
34 |
– |
# requestoption("message") : Ask the user to supply a value for an option |
35 |
– |
# if it dosnt already exist |
36 |
– |
# askuser(Query) : send a query object to the userinterface |
37 |
– |
# verbose(string) : Print string in verbosity mode |
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; |
48 |
< |
use ActiveDoc::ActiveConfig; |
29 |
> |
use ActiveDoc::SimpleURLDoc; |
30 |
|
use ActiveDoc::PreProcessedFile; |
31 |
< |
use ObjectUtilities::StorableObject; |
51 |
< |
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 ( @_ ) { |
43 |
< |
$self->basequery(shift); |
64 |
< |
} |
65 |
< |
else { |
66 |
< |
# --- is there a starter document? |
67 |
< |
my $basedoc=$self->config()->basedoc(); |
68 |
< |
if ( defined $basedoc ) { |
69 |
< |
$self->copydocquery($basedoc); |
70 |
< |
$self->verbose("Initialising from $basedoc"); |
71 |
< |
} |
72 |
< |
else { |
73 |
< |
$self->error("ActiveDoc Error : No base doc found"); |
74 |
< |
} |
75 |
< |
} |
76 |
< |
$self->verbose("New ActiveDoc (".ref($self).") Created"); |
77 |
< |
$self->_init2(); |
78 |
< |
} |
79 |
< |
|
80 |
< |
sub _init2 { |
81 |
< |
|
82 |
< |
my $self=shift; |
83 |
< |
# A URL handler per document |
84 |
< |
$self->{urlhandler}=URL::URLhandler->new($self->config()->cache()); |
85 |
< |
|
86 |
< |
# A default UserInterface |
87 |
< |
$self->{userinterface}=ActiveDoc::SimpleUserInterface->new(); |
88 |
< |
$self->init(@_); |
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; |
90 |
– |
|
91 |
– |
} |
92 |
– |
|
93 |
– |
sub verbose { |
94 |
– |
my $self=shift; |
95 |
– |
my $string=shift; |
96 |
– |
|
97 |
– |
if ( $self->option('verbose_all') || |
98 |
– |
$self->option('verbose_'.ref($self)) ) { |
99 |
– |
print ">".ref($self)."($self) : \n->".$string."\n"; |
100 |
– |
} |
101 |
– |
} |
102 |
– |
|
103 |
– |
# ----- parse related routines -------------- |
104 |
– |
sub parse { |
105 |
– |
my $self=shift; |
106 |
– |
$parselabel=shift; |
107 |
– |
|
108 |
– |
my $file=$self->ProcessFile(); |
109 |
– |
if ( $file ) { |
110 |
– |
if ( exists $self->{parsers}{$parselabel} ) { |
111 |
– |
$self->verbose("Parsing $parselabel in file $file"); |
112 |
– |
$self->{currentparsename}=$parselabel; |
113 |
– |
$self->{currentparser}=$self->{parsers}{$parselabel}; |
114 |
– |
$self->{parsers}{$parselabel}->parse($file,@_); |
115 |
– |
delete $self->{currentparser}; |
116 |
– |
$self->{currentparsename}=""; |
117 |
– |
$self->verbose("Parse $parselabel Complete"); |
118 |
– |
} |
119 |
– |
} |
120 |
– |
else { |
121 |
– |
print "Cannot parse - file not known\n"; |
122 |
– |
} |
123 |
– |
} |
124 |
– |
|
125 |
– |
sub currentparsename { |
126 |
– |
my $self=shift; |
127 |
– |
@_?$self->{currentparsename}=shift |
128 |
– |
:$self->{currentparsename}; |
129 |
– |
} |
130 |
– |
|
131 |
– |
sub newparse { |
132 |
– |
my $self=shift; |
133 |
– |
my $parselabel=shift; |
134 |
– |
|
135 |
– |
$self->{parsers}{$parselabel}=ActiveDoc::Parse->new(); |
136 |
– |
$self->{parsers}{$parselabel}->addignoretags(); |
137 |
– |
$self->{parsers}{$parselabel}->addgrouptags(); |
138 |
– |
} |
139 |
– |
|
140 |
– |
sub cleartags { |
141 |
– |
my $self=shift; |
142 |
– |
my $parselabel=shift; |
143 |
– |
|
144 |
– |
$self->{parsers}{$parselabel}->cleartags(); |
145 |
– |
} |
146 |
– |
|
147 |
– |
|
148 |
– |
sub includeparse { |
149 |
– |
my $self=shift; |
150 |
– |
my $parselabel=shift; |
151 |
– |
my $remoteparselabel=shift; |
152 |
– |
my $activedoc=shift; |
153 |
– |
|
154 |
– |
# Some error trapping |
155 |
– |
if ( ! exists $self->{parsers}{$parselabel} ) { |
156 |
– |
$self->error("Unknown local parse name specified"); |
157 |
– |
} |
158 |
– |
if ( ! exists $activedoc->{parsers}{$remoteparselabel} ) { |
159 |
– |
$self->error("Unknown parse name specified in remote obj $activedoc"); |
160 |
– |
} |
161 |
– |
|
162 |
– |
# |
163 |
– |
my $rp=$activedoc->{parsers}{$remoteparselabel}; |
164 |
– |
$self->{parsers}{$parselabel}->includeparse($rp); |
165 |
– |
} |
166 |
– |
|
167 |
– |
sub addtag { |
168 |
– |
my $self=shift; |
169 |
– |
my $parselabel=shift; |
170 |
– |
if ( $#_ != 6 ) { |
171 |
– |
$self->error("Incorrect addtags specification\n". |
172 |
– |
"called with :\n@_ \n"); |
173 |
– |
} |
174 |
– |
$self->{parsers}{$parselabel}->addtag(@_); |
175 |
– |
} |
176 |
– |
|
177 |
– |
sub addurltags { |
178 |
– |
my $self=shift; |
179 |
– |
my $parselabel=shift; |
180 |
– |
|
181 |
– |
$self->{parsers}{$parselabel}-> |
182 |
– |
addtag("Base", \&Base_start, $self, "", $self, |
183 |
– |
\&Base_end, $self); |
45 |
|
} |
46 |
|
|
47 |
|
sub url { |
48 |
|
my $self=shift; |
49 |
|
# get file & preprocess |
50 |
|
if ( @_ ) { |
51 |
< |
$self->{File}=$self->getfile(shift); |
52 |
< |
$self->verbose("url downloaded to $self->{File}"); |
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 |
< |
$self->{File}->url(); |
57 |
< |
} |
195 |
< |
|
196 |
< |
sub copydocconfig { |
197 |
< |
my $self=shift; |
198 |
< |
my $ActiveDoc=shift; |
199 |
< |
|
200 |
< |
$self->config($ActiveDoc->config()); |
201 |
< |
|
202 |
< |
} |
203 |
< |
|
204 |
< |
sub copydocquery { |
205 |
< |
my $self=shift; |
206 |
< |
my $ActiveDoc=shift; |
207 |
< |
|
208 |
< |
if ( defined $ActiveDoc->basequery() ) { |
209 |
< |
$self->basequery($ActiveDoc->basequery()); |
210 |
< |
} |
211 |
< |
else { |
212 |
< |
$self->error("Cannot copy basequery - undefined"); |
56 |
> |
if ( defined $self->{File} ) { |
57 |
> |
return $self->{File}->url(); |
58 |
|
} |
59 |
< |
} |
215 |
< |
|
216 |
< |
sub config { |
217 |
< |
my $self=shift; |
218 |
< |
@_?$self->{ActiveConfig}=shift |
219 |
< |
: $self->{ActiveConfig}; |
220 |
< |
} |
221 |
< |
|
222 |
< |
sub basequery { |
223 |
< |
my $self=shift; |
224 |
< |
@_?$self->{Query}=shift |
225 |
< |
:$self->{Query}; |
226 |
< |
} |
227 |
< |
|
228 |
< |
sub option { |
229 |
< |
my $self=shift; |
230 |
< |
my $param=shift; |
231 |
< |
if ( defined $self->basequery()) { |
232 |
< |
return $self->basequery()->getparam($param); |
233 |
< |
} |
234 |
< |
else { |
235 |
< |
return $undef; |
236 |
< |
} |
237 |
< |
} |
238 |
< |
|
239 |
< |
sub requestoption { |
240 |
< |
my $self=shift; |
241 |
< |
my $param=shift; |
242 |
< |
my $string=shift; |
243 |
< |
|
244 |
< |
my $par=undef; |
245 |
< |
if ( defined $self->basequery()) { |
246 |
< |
$par=$self->basequery()->getparam($param); |
247 |
< |
while ( ! defined $par ) { |
248 |
< |
$self->basequery()->querytype( $param, "basic"); |
249 |
< |
$self->basequery()->querymessage( $param, $string); |
250 |
< |
$self->userinterface()->askuser($self->basequery()); |
251 |
< |
$par=$self->basequery()->getparam($param); |
252 |
< |
} |
253 |
< |
} |
254 |
< |
return $par; |
255 |
< |
} |
256 |
< |
|
257 |
< |
sub askuser { |
258 |
< |
my $self=shift; |
259 |
< |
return $self->userinterface()->askuser(@_); |
59 |
> |
else { return "undefined"; } |
60 |
|
} |
61 |
|
|
62 |
|
sub getfile { |
65 |
|
|
66 |
|
my $fileref; |
67 |
|
my ($url, $file); |
68 |
< |
if ( (defined ($it=$self->option('url_update'))) && |
269 |
< |
( $it eq "1" || $origurl=~/^$it/ )) { |
68 |
> |
if ( 0 ) { |
69 |
|
$self->verbose("Forced download of $origurl"); |
70 |
< |
($url, $file)=$self->{urlhandler}->download($origurl); |
70 |
> |
($url, $file)=$self->urldownload($origurl); |
71 |
|
} |
72 |
|
else { |
73 |
|
$self->verbose("Attempting to get $origurl"); |
74 |
< |
($url, $file)=$self->{urlhandler}->get($origurl); |
74 |
> |
($url, $file)=$self->urlget($origurl); |
75 |
|
} |
76 |
|
# do we already have an appropriate object? |
77 |
< |
($fileref)=$self->config()->find($url); |
279 |
< |
#undef $fileref; |
77 |
> |
($fileref)=$self->{dbstore}->find($url); |
78 |
|
if ( defined $fileref ) { |
79 |
|
$self->verbose("Found $url in database"); |
80 |
|
$fileref->update(); |
83 |
|
if ( $file eq "" ) { |
84 |
|
$self->parseerror("Unable to get $origurl"); |
85 |
|
} |
86 |
< |
#-- set up a new preprocess file |
86 |
> |
# -- set up a new preprocess file |
87 |
|
$self->verbose("Making a new preprocessed file $url"); |
88 |
< |
$fileref=ActiveDoc::PreProcessedFile->new($self->config()); |
88 |
> |
$fileref=ActiveDoc::PreProcessedFile->new($self->{Ostore}); |
89 |
> |
#$fileref->cache($self->{cache}); |
90 |
|
$fileref->url($url); |
91 |
|
$fileref->update(); |
92 |
|
} |
98 |
|
my $url=shift; |
99 |
|
|
100 |
|
# first get a preprocessed copy of the file |
101 |
< |
# my $fileob=$self->getfile($url); |
101 |
> |
my $fileobj=$self->getfile($url); |
102 |
|
|
103 |
< |
# now parse it for the <DocType> tag |
104 |
< |
my $tempdoc=ActiveDoc::ActiveDoc->new($self->config()); |
105 |
< |
$tempdoc->{urlhandler}=$self->{urlhandler}; |
106 |
< |
my $fullurl=$tempdoc->url($url); |
107 |
< |
$url=$fullurl; |
108 |
< |
$tempdoc->{doctypefound}=0; |
109 |
< |
$tempdoc->newparse("doctype"); |
110 |
< |
$tempdoc->addtag("doctype","Doc", \&Doc_Start, $tempdoc, |
312 |
< |
"", $tempdoc, "", $tempdoc); |
313 |
< |
$tempdoc->parse("doctype"); |
314 |
< |
|
315 |
< |
if ( ! defined $tempdoc->{docobject} ) { |
316 |
< |
print "No <Doc type=> Specified in ".$url."\n"; |
317 |
< |
exit 1; |
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 $tempdoc->{docobject}"; |
115 |
> |
eval "require $doctype"; |
116 |
|
die $@ if $@; |
117 |
< |
my $newobj=$tempdoc->{docobject}->new($self->config()); |
323 |
< |
undef $tempdoc; |
117 |
> |
my $newobj=$doctype->new($self->{Ostore}, $url); |
118 |
|
$newobj->url($url); |
119 |
< |
$newobj->parent($self); |
326 |
< |
$newobj->_initparse(); |
119 |
> |
#$newobj->parent($self); |
120 |
|
return $newobj; |
121 |
|
} |
122 |
|
|
127 |
|
:$self->{parent}; |
128 |
|
} |
129 |
|
|
337 |
– |
sub _initparse { |
338 |
– |
my $self=shift; |
339 |
– |
|
340 |
– |
$self->parse("init"); |
341 |
– |
} |
130 |
|
# -------- Error Handling and Error services -------------- |
131 |
|
|
344 |
– |
sub error { |
345 |
– |
my $self=shift; |
346 |
– |
my $string=shift; |
347 |
– |
|
348 |
– |
die $string."\n"; |
349 |
– |
} |
350 |
– |
|
132 |
|
sub parseerror { |
133 |
|
my $self=shift; |
134 |
|
my $string=shift; |
136 |
|
if ( $self->currentparsename() eq "" ) { |
137 |
|
$self->error($string); |
138 |
|
} |
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"; |
363 |
– |
exit; |
149 |
|
} |
150 |
< |
} |
366 |
< |
|
367 |
< |
sub checktag { |
368 |
< |
my $self=shift; |
369 |
< |
my $tagname=shift; |
370 |
< |
my $hashref=shift; |
371 |
< |
my $param=shift; |
372 |
< |
|
373 |
< |
if ( ! exists $$hashref{$param} ) { |
374 |
< |
$self->parseerror("Incomplete Tag <$tagname> : $param required"); |
375 |
< |
} |
150 |
> |
exit; |
151 |
|
} |
152 |
|
|
153 |
|
sub line { |
154 |
|
my $self=shift; |
155 |
+ |
my $parseline; |
156 |
+ |
|
157 |
+ |
if ( @_ ) { |
158 |
+ |
$parseline=shift; |
159 |
+ |
} |
160 |
+ |
else { |
161 |
+ |
$parseline=$self->{currentparser}->line(); |
162 |
+ |
} |
163 |
|
|
164 |
|
my ($line, $fileobj)= |
165 |
< |
$self->{File}->realline($self->{currentparser}->line()); |
165 |
> |
$self->{File}->realline($parseline); |
166 |
|
return ($line, $fileobj); |
167 |
|
} |
168 |
|
|
185 |
|
return $self->{File}->ProcessedFile(); |
186 |
|
} |
187 |
|
|
405 |
– |
# --------------- Initialisation Methods --------------------------- |
406 |
– |
|
407 |
– |
sub init { |
408 |
– |
# Dummy Routine - override for derived classes |
409 |
– |
} |
410 |
– |
|
411 |
– |
# ------------------- Tag Routines ----------------------------------- |
188 |
|
# |
189 |
< |
# Base - for setting url bases |
189 |
> |
# Delegate all else to the switch |
190 |
|
# |
191 |
< |
sub Base_start { |
192 |
< |
my $self=shift; |
417 |
< |
my $name=shift; |
418 |
< |
my $hashref=shift; |
191 |
> |
#sub AUTOLOAD { |
192 |
> |
# my $self=shift; |
193 |
|
|
194 |
< |
$self->checktag($name, $hashref, 'type' ); |
195 |
< |
$self->checktag($name, $hashref, 'base' ); |
422 |
< |
|
423 |
< |
# Keep track of base tags |
424 |
< |
push @{$self->{basestack}}, $$hashref{"type"}; |
425 |
< |
# Set the base |
426 |
< |
$self->{urlhandler}->setbase($$hashref{"type"},$hashref); |
427 |
< |
} |
194 |
> |
# dont propogate destroy methods |
195 |
> |
# return if $AUTOLOAD=~/::DESTROY/; |
196 |
|
|
197 |
< |
sub Base_end { |
198 |
< |
my $self=shift; |
431 |
< |
my $name=shift; |
432 |
< |
my $type; |
197 |
> |
# remove this package name |
198 |
> |
# ($name=$AUTOLOAD)=~s/ActiveDoc::ActiveDoc:://; |
199 |
|
|
200 |
< |
if ( $#{$self->{basestack}} == -1 ) { |
201 |
< |
$self->parseerror("Parse Error : unmatched </$name>"); |
202 |
< |
} |
437 |
< |
else { |
438 |
< |
$type = pop @{$self->{basestack}}; |
439 |
< |
$self->{urlhandler}->unsetbase($type); |
440 |
< |
} |
441 |
< |
} |
200 |
> |
# pass the message to SimpleDoc |
201 |
> |
# $self->{switch}->$name(@_); |
202 |
> |
#} |
203 |
|
|
204 |
+ |
|
205 |
+ |
# ------------------- Tag Routines ----------------------------------- |
206 |
|
sub Doc_Start { |
207 |
|
my $self=shift; |
208 |
|
my $name=shift; |
214 |
|
$self->{docobject}=$$hashref{'type'}; |
215 |
|
} |
216 |
|
} |
454 |
– |
|
455 |
– |
sub userinterface { |
456 |
– |
my $self=shift; |
457 |
– |
@_?$self->{userinterface}=shift |
458 |
– |
:$self->{userinterface} |
459 |
– |
} |