Difference between revisions of "API:EPrints/DataObj/File"

From EPrints Documentation
Jump to: navigation, search
Line 8: Line 8:
 
'''EPrints::DataObj::File''' - a stored file
 
'''EPrints::DataObj::File''' - a stored file
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
Line 23: Line 20:
 
This class is a subclass of [[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]].
 
This class is a subclass of [[API:EPrints/DataObj/SubObject|EPrints::DataObj::SubObject]].
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_core_fields -->
 
<!-- Pod2Wiki=head_core_fields -->
 
==CORE FIELDS==
 
==CORE FIELDS==
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* fileid
<span style='display:none'>User Comments</span>
+
: Unique identifier for this file.
<!-- Edit below this comment -->
+
  
 +
* rev_number (int)
 +
: The number of the current revision of this file.
  
<!-- Pod2Wiki= -->
+
* datasetid
</div>
+
: Id of the dataset of the parent object.
<!-- Pod2Wiki=item_fileid -->
+
===fileid===
+
  
Unique identifier for this file.
+
* objectid
 +
: Id of the parent object.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* filename
<span style='display:none'>User Comments</span>
+
: Name of the file (may contain directory separators).
<!-- Edit below this comment -->
+
  
 +
* mime_type
 +
: MIME type of the file (e.g. "image/png").
  
<!-- Pod2Wiki= -->
+
* hash
</div>
+
: Check sum of the file.
<!-- Pod2Wiki=item_rev_number -->
+
===rev_number (int)===
+
  
The number of the current revision of this file.
+
* hash_type
 +
: Name of check sum algorithm used (e.g. "MD5").
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* filesize
<span style='display:none'>User Comments</span>
+
: Size of the file in bytes.
<!-- Edit below this comment -->
+
  
 +
* mtime
 +
: Last modification time of the file.
  
<!-- Pod2Wiki= -->
+
* url
</div>
+
: Virtual field for storing the file's URL.
<!-- Pod2Wiki=item_datasetid -->
+
===datasetid===
+
  
Id of the dataset of the parent object.
+
* data
 +
: Virtual field for storing the file's content.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
<!-- Pod2Wiki=item_objectid -->
 
===objectid===
 
 
Id of the parent object.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_filename -->
 
===filename===
 
 
Name of the file (may contain directory separators).
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_mime_type -->
 
===mime_type===
 
 
MIME type of the file (e.g. "image/png").
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_hash -->
 
===hash===
 
 
Check sum of the file.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_hash_type -->
 
===hash_type===
 
 
Name of check sum algorithm used (e.g. "MD5").
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_filesize -->
 
===filesize===
 
 
Size of the file in bytes.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_mtime -->
 
===mtime===
 
 
Last modification time of the file.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_url -->
 
===url===
 
 
Virtual field for storing the file's URL.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_data -->
 
===data===
 
 
Virtual field for storing the file's content.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
 
<!-- Pod2Wiki=head_methods -->
 
<!-- Pod2Wiki=head_methods -->
 
==METHODS==
 
==METHODS==
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
 
<!-- Pod2Wiki=head_constructor_methods -->
 
<!-- Pod2Wiki=head_constructor_methods -->
 
===Constructor Methods===
 
===Constructor Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_new_from_filename -->
<!-- Pod2Wiki=item_new_from_filename -->
+
===new_from_filename===
====new_from_filename====
+
 
 +
<source lang="perl">$dataobj = EPrints::DataObj::File->new_from_filename( $session, $dataobj, $filename )
  
$dataobj = EPrints::DataObj::File-&gt;new_from_filename( $session, $dataobj, $filename )
+
</source>
 
Convenience method to get an existing File object for $filename stored in $dataobj.
 
Convenience method to get an existing File object for $filename stored in $dataobj.
  
 
Returns undef if no such record exists.
 
Returns undef if no such record exists.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create_from_data -->
<!-- Pod2Wiki=item_create_from_data -->
+
===create_from_data===
====create_from_data====
+
  
$dataobj = EPrints::DataObj::File-&gt;create_from_data( $session, $data [, $dataset ] )
+
<source lang="perl">$dataobj = EPrints::DataObj::File->create_from_data( $session, $data [, $dataset ] )
 +
 
 +
</source>
 
Create a new File record using $data.
 
Create a new File record using $data.
  
 
Private data elements:
 
Private data elements:
  
  _content - content to pass to [[API:EPrints/DataObj/File#set_file|set_file]].
+
<pre>  _content - content to pass to [[API:EPrints/DataObj/File#set_file|set_file]].
   _filepath - path to source file used for improved mime-type detection
+
   _filepath - path to source file used for improved mime-type detection</pre>
 
+
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<span style='display:none'>User Comments</span>
+
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_class_methods -->
 
<!-- Pod2Wiki=head_class_methods -->
 
===Class Methods===
 
===Class Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_get_system_field_info -->
<!-- Pod2Wiki=item_get_system_field_info -->
+
===get_system_field_info===
====get_system_field_info====
+
  
$thing = EPrints::DataObj::File-&gt;get_system_field_info
+
<source lang="perl">$thing = EPrints::DataObj::File->get_system_field_info
 +
 
 +
</source>
 
Core fields.
 
Core fields.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_get_dataset_id -->
<!-- Pod2Wiki=item_get_dataset_id -->
+
===get_dataset_id===
====get_dataset_id====
+
 
 +
<source lang="perl">$dataset = EPrints::DataObj::File->get_dataset_id
  
$dataset = EPrints::DataObj::File-&gt;get_dataset_id
+
</source>
 
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
 
Returns the id of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_object_methods -->
 
<!-- Pod2Wiki=head_object_methods -->
 
===Object Methods===
 
===Object Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* $new_file = $file-&gt;clone( $parent )
<span style='display:none'>User Comments</span>
+
: Clone the $file object (including contained files) and return the new object.
<!-- Edit below this comment -->
+
  
 +
* $success = $file-&gt;remove
 +
: Delete the stored file.
  
<!-- Pod2Wiki= -->
+
* $file-&gt;update( $epdata )
</div>
+
* $filename = $file-&gt;get_local_copy()
<!-- Pod2Wiki=item_clone -->
+
: Return the name of a local copy of the file (may be a {{API:PodLink|file=File/Temp|package_name=File::Temp|section=|text=File::Temp}} object).
====clone====
+
  
$new_file = $file-&gt;clone( $parent )
+
: Will retrieve and cache the remote object if necessary.
Clone the $file object (including contained files) and return the new object.
+
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* $success = $file-&gt;add_file( $filepath, $filename [, $preserve_path ] )
<span style='display:none'>User Comments</span>
+
: Read and store the contents of $filepath at $filename.
<!-- Edit below this comment -->
+
  
 +
: If $preserve_path is untrue will strip any leading path in $filename.
  
<!-- Pod2Wiki= -->
+
* $bytes = $file-&gt;upload( $filehandle, $filename, $filesize [, $preserve_path ] )
</div>
+
: Read and store the data from $filehandle at $filename at the next revision number.
<!-- Pod2Wiki=item_remove -->
+
====remove====
+
  
$success = $file-&gt;remove
+
: If $preserve_path is untrue will strip any leading path in $filename.
Delete the stored file.
+
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: Returns the number of bytes read from $filehandle or undef on failure.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
* $success = $stored-&gt;write_copy( $filename )
 +
: Write a copy of this file to $filename.
  
<!-- Pod2Wiki= -->
+
: Returns true if the written file contains the same number of bytes as the stored file.
</div>
+
<!-- Pod2Wiki=item_get_local_copy -->
+
====get_local_copy====
+
  
$filename = $file-&gt;get_local_copy()
+
* $success = $stored-&gt;write_copy_fh( $filehandle )
Return the name of a local copy of the file (may be a {{API:PodLink|file=File/Temp|package_name=File::Temp|section=|text=File::Temp}} object).
+
: Write a copy of this file to $filehandle.
  
Will retrieve and cache the remote object if necessary.
+
* $md5 = $stored-&gt;generate_md5
 +
: Calculates and returns the MD5 for this file.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* $digest = $file-&gt;generate_sha( [ ALGORITHM ] )
<span style='display:none'>User Comments</span>
+
: Generate a SHA for this file, see {{API:PodLink|file=Digest/SHA|package_name=Digest::SHA|section=|text=Digest::SHA}} for a list of supported algorithms. Defaults to "256" (SHA-256).
<!-- Edit below this comment -->
+
  
 +
: Returns the hex-encoded digest.
  
<!-- Pod2Wiki= -->
+
* $stored-&gt;add_plugin_copy( $plugin, $sourceid )
</div>
+
: Add a copy of this file stored using $plugin identified by $sourceid.
<!-- Pod2Wiki=item_add_file -->
+
====add_file====
+
  
$success = $file-&gt;add_file( $filepath, $filename [, $preserve_path ] )
+
* $stored-&gt;remove_plugin_copy( $plugin )
Read and store the contents of $filepath at $filename.
+
: Remove the copy of this file stored using $plugin.
  
If $preserve_path is untrue will strip any leading path in $filename.
+
* $success = $stored-&gt;get_file( CALLBACK [, $offset, $n ] )
 +
: Get the contents of the stored file.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: $offset is the position in bytes to start reading from, defaults to 0.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
: $n is the number of bytes to read, defaults to <code>filesize</code>.
  
<!-- Pod2Wiki= -->
+
: CALLBACK is:
</div>
+
<!-- Pod2Wiki=item_upload -->
+
====upload====
+
  
  $bytes = $file-&gt;upload( $filehandle, $filename, $filesize [, $preserve_path ] )
+
<pre> sub {
Read and store the data from $filehandle at $filename at the next revision number.
+
    my( $buffer ) = @_;
 +
    ...
 +
    return 1;
 +
  }</pre>
  
If $preserve_path is untrue will strip any leading path in $filename.
+
* $content_length = $stored-&gt;set_file( CONTENT, $content_length )
 +
: Write $content_length bytes from CONTENT to the file object. Updates <code>filesize</code> and <code>hash</code> (you must call [[API:EPrints/DataObj/File#commit|commit]]).
  
Returns the number of bytes read from $filehandle or undef on failure.
+
: Returns $content_length or undef on failure.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: CONTENT may be one of:
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
** CODEREF
 +
:: Will be called until it returns empty string ("").
  
<!-- Pod2Wiki= -->
+
** SCALARREF
</div>
+
:: A scalar reference to a string of octets that will be written as-is.
<!-- Pod2Wiki=item_write_copy -->
+
====write_copy====
+
  
$success = $stored-&gt;write_copy( $filename )
+
** GLOB
Write a copy of this file to $filename.
+
:: Will be treated as a file handle and read with sysread().
  
Returns true if the written file contains the same number of bytes as the stored file.
+
* $content_length = $file-&gt;set_file_chunk( CONTENT, $content_length, $offset, $total )
 +
: Write a chunk of data to the content, overwriting or appending to the existing content. See [[API:EPrints/DataObj/File#set_file|set_file]] for CONTENT and $content_length. <code>filesize</code> is updated if $offset + $content_length is greater than the current <code>filesize</code>.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: $offset is the starting point (in bytes) to write. $total is the total file size, used to determine where to store the content.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
: Returns the number of bytes written or undef on failure.
  
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_write_copy_fh -->
 
====write_copy_fh====
 
 
$success = $stored-&gt;write_copy_fh( $filehandle )
 
Write a copy of this file to $filehandle.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_see_also -->
<!-- Pod2Wiki=item_generate_md5 -->
+
==SEE ALSO==
====generate_md5====
+
: [[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
 
+
$md5 = $stored-&gt;generate_md5
+
Calculates and returns the MD5 for this file.
+
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_copyright -->
<!-- Pod2Wiki=item_generate_sha -->
+
==COPYRIGHT==
====generate_sha====
+
: Copyright 2000-2011 University of Southampton.
  
$digest = $file-&gt;generate_sha( [ ALGORITHM ] )
+
: This file is part of EPrints http://www.eprints.org/.
Generate a SHA for this file, see {{API:PodLink|file=Digest/SHA/PurePerl|package_name=Digest::SHA::PurePerl|section=|text=Digest::SHA::PurePerl}} for a list of supported algorithms. Defaults to "256" (SHA-256).
+
  
Returns the hex-encoded digest.
+
: EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSESee the GNU Lesser General Public License for more details.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
: You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
  
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_add_plugin_copy -->
 
====add_plugin_copy====
 
 
$stored-&gt;add_plugin_copy( $plugin, $sourceid )
 
Add a copy of this file stored using $plugin identified by $sourceid.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=_postamble_ -->
<!-- Pod2Wiki=item_remove_plugin_copy -->
+
====remove_plugin_copy====
+
 
+
$stored-&gt;remove_plugin_copy( $plugin )
+
Remove the copy of this file stored using $plugin.
+
 
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<span style='display:none'>User Comments</span>
+
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_get_file -->
 
====get_file====
 
 
$success = $stored-&gt;get_file( CALLBACK [, $offset, $n ] )
 
Get the contents of the stored file - see [[API:EPrints/Storage#retrieve|EPrints::Storage/retrieve]].
 
 
$offset is the position in bytes to start reading from, default 0.
 
 
$n is the number of bytes to read, default <tt>filesize</tt>.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_set_file -->
 
====set_file====
 
 
$content_length = $stored-&gt;set_file( CONTENT, $content_length )
 
Reads data from CONTENT and stores it. Sets the MD5 hash and filesize.
 
 
If the write failed returns undef and sets the filesize to 0.
 
 
CONTENT may be one of:
 
 
  CODEREF - will be called until it returns empty string ("")
 
  SCALARREF - a scalar reference will be used as-is (expects bytes)
 
  GLOB - will be treated as a file handle and read with sysread()
 
 
 
This method does not check the actual number of bytes read is the same as $content_length.
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=head_see_also -->
 
==SEE ALSO==
 
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
 
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=head_copyright -->
 
==COPYRIGHT==
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 

Revision as of 09:57, 22 January 2013

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::File - a stored file


DESCRIPTION

This class contains the technical metadata associated with a file. A file is a sequence of bytes stored in the storage layer (a "stored object"). Utility methods for storing and retrieving the stored object from the storage layer are made available.

Revision numbers on File work slightly differently to other objects. A File is only revised when it's stored object is changed and not when changes to it's metadata are made.

This class is a subclass of EPrints::DataObj::SubObject.


CORE FIELDS

  • fileid
Unique identifier for this file.
  • rev_number (int)
The number of the current revision of this file.
  • datasetid
Id of the dataset of the parent object.
  • objectid
Id of the parent object.
  • filename
Name of the file (may contain directory separators).
  • mime_type
MIME type of the file (e.g. "image/png").
  • hash
Check sum of the file.
  • hash_type
Name of check sum algorithm used (e.g. "MD5").
  • filesize
Size of the file in bytes.
  • mtime
Last modification time of the file.
  • url
Virtual field for storing the file's URL.
  • data
Virtual field for storing the file's content.


METHODS

Constructor Methods

new_from_filename

$dataobj = EPrints::DataObj::File->new_from_filename( $session, $dataobj, $filename )

Convenience method to get an existing File object for $filename stored in $dataobj.

Returns undef if no such record exists.


create_from_data

$dataobj = EPrints::DataObj::File->create_from_data( $session, $data [, $dataset ] )

Create a new File record using $data.

Private data elements:

  _content - content to pass to [[API:EPrints/DataObj/File#set_file|set_file]].
  _filepath - path to source file used for improved mime-type detection


Class Methods

get_system_field_info

$thing = EPrints::DataObj::File->get_system_field_info

Core fields.


get_dataset_id

$dataset = EPrints::DataObj::File->get_dataset_id

Returns the id of the EPrints::DataSet object to which this record belongs.


Object Methods

  • $new_file = $file->clone( $parent )
Clone the $file object (including contained files) and return the new object.
  • $success = $file->remove
Delete the stored file.
  • $file->update( $epdata )
  • $filename = $file->get_local_copy()
Return the name of a local copy of the file (may be a File::Temp object).
Will retrieve and cache the remote object if necessary.
  • $success = $file->add_file( $filepath, $filename [, $preserve_path ] )
Read and store the contents of $filepath at $filename.
If $preserve_path is untrue will strip any leading path in $filename.
  • $bytes = $file->upload( $filehandle, $filename, $filesize [, $preserve_path ] )
Read and store the data from $filehandle at $filename at the next revision number.
If $preserve_path is untrue will strip any leading path in $filename.
Returns the number of bytes read from $filehandle or undef on failure.
  • $success = $stored->write_copy( $filename )
Write a copy of this file to $filename.
Returns true if the written file contains the same number of bytes as the stored file.
  • $success = $stored->write_copy_fh( $filehandle )
Write a copy of this file to $filehandle.
  • $md5 = $stored->generate_md5
Calculates and returns the MD5 for this file.
  • $digest = $file->generate_sha( [ ALGORITHM ] )
Generate a SHA for this file, see Digest::SHA for a list of supported algorithms. Defaults to "256" (SHA-256).
Returns the hex-encoded digest.
  • $stored->add_plugin_copy( $plugin, $sourceid )
Add a copy of this file stored using $plugin identified by $sourceid.
  • $stored->remove_plugin_copy( $plugin )
Remove the copy of this file stored using $plugin.
  • $success = $stored->get_file( CALLBACK [, $offset, $n ] )
Get the contents of the stored file.
$offset is the position in bytes to start reading from, defaults to 0.
$n is the number of bytes to read, defaults to filesize.
CALLBACK is:
  sub {
    my( $buffer ) = @_;
    ...
    return 1;
  }
  • $content_length = $stored->set_file( CONTENT, $content_length )
Write $content_length bytes from CONTENT to the file object. Updates filesize and hash (you must call commit).
Returns $content_length or undef on failure.
CONTENT may be one of:
    • CODEREF
Will be called until it returns empty string ("").
    • SCALARREF
A scalar reference to a string of octets that will be written as-is.
    • GLOB
Will be treated as a file handle and read with sysread().
  • $content_length = $file->set_file_chunk( CONTENT, $content_length, $offset, $total )
Write a chunk of data to the content, overwriting or appending to the existing content. See set_file for CONTENT and $content_length. filesize is updated if $offset + $content_length is greater than the current filesize.
$offset is the starting point (in bytes) to write. $total is the total file size, used to determine where to store the content.
Returns the number of bytes written or undef on failure.


SEE ALSO

EPrints::DataObj and EPrints::DataSet.


COPYRIGHT

Copyright 2000-2011 University of Southampton.
This file is part of EPrints http://www.eprints.org/.
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.