while( <$fh> ) { print $_; }
$fh->close;
- # delete an upload
- my ( $fn ) = Koha::Upload->new->delete({ id => $id });
-
=head1 DESCRIPTION
This module is a refactored version of C4::UploadedFile but adds on top
That report added module UploadedFiles.pm. This module contains the
functionality of both.
+ The module has been revised to use Koha::Object[s]; the delete method
+ has been moved to Koha::UploadedFile[s].
+
=head1 METHODS
=cut
return wantarray? @rv: $res;
}
-=head2 delete
-
- Returns array of deleted filenames or undef.
- Since it now only accepts id as parameter, you should not expect more
- than one filename.
-
-=cut
-
-sub delete {
- my ( $self, $params ) = @_;
- return $self->_delete( $params->{id} );
-}
-
=head1 CLASS METHODS
=head2 getCategories
sub _init {
my ( $self, $params ) = @_;
- $self->{rootdir} = C4::Context->config('upload_path');
- $self->{tmpdir} = File::Spec->tmpdir;
+ $self->{rootdir} = Koha::UploadedFile->permanent_directory;
+ $self->{tmpdir} = Koha::UploadedFile->temporary_directory;
$params->{tmp} = $params->{temp} if !exists $params->{tmp};
$self->{temporary} = $params->{tmp}? 1: 0; #default false
# Does always return an arrayref (perhaps an empty one)
}
-sub _delete {
- my ( $self, $id ) = @_;
- my $rec = Koha::UploadedFiles->find($id) || return;
- my $filename = $rec->filename;
- my $file = $self->_full_fname({
- permanent => $rec->permanent,
- dir => $rec->dir,
- hashvalue => $rec->hashvalue,
- filename => $filename,
- });
-
- if( !-e $file ) { # we will just delete the record
- # TODO Should we add a trace here for the missing file?
- $rec->delete;
- return $filename;
- } elsif( unlink($file) ) {
- $rec->delete;
- return $filename;
- }
- $self->{files}->{ $rec->{filename} }->{errcode} = 7;
- #NOTE: errcode=6 is used to report successful delete (see template)
- return;
-}
-
sub _compute {
# Computes hash value when sub hook feeds the first block
# For temporary files, the id is made unique with time
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use Modern::Perl;
+use File::Spec;
#use Koha::Database;
=head3 delete
-Delete uploaded file (to be extended)
+Delete uploaded file.
+It deletes not only the record, but also the actual file.
+
+Returns filename on successful delete or undef.
=cut
sub delete {
- my ( $self, $params ) = @_;
- $self->SUPER::delete( $params );
+ my ( $self ) = @_;
+
+ my $name = $self->filename;
+ my $file = $self->full_path;
+
+ if( !-e $file ) { # we will just delete the record
+ warn "Removing record for $name within category ".
+ $self->uploadcategorycode. ", but file was missing.";
+ return $name if $self->SUPER::delete;
+ } elsif( unlink($file) ) {
+ return $name if $self->SUPER::delete;
+ } else {
+ warn "Problem while deleting: $file";
+ }
+ return; # something went wrong
+}
+
+=head3 full_path
+
+Returns the fully qualified path name for an uploaded file.
+
+=cut
+
+sub full_path {
+ my ( $self ) = @_;
+ my $path = File::Spec->catfile(
+ $self->permanent?
+ $self->permanent_directory: $self->temporary_directory,
+ $self->dir,
+ $self->hashvalue. '_'. $self->filename,
+ );
+ return $path;
}
=head2 CLASS METHODS
+=head3 root_directory
+
+=cut
+
+sub permanent_directory {
+ my ( $class ) = @_;
+ return C4::Context->config('upload_path');
+}
+
+=head3 tmp_directory
+
+=cut
+
+sub temporary_directory {
+ my ( $class ) = @_;
+ return File::Spec->tmpdir;
+}
+
=head3 _type
Returns name of corresponding DBIC resultset
=head2 INSTANCE METHODS
-=head3 delete
+=head3 delete, delete_errors
-Delete uploaded files
+Delete uploaded files.
+Returns true if no errors occur.
+Delete_errors returns the number of errors when deleting files.
=cut
sub delete {
- my ( $self, $params ) = @_;
- $self->SUPER::delete( $params );
+ my ( $self ) = @_;
+ # We use the individual delete on each resultset record
+ my $err = 0;
+ while( my $row = $self->_resultset->next ) {
+ my $kohaobj = Koha::UploadedFile->_new_from_dbic( $row );
+ $err++ if !$kohaobj->delete;
+ }
+ $self->{delete_errors} = $err;
+ return $err==0;
+}
+
+sub delete_errors {
+ my ( $self ) = @_;
+ return $self->{delete_errors};
}
=head2 CLASS METHODS
_("No temporary directory found."),
_("File could not be read."),
_("File has been deleted."),
- _("File could not be deleted."),
+ _("File or upload record could not be deleted."),
];
//]]>
</script>
[
{ name => 'file4', cat => undef, size => 5000 }, # temp duplicate
],
+ [
+ { name => 'file5', cat => undef, size => 7000 }, # temp duplicate
+ ],
];
# Redirect upload dir structure and mock File::Spec and CGI
# Start testing
subtest 'Test01' => sub {
- plan tests => 7;
+ plan tests => 9;
test01();
};
subtest 'Test02' => sub {
test04();
};
subtest 'Test05' => sub {
- plan tests => 5;
+ plan tests => 6;
test05();
};
subtest 'Test06' => sub {
# Delete existing records (for later tests)
$dbh->do( "DELETE FROM uploaded_files" );
+ # Check mocked directories
+ is( Koha::UploadedFile->permanent_directory, $tempdir,
+ 'Check permanent directory' );
+ is( Koha::UploadedFile->temporary_directory, $tempdir,
+ 'Check temporary directory' );
+
my $upl = Koha::Upload->new({
category => $uploads->[$current_upload]->[0]->{cat},
});
is( $upl->count, 1, 'Upload 5 adds duplicate temporary file' );
my $id = $upl->result;
my $r = $upl->get({ id => $id });
- my @d = $upl->delete({ id => $id });
- is( $d[0], $r->{name}, 'Delete successful' );
- is( -e $r->{path}? 1: 0, 0, 'File no longer found after delete' );
+
+ # testing delete via UploadedFiles (plural)
+ my $delete = Koha::UploadedFiles->search({ id => $id })->delete;
+ is( $delete, 1, 'Delete successful' );
+ isnt( -e $r->{path}, 1, 'File no longer found after delete' );
is( scalar $upl->get({ id => $id }), undef, 'Record also gone' );
- is( $upl->delete({ id => $id }), undef, 'Repeated delete failed' );
+
+ # testing delete via UploadedFile (singular)
+ # Note that find returns a Koha::Object
+ $upl = Koha::Upload->new({ tmp => 1 });
+ $upl->cgi;
+ $id = $upl->result;
+ my $kohaobj = Koha::UploadedFiles->find( $id );
+ my $name = $kohaobj->filename;
+ my $path = $kohaobj->full_path;
+ $delete = $kohaobj->delete;
+ is( $delete, $name, 'Delete successful' );
+ isnt( -e $path, 1, 'File no longer found after delete' );
}
sub test06 { #some extra tests for get
} elsif ( $op eq 'delete' ) {
# delete only takes the id parameter
- my $upl = Koha::Upload->new($upar);
- my ($fn) = $upl->delete( { id => $id } );
- my $e = $upl->err;
- my $msg =
- $fn ? JSON::to_json( { $fn => 6 } )
- : $e ? JSON::to_json($e)
- : undef;
+ my $upload = $plugin?
+ Koha::UploadedFiles->search({ public => 1, id => $id })->next:
+ Koha::UploadedFiles->find($id);
+ my $fn = $upload? $upload->delete: undef;
+ #TODO Improve error handling
+ my $msg = $fn?
+ JSON::to_json({ $fn => 6 }):
+ JSON::to_json({
+ $upload? $upload->filename: ( $id? "id $id": '[No id]' ), 7,
+ });
$template->param(
mode => 'deleted',
msg => $msg,
- uploadcategories => $upl->getCategories,
+ uploadcategories => Koha::Upload->getCategories,
);
output_html_with_http_headers $input, $cookie, $template->output;
projects / koha.git / commitdiff