libmongodb-perl 1.8.1-1 / usr / lib / x86_64-linux-gnu / perl5 / 5.26 / MongoDB / GridFS.pm

#
#  Copyright 2009-2013 MongoDB, Inc.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#  http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

use strict;
use warnings;
package MongoDB::GridFS;

# ABSTRACT: A file storage abstraction (DEPRECATED)

use version;
our $VERSION = 'v1.8.1';

use MongoDB::GridFS::File;
use Digest::MD5;
use Moo;
use MongoDB::Error;
use MongoDB::WriteConcern;
use MongoDB::_Types qw(
    BSONCodec
    NonNegNum
    ReadPreference
    WriteConcern
);
use Types::Standard qw(
    InstanceOf
    Str
);
use namespace::clean -except => 'meta';

#pod =attr chunk_size
#pod
#pod The number of bytes per chunk.  Defaults to 261120 (255kb).
#pod
#pod =cut

$MongoDB::GridFS::chunk_size = 261120;

has _database => (
    is       => 'ro',
    isa      => InstanceOf['MongoDB::Database'],
    required => 1,
);

#pod =attr read_preference
#pod
#pod A L<MongoDB::ReadPreference> object.  It may be initialized with a string
#pod corresponding to one of the valid read preference modes or a hash reference
#pod that will be coerced into a new MongoDB::ReadPreference object.
#pod By default it will be inherited from a L<MongoDB::Database> object.
#pod
#pod =cut

has read_preference => (
    is       => 'ro',
    isa      => ReadPreference,
    required => 1,
    coerce   => ReadPreference->coercion,
);

#pod =attr write_concern
#pod
#pod A L<MongoDB::WriteConcern> object.  It may be initialized with a hash
#pod reference that will be coerced into a new MongoDB::WriteConcern object.
#pod By default it will be inherited from a L<MongoDB::Database> object.
#pod
#pod =cut

has write_concern => (
    is       => 'ro',
    isa      => WriteConcern,
    required => 1,
    coerce   => WriteConcern->coercion,
);

#pod =attr max_time_ms
#pod
#pod Specifies the default maximum amount of time in milliseconds that the
#pod server should use for working on a query.
#pod
#pod B<Note>: this will only be used for server versions 2.6 or greater, as that
#pod was when the C<$maxTimeMS> meta-operator was introduced.
#pod
#pod =cut

has max_time_ms => (
    is      => 'ro',
    isa     => NonNegNum,
    required => 1,
);

#pod =attr bson_codec
#pod
#pod An object that provides the C<encode_one> and C<decode_one> methods, such
#pod as from L<MongoDB::BSON>.  It may be initialized with a hash reference that
#pod will be coerced into a new MongoDB::BSON object.  By default it will be
#pod inherited from a L<MongoDB::Database> object.
#pod
#pod =cut

has bson_codec => (
    is       => 'ro',
    isa      => BSONCodec,
    coerce   => BSONCodec->coercion,
    required => 1,
);

#pod =attr prefix
#pod
#pod The prefix used for the collections.  Defaults to "fs".
#pod
#pod =cut

has prefix => (
    is      => 'ro',
    isa     => Str,
    default => 'fs'
);

has files => (
    is => 'lazy',
    isa => InstanceOf['MongoDB::Collection'],
);

sub _build_files {
    my $self = shift;
    my $coll = $self->_database->get_collection(
        $self->prefix . '.files',
        {
            read_preference => $self->read_preference,
            write_concern   => $self->write_concern,
            max_time_ms     => $self->max_time_ms,
            bson_codec      => $self->bson_codec,
        }
    );
    return $coll;
}

has chunks => (
    is => 'lazy',
    isa => InstanceOf['MongoDB::Collection'],
);

sub _build_chunks {
    my $self = shift;
    my $coll = $self->_database->get_collection(
        $self->prefix . '.chunks',
        {
            read_preference => $self->read_preference,
            write_concern   => $self->write_concern,
            max_time_ms     => $self->max_time_ms,
        }
    );
    return $coll;
}

# This checks if the required indexes for GridFS exist in for the current database.
# If they are not found, they will be created.
sub BUILD {
    my ($self) = @_;
    $self->_ensure_indexes();
    return;
}


sub _ensure_indexes {
    my ($self) = @_;

    # ensure the necessary index is present (this may be first usage)
    $self->files->indexes->create_one(Tie::IxHash->new(filename => 1));
    $self->chunks->indexes->create_one(Tie::IxHash->new(files_id => 1, n => 1), {"unique" => 1});
}

#pod =method get
#pod
#pod     $file = $grid->get($id);
#pod
#pod Get a file from GridFS based on its _id.  Returns a L<MongoDB::GridFS::File>.
#pod
#pod To retrieve a file based on metadata like C<filename>, use the L</find_one>
#pod method instead.
#pod
#pod =cut

sub get {
    my ($self, $id) = @_;

    return $self->find_one({_id => $id});
}

#pod =method put
#pod
#pod     $id = $grid->put($fh, $metadata);
#pod     $id = $grid->put($fh, {filename => "pic.jpg"});
#pod
#pod Inserts a file into GridFS, adding a L<MongoDB::OID> as the _id field if the
#pod field is not already defined.  This is a wrapper for C<MongoDB::GridFS::insert>,
#pod see that method below for more information.
#pod
#pod Returns the _id field.
#pod
#pod =cut

sub put {
    my ($self, $fh, $metadata) = @_;

    return $self->insert($fh, $metadata, {safe => 1});
}

#pod =method delete
#pod
#pod     $grid->delete($id)
#pod
#pod Removes the file with the given _id.  Will die if the remove is unsuccessful.
#pod Does not return anything on success.
#pod
#pod =cut

sub delete {
    my ($self, $id) = @_;

    $self->remove({_id => $id}, {safe => 1});
}

#pod =method find_one
#pod
#pod     $file = $grid->find_one({"filename" => "foo.txt"});
#pod     $file = $grid->find_one($criteria, $fields);
#pod
#pod Returns a matching MongoDB::GridFS::File or undef.
#pod
#pod =cut

sub find_one {
    my ($self, $criteria, $fields) = @_;
    $criteria ||= {};

    my $file = $self->files->find_one($criteria, $fields);
    return undef unless $file; ## no critic
    return MongoDB::GridFS::File->new({_grid => $self,info => $file});
}

#pod =method remove
#pod
#pod     $grid->remove({"filename" => "foo.txt"});
#pod     $grid->remove({"filename" => "foo.txt"}, $options);
#pod
#pod Cleanly removes files from the database.  C<$options> is a hash of options for
#pod the remove.
#pod
#pod A hashref of options may be provided with the following keys:
#pod
#pod =for :list
#pod * C<just_one>: If true, only one file matching the criteria will be removed.
#pod * C<safe>: (DEPRECATED) If true, each remove will be checked for success and
#pod   die on failure.  Set the L</write_concern> attribute instead.
#pod
#pod This method doesn't return anything.
#pod
#pod =cut

sub remove {
    my ( $self, $criteria, $options ) = @_;
    $options ||= {};

    my $chunks =
      exists $options->{safe}
      ? $self->chunks->clone( write_concern => $self->_dynamic_write_concern($options) )
      : $self->chunks;

    my $files =
      exists $options->{safe}
      ? $self->files->clone( write_concern => $self->_dynamic_write_concern($options) )
      : $self->files;

    if ( $options->{just_one} ) {
        my $meta = $files->find_one($criteria);
        $chunks->delete_many( { "files_id" => $meta->{'_id'} } );
        $files->delete_one( { "_id" => $meta->{'_id'} } );
    }
    else {
        my $cursor = $files->find($criteria);
        while ( my $meta = $cursor->next ) {
            $chunks->delete_many( { "files_id" => $meta->{'_id'} } );
        }
        $files->delete_many($criteria);
    }
    return;
}


#pod =method insert
#pod
#pod     $id = $gridfs->insert($fh);
#pod     $id = $gridfs->insert($fh, $metadata);
#pod     $id = $gridfs->insert($fh, $metadata, $options);
#pod
#pod     $id = $gridfs->insert($fh, {"content-type" => "text/html"});
#pod
#pod Reads from a file handle into the database.  Saves the file with the given
#pod metadata.  The file handle must be readable.
#pod
#pod A hashref of options may be provided with the following keys:
#pod
#pod =for :list
#pod * C<safe>: (DEPRECATED) Will do safe inserts and check the MD5 hash calculated
#pod   by the database against an MD5 hash calculated by the local filesystem.  If
#pod   the two hashes do not match, then the chunks already inserted will be removed
#pod   and the program will die. Set the L</write_concern> attribute instead.
#pod
#pod Because C<MongoDB::GridFS::insert> takes a file handle, it can be used to insert
#pod very long strings into the database (as well as files).  C<$fh> must be a
#pod FileHandle (not just the native file handle type), so you can insert a string
#pod with:
#pod
#pod     # open the string like a file
#pod     open($basic_fh, '<', \$very_long_string);
#pod
#pod     # turn the file handle into a FileHandle
#pod     $fh = FileHandle->new;
#pod     $fh->fdopen($basic_fh, 'r');
#pod
#pod     $gridfs->insert($fh);
#pod
#pod =cut

sub insert {
    my ($self, $fh, $metadata, $options) = @_;
    $options ||= {};
    require DateTime; # lazy load so we don't have overhead if not needed

    MongoDB::UsageError->throw("not a file handle") unless $fh;
    $metadata = {} unless $metadata && ref $metadata eq 'HASH';

    my $chunks =
      exists $options->{safe}
      ? $self->chunks->clone( write_concern => $self->_dynamic_write_concern($options) )
      : $self->chunks;

    my $files =
      exists $options->{safe}
      ? $self->files->clone( write_concern => $self->_dynamic_write_concern($options) )
      : $self->files;

    my $start_pos = $fh->getpos();

    my $id;
    if (exists $metadata->{"_id"}) {
        $id = $metadata->{"_id"};
    }
    else {
        $id = MongoDB::OID->new;
    }

    my $n = 0;
    my $length = 0;
    while ((my $len = $fh->read(my $data, $MongoDB::GridFS::chunk_size)) != 0) {
        $chunks->insert_one({"files_id" => $id,
                               "n"        => $n,
                               "data"     => \$data});
        $n++;
        $length += $len;
    }

    $fh->setpos($start_pos);

    my %copy = %{$metadata};
    # compare the md5 hashes
    if ($files->write_concern->is_acknowledged) {
        # get an md5 hash for the file. set the retry flag to 'true' incase the 
        # database, collection, or indexes are missing. That way we can recreate them 
        # retry the md5 calc.
        my $result = $self->_database->run_command([filemd5 => $id, root => $self->prefix]);
        $copy{"md5"} = $result->{"md5"};

        my $md5 = Digest::MD5->new;
        $md5->addfile($fh);
        $fh->setpos($start_pos);
        my $digest = $md5->hexdigest;
        if ($digest ne $result->{md5}) {
            # cleanup and die
            $chunks->delete_many({files_id => $id});
            MongoDB::GridFSError->throw(
                "md5 hashes don't match: database got $result->{md5}, fs got $digest" );
        }
    }

    $copy{"_id"} = $id;
    $copy{"chunkSize"} = $MongoDB::GridFS::chunk_size;
    $copy{"uploadDate"} = DateTime->now;
    $copy{"length"} = $length;
    return $files->insert_one(\%copy)->inserted_id;
}

#pod =method drop
#pod
#pod     $grid->drop;
#pod
#pod Removes all files' metadata and contents.
#pod
#pod =cut

sub drop {
    my ($self) = @_;

    $self->files->drop;
    $self->chunks->drop;
    $self->_ensure_indexes;
}

#pod =head2 all
#pod
#pod     @files = $grid->all;
#pod
#pod Returns a list of the files in the database as L<MongoDB::GridFS::File>
#pod objects.
#pod
#pod =cut

sub all {
    my ($self) = @_;
    my @ret;

    my $cursor = $self->files->find({});
    while (my $meta = $cursor->next) {
        push @ret, MongoDB::GridFS::File->new(
            _grid => $self,
            info => $meta);
    }
    return @ret;
}

#--------------------------------------------------------------------------#
# private methods
#--------------------------------------------------------------------------#

sub _dynamic_write_concern {
    my ( $self, $opts ) = @_;

    my $wc = $self->write_concern;

    if ( !exists $opts->{safe} ) {
        return $wc;
    }
    elsif ( $opts->{safe} ) {
        return $wc->is_acknowledged ? $wc : MongoDB::WriteConcern->new( w => 1 );
    }
    else {
        return MongoDB::WriteConcern->new( w => 0 );
    }
}


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

MongoDB::GridFS - A file storage abstraction (DEPRECATED)

=head1 VERSION

version v1.8.1

=head1 SYNOPSIS

    my $grid = $database->get_gridfs;
    my $fh = IO::File->new("myfile", "r");
    $grid->insert($fh, {"filename" => "mydbfile"});

=head1 DESCRIPTION

This class models a GridFS file store in a MongoDB database and provides an API
for interacting with it.

Generally, you never construct one of these directly with C<new>.  Instead, you
call C<get_gridfs> on a L<MongoDB::Database> object.

=head1 USAGE

=head2 API

There are two interfaces for GridFS: a file-system/collection-like interface
(insert, remove, drop, find_one) and a more general interface
(get, put, delete).  Their functionality is the almost identical (get, put and
delete are always safe ops, insert, remove, and find_one are optionally safe),
using one over the other is a matter of preference.

=head2 Error handling

Unless otherwise explicitly documented, all methods throw exceptions if
an error occurs.  The error types are documented in L<MongoDB::Error>.

To catch and handle errors, the L<Try::Tiny> and L<Safe::Isa> modules
are recommended:

    use Try::Tiny;
    use Safe::Isa; # provides $_isa

    try {
        $grid->get( $id )
    }
    catch {
        if ( $_->$_isa("MongoDB::TimeoutError" ) {
            ...
        }
        else {
            ...
        }
    };

To retry failures automatically, consider using L<Try::Tiny::Retry>.

=head1 ATTRIBUTES

=head2 chunk_size

The number of bytes per chunk.  Defaults to 261120 (255kb).

=head2 read_preference

A L<MongoDB::ReadPreference> object.  It may be initialized with a string
corresponding to one of the valid read preference modes or a hash reference
that will be coerced into a new MongoDB::ReadPreference object.
By default it will be inherited from a L<MongoDB::Database> object.

=head2 write_concern

A L<MongoDB::WriteConcern> object.  It may be initialized with a hash
reference that will be coerced into a new MongoDB::WriteConcern object.
By default it will be inherited from a L<MongoDB::Database> object.

=head2 max_time_ms

Specifies the default maximum amount of time in milliseconds that the
server should use for working on a query.

B<Note>: this will only be used for server versions 2.6 or greater, as that
was when the C<$maxTimeMS> meta-operator was introduced.

=head2 bson_codec

An object that provides the C<encode_one> and C<decode_one> methods, such
as from L<MongoDB::BSON>.  It may be initialized with a hash reference that
will be coerced into a new MongoDB::BSON object.  By default it will be
inherited from a L<MongoDB::Database> object.

=head2 prefix

The prefix used for the collections.  Defaults to "fs".

=head1 METHODS

=head2 get

    $file = $grid->get($id);

Get a file from GridFS based on its _id.  Returns a L<MongoDB::GridFS::File>.

To retrieve a file based on metadata like C<filename>, use the L</find_one>
method instead.

=head2 put

    $id = $grid->put($fh, $metadata);
    $id = $grid->put($fh, {filename => "pic.jpg"});

Inserts a file into GridFS, adding a L<MongoDB::OID> as the _id field if the
field is not already defined.  This is a wrapper for C<MongoDB::GridFS::insert>,
see that method below for more information.

Returns the _id field.

=head2 delete

    $grid->delete($id)

Removes the file with the given _id.  Will die if the remove is unsuccessful.
Does not return anything on success.

=head2 find_one

    $file = $grid->find_one({"filename" => "foo.txt"});
    $file = $grid->find_one($criteria, $fields);

Returns a matching MongoDB::GridFS::File or undef.

=head2 remove

    $grid->remove({"filename" => "foo.txt"});
    $grid->remove({"filename" => "foo.txt"}, $options);

Cleanly removes files from the database.  C<$options> is a hash of options for
the remove.

A hashref of options may be provided with the following keys:

=over 4

=item *

C<just_one>: If true, only one file matching the criteria will be removed.

=item *

C<safe>: (DEPRECATED) If true, each remove will be checked for success and die on failure.  Set the L</write_concern> attribute instead.

=back

This method doesn't return anything.

=head2 insert

    $id = $gridfs->insert($fh);
    $id = $gridfs->insert($fh, $metadata);
    $id = $gridfs->insert($fh, $metadata, $options);

    $id = $gridfs->insert($fh, {"content-type" => "text/html"});

Reads from a file handle into the database.  Saves the file with the given
metadata.  The file handle must be readable.

A hashref of options may be provided with the following keys:

=over 4

=item *

C<safe>: (DEPRECATED) Will do safe inserts and check the MD5 hash calculated by the database against an MD5 hash calculated by the local filesystem.  If the two hashes do not match, then the chunks already inserted will be removed and the program will die. Set the L</write_concern> attribute instead.

=back

Because C<MongoDB::GridFS::insert> takes a file handle, it can be used to insert
very long strings into the database (as well as files).  C<$fh> must be a
FileHandle (not just the native file handle type), so you can insert a string
with:

    # open the string like a file
    open($basic_fh, '<', \$very_long_string);

    # turn the file handle into a FileHandle
    $fh = FileHandle->new;
    $fh->fdopen($basic_fh, 'r');

    $gridfs->insert($fh);

=head2 drop

    $grid->drop;

Removes all files' metadata and contents.

=head2 all

    @files = $grid->all;

Returns a list of the files in the database as L<MongoDB::GridFS::File>
objects.

=head1 DEPRECATION

B<Note>: This class has been deprecated in favor of
L<MongoDB::GridFSBucket>, which implements the new, driver-standard GridFS
API.  It is also faster and more flexible than this class.  This class will
be removed in a future release and you are encouraged to migrate your
applications to L<MongoDB::GridFSBucket>.

=head1 SEE ALSO

Core documentation on GridFS: L<http://dochub.mongodb.org/core/gridfs>.

=head1 AUTHORS

=over 4

=item *

David Golden <david@mongodb.com>

=item *

Rassi <rassi@mongodb.com>

=item *

Mike Friedman <friedo@friedo.com>

=item *

Kristina Chodorow <k.chodorow@gmail.com>

=item *

Florian Ragwitz <rafl@debian.org>

=back

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by MongoDB, Inc.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004

=cut