| 1 | package HTML::SiteTear; | ||||||||||
| 2 | |||||||||||
| 3 | 1 | ▶ | use 5.008; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 4 | 1 | ▶ | use strict; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 5 | 1 | ▶ | use warnings; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 6 | 1 | ▶ | use File::Basename qw(basename fileparse); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 7 | 1 | ▶ | use File::Spec; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 8 | 1 | ▶ | use File::Path 2.0 qw(make_path); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 9 | 1 | ▶ | use File::Find; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 10 | 1 | ▶ | use Cwd; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 11 | 1 | ▶ | use Carp; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 12 | 1 | ▶ | use base qw(Class::Accessor::Fast); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 13 | 1 | __PACKAGE__->mk_accessors( qw(source_path | |||||||||
| 14 | site_root_path | ||||||||||
| 15 | site_root_url | ||||||||||
| 16 | target_path | ||||||||||
| 17 | member_files) ); | ||||||||||
| 18 | |||||||||||
| 19 | 1 | ▶ | use HTML::SiteTear::Root; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 20 | 1 | ▶ | use HTML::SiteTear::Page; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 21 | |||||||||||
| 22 | # use Data::Dumper; | ||||||||||
| 23 | |||||||||||
| 24 | =head1 NAME | ||||||||||
| 25 | |||||||||||
| 26 | HTML::SiteTear - Make a separated copy of a part of the site | ||||||||||
| 27 | |||||||||||
| 28 | =head1 VERSION | ||||||||||
| 29 | |||||||||||
| 30 | Version 1.46 | ||||||||||
| 31 | |||||||||||
| 32 | =cut | ||||||||||
| 33 | |||||||||||
| 34 | 1 | our $VERSION = '1.46'; | |||||||||
| 35 | |||||||||||
| 36 | =head1 SYMPOSIS | ||||||||||
| 37 | |||||||||||
| 38 | use HTML::SiteTear; | ||||||||||
| 39 | |||||||||||
| 40 | $p = HTML::SiteTear->new("/dev1/website/index.html"); | ||||||||||
| 41 | $p->copy_to("/dev1/website2/newindex.html"); | ||||||||||
| 42 | |||||||||||
| 43 | =head1 DESCRIPTION | ||||||||||
| 44 | |||||||||||
| 45 | This module is to make a separated copy of a part of web site in local file system. All linked files (HTML file, image file, javascript, cascading style shieet) from a source HTML file will be copied under a new page. | ||||||||||
| 46 | |||||||||||
| 47 | This module is useful to make a destributable copy of a part of a web site. | ||||||||||
| 48 | |||||||||||
| 49 | =head1 METHODS | ||||||||||
| 50 | |||||||||||
| 51 | =head2 new | ||||||||||
| 52 | |||||||||||
| 53 | $p = HTML::SiteTear->new($source_path); | ||||||||||
| 54 | |||||||||||
| 55 | $p = HTML::SiteTear->new('source_path' => $source_path, | ||||||||||
| 56 | 'site_root_path' => $root_path, | ||||||||||
| 57 | 'site_root_url' => $url); | ||||||||||
| 58 | |||||||||||
| 59 | $p = HTML::SiteTear->new('source_path' => $source_dir, | ||||||||||
| 60 | 'member_files' => \@pathes); | ||||||||||
| 61 | |||||||||||
| 62 | Make an instance of this module. The path to source HTML file "$source_path" is required as an arguemnt. See L</ABSOLUTE LINK> about 'site_root_path' and 'site_root_url' parameters | ||||||||||
| 63 | |||||||||||
| 64 | =cut | ||||||||||
| 65 | |||||||||||
| 66 | 1 | our @DEFAULT_HTML_SUFFIXES = qw(.html .htm .xhtml); | |||||||||
| 67 | |||||||||||
| 68 | 0 | ▶ | sub new { | ||||||||
|
Subroutine
new: not called CC=9 SCAR=45.0
Pod
documented
| |||||||||||
| 69 | 0 | my $class = shift @_; | |||||||||
| 70 | 0 | my $self; | |||||||||
| 71 | 0 | ▶ | if (@_ == 1) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 72 | 0 | $self = bless {'source_path' => shift @_}, $class; | |||||||||
| 73 | |||||||||||
| 74 | } else { | ||||||||||
| 75 | 0 | my %args = @_; | |||||||||
| 76 | 0 | $self = $class->SUPER::new(\%args); | |||||||||
| 77 | } | ||||||||||
| 78 | |||||||||||
| 79 | 0 | ▶ | $self->source_path or croak "source_path is not specified.\n"; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 80 | 0 | ▶ | (-e $self->source_path) or croak $self->source_path." is not found.\n"; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 81 | |||||||||||
| 82 | 0 | ▶ | if (-d $self->source_path) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 83 | 0 | ▶ | unless (File::Spec->file_name_is_absolute($self->source_path)) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 84 | 0 | my $cwd = fix_dir_path(cwd); | |||||||||
| 85 | 0 | $self->source_path( | |||||||||
| 86 | URI::file->new($self->source_path)->abs($cwd)->file); | ||||||||||
| 87 | } | ||||||||||
| 88 | |||||||||||
| 89 | 0 | ▶ | unless ($self->member_files) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 90 | 0 | my @htmlfiles; | |||||||||
| 91 | 0 | ▶ | my $wanted = sub { | ||||||||
|
Subroutine
__ANON__: not called CC=2 SCAR=17.9
| |||||||||||
| 92 | 0 | my $name = $_; | |||||||||
| 93 | 0 | ▶ | if (grep {$name =~ /\Q$_\E$/} @DEFAULT_HTML_SUFFIXES) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 94 | 0 | push @htmlfiles, $File::Find::name; | |||||||||
| 95 | } | ||||||||||
| 96 | 0 | }; | |||||||||
| 97 | 0 | find($wanted, $self->source_path); | |||||||||
| 98 | 0 | ▶ | if (@htmlfiles) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 99 | 0 | $self->member_files(\@htmlfiles); | |||||||||
| 100 | } else { | ||||||||||
| 101 | 0 | croak "Can't find HTML files under $self->source_path.\n"; | |||||||||
| 102 | } | ||||||||||
| 103 | } | ||||||||||
| 104 | 0 | $self->source_path(fix_dir_path($self->source_path)); | |||||||||
| 105 | |||||||||||
| 106 | } else { | ||||||||||
| 107 | 0 | ▶ | if ($self->member_files) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 108 | 0 | croak $self->source_path. | |||||||||
| 109 | " is not a directory. Must be a directory.\n"; | ||||||||||
| 110 | } | ||||||||||
| 111 | } | ||||||||||
| 112 | |||||||||||
| 113 | 0 | return $self; | |||||||||
| 114 | } | ||||||||||
| 115 | |||||||||||
| 116 | 0 | ▶ | sub page_filter { | ||||||||
|
Subroutine
page_filter: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||
| 117 | 0 | my ($class, $module) = @_; | |||||||||
| 118 | 0 | return HTML::SiteTear::Page->page_filter($module); | |||||||||
| 119 | } | ||||||||||
| 120 | |||||||||||
| 121 | =head2 copy_to | ||||||||||
| 122 | |||||||||||
| 123 | $p->copy_to($destination_path); | ||||||||||
| 124 | |||||||||||
| 125 | Copy $source_path into $destination_path. All linked file in $source_path will be copied into directories under $destination_path | ||||||||||
| 126 | |||||||||||
| 127 | =cut | ||||||||||
| 128 | |||||||||||
| 129 | 0 | ▶ | sub copy_to { | ||||||||
|
Subroutine
copy_to: not called CC=5 SCAR=34.0
Pod
documented
| |||||||||||
| 130 | #print "start copy_to in SiteTear.pm\n"; | ||||||||||
| 131 | 0 | my ($self, $destination_path) = @_; | |||||||||
| 132 | 0 | my $source_path = $self->source_path; | |||||||||
| 133 | 0 | ▶ | if ($self->member_files) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 134 | 0 | return $self->copy_to_dir($destination_path); | |||||||||
| 135 | } | ||||||||||
| 136 | |||||||||||
| 137 | 0 | ▶ | if (-e $destination_path){ | ||||||||
|
Branch: 1 branch
| |||||||||||
| 138 | 0 | ▶ | if (-d $destination_path) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 139 | 0 | $destination_path = File::Spec->catfile($destination_path, | |||||||||
| 140 | basename($source_path)); | ||||||||||
| 141 | } | ||||||||||
| 142 | } else { | ||||||||||
| 143 | 0 | my ($name, $dir) = fileparse($destination_path); | |||||||||
| 144 | 0 | make_path($dir); | |||||||||
| 145 | 0 | ▶ | unless ($name) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 146 | 0 | $destination_path = File::Spec->catfile($dir, | |||||||||
| 147 | basename($source_path)); | ||||||||||
| 148 | } | ||||||||||
| 149 | } | ||||||||||
| 150 | |||||||||||
| 151 | 0 | $self->target_path($destination_path); | |||||||||
| 152 | 0 | my $root = HTML::SiteTear::Root->new(%$self); | |||||||||
| 153 | 0 | my $new_source_page = HTML::SiteTear::Page->new( | |||||||||
| 154 | 'parent' => $root, | ||||||||||
| 155 | 'source_path' => $source_path); | ||||||||||
| 156 | 0 | $new_source_page->linkpath(basename($destination_path) ); | |||||||||
| 157 | #$new_source_page->link_uri(URI::file->new(Cwd::abs_path($destination_path))); | ||||||||||
| 158 | 0 | $new_source_page->link_uri(URI::file->new_abs($destination_path)); | |||||||||
| 159 | 0 | $new_source_page->copy_to_linkpath; | |||||||||
| 160 | 0 | return $new_source_page; | |||||||||
| 161 | } | ||||||||||
| 162 | |||||||||||
| 163 | 0 | ▶ | sub fix_dir_path { | ||||||||
|
Subroutine
fix_dir_path: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||
| 164 | 0 | my ($path) = @_; | |||||||||
| 165 | 0 | return File::Spec->catfile($path, File::Spec->curdir); | |||||||||
| 166 | } | ||||||||||
| 167 | |||||||||||
| 168 | 0 | ▶ | sub copy_to_dir { | ||||||||
|
Subroutine
copy_to_dir: not called CC=4 SCAR=30.0
Pod
undocumented
| |||||||||||
| 169 | 0 | my ($self, $destination_path) = @_; | |||||||||
| 170 | 0 | ▶ | if (-e $destination_path){ | ||||||||
|
Branch: 1 branch
| |||||||||||
| 171 | 0 | ▶ | unless (-d $destination_path) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 172 | 0 | croak $destination_path."is not directory.\n"; | |||||||||
| 173 | } | ||||||||||
| 174 | } | ||||||||||
| 175 | |||||||||||
| 176 | 0 | $destination_path = fix_dir_path($destination_path); | |||||||||
| 177 | |||||||||||
| 178 | 0 | $self->target_path($destination_path); | |||||||||
| 179 | 0 | my $root = HTML::SiteTear::Root->new(%$self); | |||||||||
| 180 | 0 | my $source_root_uri = $root->source_root_uri; | |||||||||
| 181 | 0 | my $dest_uri = URI::file->new_abs($destination_path); | |||||||||
| 182 | my @results = map { | ||||||||||
| 183 | 0 | my $a_member_file = do { | |||||||||
| 184 | 0 | ▶ | if (File::Spec->file_name_is_absolute($_)) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 185 | 0 | $_; | |||||||||
| 186 | }else { | ||||||||||
| 187 | 0 | URI::file->new($_) | |||||||||
| 188 | ->abs($self->source_path)->file; | ||||||||||
| 189 | }}; | ||||||||||
| 190 | 0 | my $page = HTML::SiteTear::Page->new('parent' => $root, | |||||||||
| 191 | 'source_path' => $a_member_file); | ||||||||||
| 192 | 0 | my $rel_from_source_root = $page->source_uri->rel($source_root_uri); | |||||||||
| 193 | 0 | my $abs_from_dest = $rel_from_source_root->abs($dest_uri); | |||||||||
| 194 | 0 | $page->link_uri($abs_from_dest); | |||||||||
| 195 | 0 | $page->copy_to_linkpath; | |||||||||
| 196 | 0 | $page; | |||||||||
| 197 | 0 | } @{$self->member_files}; | |||||||||
| 198 | 0 | return \@results; | |||||||||
| 199 | } | ||||||||||
| 200 | |||||||||||
| 201 | =head1 ABSOLUTE LINK | ||||||||||
| 202 | |||||||||||
| 203 | The default behavior of HTML::SiteTear follows all of links in HTML files. In some case, there are links should not be followd. For example, if theare is a link to the top page of the site, all of files in the site will be copyied. Such links should be converted to absolute links (e.g. "http://www....."). | ||||||||||
| 204 | |||||||||||
| 205 | To convert links should not be followed into absolute links, | ||||||||||
| 206 | |||||||||||
| 207 | =over | ||||||||||
| 208 | |||||||||||
| 209 | =item * | ||||||||||
| 210 | |||||||||||
| 211 | Give parameters of 'site_root_path' and 'site_root_url' to L</new> method. | ||||||||||
| 212 | |||||||||||
| 213 | =over | ||||||||||
| 214 | |||||||||||
| 215 | =item 'site_root_path' | ||||||||||
| 216 | |||||||||||
| 217 | A file path of the root of the site in the local file system. | ||||||||||
| 218 | |||||||||||
| 219 | =item 'site_root_url' | ||||||||||
| 220 | |||||||||||
| 221 | A URL corresponding to 'site_root_path' in WWW. | ||||||||||
| 222 | |||||||||||
| 223 | =back | ||||||||||
| 224 | |||||||||||
| 225 | =item * | ||||||||||
| 226 | |||||||||||
| 227 | Relative links to upper level files from 'source_path' are automatically converted to absolute links. | ||||||||||
| 228 | |||||||||||
| 229 | =item * | ||||||||||
| 230 | |||||||||||
| 231 | To indicate links should be conveted to absolute links, enclose links in HTML files with specail comment tags <!-- begin abs_link --> and <!-- end abs_link --> | ||||||||||
| 232 | |||||||||||
| 233 | =back | ||||||||||
| 234 | |||||||||||
| 235 | =head1 AUTHOR | ||||||||||
| 236 | |||||||||||
| 237 | Tetsuro KURITA <tkurita@mac.com> | ||||||||||
| 238 | |||||||||||
| 239 | =cut | ||||||||||
| 240 | |||||||||||
| 241 | 1 | 1; | |||||||||