src/ActiveDoc/SimpleXMLURLDoc.pm

#____________________________________________________________________ 
# File: ActiveDoc::SimpleXMLURLDoc.pm
#____________________________________________________________________ 
#  
# Author: Shaun Ashby <Shaun.Ashby@cern.ch>
# Update: 2005-12-02 17:44:08+0100
# Revision: $Id$ 
#
# Copyright: 2005 (C) Shaun Ashby
#
#--------------------------------------------------------------------

=head1 NAME

ActiveDoc::SimpleXMLURLDoc - Base class for URL-based SCRAM documents.

=head1 SYNOPSIS

        my $obj = ActiveDoc::SimpleXMLURLDoc->new();

=head1 DESCRIPTION

Any document class inheriting from ActiveDoc::SimpleXMLURLDoc will have access to
URL handling.
   
=head1 METHODS

=over

=cut

package ActiveDoc::SimpleXMLURLDoc;
use ActiveDoc::SimpleXMLDoc;
use URL::URLhandler;
require 5.004;
use Exporter;
use vars qw(@ISA);

@ISA=qw(Exporter ActiveDoc::SimpleXMLDoc);
@EXPORT_OK=qw( );

sub new()
   {
   ###############################################################
   # new                                                         #
   ###############################################################
   # modified : Fri Dec  2 17:44:11 2005 / SFA                   #
   # params   :                                                  #
   #          :                                                  #
   # function :                                                  #
   #          :                                                  #
   ###############################################################
   my $proto=shift;
   my $class=ref($proto) || $proto;
   my ($urlcache,$context,@defhandlers)=@_;
   my $self= bless($proto->SUPER::new($context,@defhandlers),$class);
   $self->{CONTEXT}=$context;
   # Register supported tags for this doc class, and specify which
   # attributes should be checked for:
   my $nested = 1;
   my $unnested = 0;
   my %recognised_tags = ('base' => [ { 'url' => 'REQUIRED' }, $nested ],
                          'download' => [ { 'url' => 'REQUIRED', 'name' => 'OPTION' }, $unnested ]);
   
   # Register these recognised tags to the base class (which registers them
   # to the container class):
   $self->register_handlers_(\%recognised_tags);

   # Set up a URL cache:
   $self->cache($urlcache);

   return $self;
   }

sub cache
   {
   my $self=shift;

   if ( @_ )
      {
      $self->{cache}=shift;
#      $self->{urlhandler}=URL::URLhandler->new($self->{cache});
      }

   return $self->{cache};
   }

# sub expandurl
#    {
#    my $self=shift;
#    my $urlstring=shift;
   
#    return $self->{urlhandler}->expandurl($urlstring);
#    }

# sub urldownload
#    {
#    my $self=shift;
#    my $urlstring=shift;
   
#    ($fullurl,$filename)=$self->{urlhandler}->download($urlstring, @_);
#    if ( ( ! defined $filename ) || ( $filename eq "" ) )
#       {
#       $self->parseerror("Failed to get $fullurl");
#       }
#    return ($fullurl,$filename);
#    }

# sub urlget
#    {
#    my $self=shift;
#    my $urlstring=shift;
   
#    ($fullurl,$filename)=$self->{urlhandler}->get($urlstring, @_);
   
#    if ( ( ! defined $filename ) || ( $filename eq "" ) )
#       {
#       $self->parseerror("Failed to get $fullurl");
#       }
#    return ($fullurl,$filename);
#    }

1;

=back

=head1 AUTHOR/MAINTAINER

Shaun ASHBY

=cut
Revision:	1.2
Committed:	Thu Dec 15 16:38:10 2005 UTC (19 years, 4 months ago) by sashby
Content type:	text/plain
Branch:	MAIN
Changes since 1.1:	+114 -101 lines
Log Message:	Start to migrate project boot to XML based parsing.
#	User	Rev	Content
1	sashby	1.2	#____________________________________________________________________
2			# File: ActiveDoc::SimpleXMLURLDoc.pm
3			#____________________________________________________________________
4			#
5			# Author: Shaun Ashby <Shaun.Ashby@cern.ch>
6			# Update: 2005-12-02 17:44:08+0100
7			# Revision: $Id$
8	sashby	1.1	#
9	sashby	1.2	# Copyright: 2005 (C) Shaun Ashby
10	sashby	1.1	#
11	sashby	1.2	#--------------------------------------------------------------------
12
13			=head1 NAME
14
15			ActiveDoc::SimpleXMLURLDoc - Base class for URL-based SCRAM documents.
16
17			=head1 SYNOPSIS
18
19			my $obj = ActiveDoc::SimpleXMLURLDoc->new();
20
21			=head1 DESCRIPTION
22
23			Any document class inheriting from ActiveDoc::SimpleXMLURLDoc will have access to
24			URL handling.
25
26			=head1 METHODS
27
28			=over
29
30			=cut
31
32	sashby	1.1	package ActiveDoc::SimpleXMLURLDoc;
33			use ActiveDoc::SimpleXMLDoc;
34			use URL::URLhandler;
35	sashby	1.2	require 5.004;
36			use Exporter;
37			use vars qw(@ISA);
38	sashby	1.1
39	sashby	1.2	@ISA=qw(Exporter ActiveDoc::SimpleXMLDoc);
40			@EXPORT_OK=qw( );
41	sashby	1.1
42	sashby	1.2	sub new()
43	sashby	1.1	{
44	sashby	1.2	###############################################################
45			# new #
46			###############################################################
47			# modified : Fri Dec 2 17:44:11 2005 / SFA #
48			# params : #
49			# : #
50			# function : #
51			# : #
52			###############################################################
53			my $proto=shift;
54			my $class=ref($proto) \|\| $proto;
55			my ($urlcache,$context,@defhandlers)=@_;
56			my $self= bless($proto->SUPER::new($context,@defhandlers),$class);
57			$self->{CONTEXT}=$context;
58			# Register supported tags for this doc class, and specify which
59			# attributes should be checked for:
60			my $nested = 1;
61			my $unnested = 0;
62			my %recognised_tags = ('base' => [ { 'url' => 'REQUIRED' }, $nested ],
63			'download' => [ { 'url' => 'REQUIRED', 'name' => 'OPTION' }, $unnested ]);
64	sashby	1.1
65	sashby	1.2	# Register these recognised tags to the base class (which registers them
66			# to the container class):
67			$self->register_handlers_(\%recognised_tags);
68	sashby	1.1
69	sashby	1.2	# Set up a URL cache:
70			$self->cache($urlcache);
71	sashby	1.1
72	sashby	1.2	return $self;
73			}
74	sashby	1.1
75	sashby	1.2	sub cache
76	sashby	1.1	{
77	sashby	1.2	my $self=shift;
78	sashby	1.1
79	sashby	1.2	if ( @_ )
80	sashby	1.1	{
81	sashby	1.2	$self->{cache}=shift;
82			# $self->{urlhandler}=URL::URLhandler->new($self->{cache});
83	sashby	1.1	}
84	sashby	1.2
85			return $self->{cache};
86	sashby	1.1	}
87	sashby	1.2
88			# sub expandurl
89			# {
90			# my $self=shift;
91			# my $urlstring=shift;
92
93			# return $self->{urlhandler}->expandurl($urlstring);
94			# }
95
96			# sub urldownload
97			# {
98			# my $self=shift;
99			# my $urlstring=shift;
100
101			# ($fullurl,$filename)=$self->{urlhandler}->download($urlstring, @_);
102			# if ( ( ! defined $filename ) \|\| ( $filename eq "" ) )
103			# {
104			# $self->parseerror("Failed to get $fullurl");
105			# }
106			# return ($fullurl,$filename);
107			# }
108
109			# sub urlget
110			# {
111			# my $self=shift;
112			# my $urlstring=shift;
113
114			# ($fullurl,$filename)=$self->{urlhandler}->get($urlstring, @_);
115
116			# if ( ( ! defined $filename ) \|\| ( $filename eq "" ) )
117			# {
118			# $self->parseerror("Failed to get $fullurl");
119			# }
120			# return ($fullurl,$filename);
121			# }
122
123			1;
124
125			=back
126
127			=head1 AUTHOR/MAINTAINER
128
129			Shaun ASHBY
130
131			=cut