/**
* Constructor
*/
function ArtworkFile()
{
parent::MonographFile();
}
/**
* Create an array that describes an uploaded file which can
* be used in a JSON response.
* @param MonographFile $uploadedFile
* @return array
*/
function &_getUploadedFileInfo(&$uploadedFile)
{
$uploadedFileInfo = array('uploadedFile' => array('fileId' => $uploadedFile->getFileId(), 'revision' => $uploadedFile->getRevision()));
return $uploadedFileInfo;
}
/**
* Routine to instantiate and pre-populate a new monograph file.
* @param $monographId integer
* @param $fileStage integer
* @param $revisedFileId integer
* @param $genreId integer
* @param $assocId integer
* @param $assocType integer
* @return MonographFile returns the instantiated monograph file or null if an error occurs.
*/
function &_instantiateMonographFile($monographId, $fileStage, $revisedFileId, $genreId, $assocId, $assocType)
{
// Instantiate a new monograph file.
$monographFile = new MonographFile();
$monographFile->setMonographId($monographId);
// Do we create a new file or a new revision of an existing file?
if ($revisedFileId) {
// Retrieve the revised file.
$submissionFileDao =& DAORegistry::getDAO('SubmissionFileDAO');
/* @var $submissionFileDao SubmissionFileDAO */
$revisedFile =& $submissionFileDao->getLatestRevision($revisedFileId, $fileStage, $monographId);
if (!is_a($revisedFile, 'MonographFile')) {
return false;
}
// Create a new revision of the file with the existing file id.
$monographFile->setFileId($revisedFileId);
$monographFile->setRevision($revisedFile->getRevision() + 1);
// Make sure that the monograph of the revised file is
// the same as that of the uploaded file.
assert($revisedFile->getMonographId() == $monographId);
$nullVar = null;
if ($revisedFile->getMonographId() != $monographId) {
return $nullVar;
}
// Copy the file workflow stage.
assert(is_null($fileStage) || $fileStage == $revisedFile->getFileStage());
$fileStage = (int) $revisedFile->getFileStage();
// Copy the file genre.
assert(is_null($genreId) || $genreId == $revisedFile->getGenreId());
$genreId = (int) $revisedFile->getGenreId();
// Copy the assoc type.
assert(is_null($assocType) || $assocType == $revisedFile->getAssocType());
$assocType = (int) $revisedFile->getAssocType();
// Copy the assoc id.
assert(is_null($assocId) || $assocId == $revisedFile->getAssocId());
$assocId = (int) $revisedFile->getAssocId();
} else {
// Create the first revision of a new file.
$monographFile->setRevision(1);
}
// Set a preliminary file name and file size.
$monographFile->setFileName('unknown');
$monographFile->setFileSize(0);
// Set the file file stage.
$monographFile->setFileStage($fileStage);
// Set the file genre (if given).
if (isset($genreId)) {
$monographFile->setGenreId($genreId);
}
// Set modification dates to the current system date.
$monographFile->setDateUploaded(Core::getCurrentDate());
$monographFile->setDateModified(Core::getCurrentDate());
// Is the monograph file associated to another entity?
if (isset($assocId)) {
assert(isset($assocType));
$monographFile->setAssocType($assocType);
$monographFile->setAssocId($assocId);
}
// Return the pre-populated monograph file.
return $monographFile;
}
/**
* @covers SubmissionFileDAO
* @covers PKPSubmissionFileDAO
* @covers MonographFileDAODelegate
* @covers ArtworkFileDAODelegate
* @covers SubmissionFileDAODelegate
*/
public function testSubmissionFileCrud()
{
//
// Create test data.
//
// Create two test files, one monograph file one artwork file.
$file1Rev1 = new ArtworkFile();
$file1Rev1->setName('test-artwork', 'en_US');
$file1Rev1->setCaption('test-caption');
$file1Rev1->setFileStage(MONOGRAPH_FILE_PRODUCTION);
$file1Rev1->setSubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
$file1Rev1->setFileType('image/jpeg');
$file1Rev1->setFileSize(512);
$file1Rev1->setDateUploaded('2011-12-04 00:00:00');
$file1Rev1->setDateModified('2011-12-04 00:00:00');
$file1Rev1->setAssocType(ASSOC_TYPE_REVIEW_ASSIGNMENT);
$file1Rev1->setAssocId(5);
$file2Rev1 = new MonographFile();
$file2Rev1->setName('test-document', 'en_US');
$file2Rev1->setFileStage(MONOGRAPH_FILE_PRODUCTION);
$file2Rev1->setSubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
$file2Rev1->setFileType('application/pdf');
$file2Rev1->setFileSize(256);
$file2Rev1->setDateUploaded('2011-12-05 00:00:00');
$file2Rev1->setDateModified('2011-12-05 00:00:00');
//
// isInlineable()
//
// Test the isInlineable method.
$submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');
/* @var $submissionFileDao SubmissionFileDAO */
self::assertFalse($submissionFileDao->isInlineable($file2Rev1));
self::assertTrue($submissionFileDao->isInlineable($file1Rev1));
//
// insertObject()
//
// Persist the two test files.
$this->_insertFile($file1Rev1, 'test artwork', SUBMISSION_FILE_DAO_TEST_ART_GENRE_ID);
self::assertType('ArtworkFile', $file1Rev1);
$this->_insertFile($file2Rev1, 'test monograph', SUBMISSION_FILE_DAO_TEST_DOC_GENRE_ID);
self::assertType('MonographFile', $file2Rev1);
// Persist a second revision of the artwork file but this time with a
// document genre so that it needs to be downcast for insert.
$downcastFile =& cloneObject($file1Rev1);
/* @var $downcastFile ArtworkFile */
$downcastFile->setRevision(2);
$downcastFile->setDateUploaded('2011-12-05 00:00:00');
$downcastFile->setDateModified('2011-12-05 00:00:00');
$file1Rev2 =& $this->_insertFile($downcastFile, 'test downcast', SUBMISSION_FILE_DAO_TEST_DOC_GENRE_ID);
// Test whether the target type is correct.
self::assertType('MonographFile', $file1Rev2);
// Test that no data on the target interface has been lost.
$this->_compareFiles($downcastFile, $file1Rev2);
// Persist a second revision of the monograph file but this time with an
// artwork genre so that it needs to be upcast for insert.
$upcastFile =& cloneObject($file2Rev1);
/* @var $upcastFile MonographFile */
$upcastFile->setRevision(2);
$file2Rev2 =& $this->_insertFile($upcastFile, 'test upcast', SUBMISSION_FILE_DAO_TEST_ART_GENRE_ID);
// Test whether the target type is correct.
self::assertType('ArtworkFile', $file2Rev2);
// Test that no data on the target interface has been lost.
$this->_compareFiles($upcastFile, $file2Rev2);
// Make sure that other fields contain default values as
// they are empty on upcast.
self::assertNull($file2Rev2->getCaption());
//
// getRevision()
//
// Retrieve the first revision of the artwork file.
self::assertNull($submissionFileDao->getRevision(null, $file1Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), null));
self::assertEquals($file1Rev1, $submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
self::assertEquals($file1Rev1, $submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision(), $file1Rev1->getFileStage()));
self::assertEquals($file1Rev1, $submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision(), $file1Rev1->getFileStage(), SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision(), MONOGRAPH_FILE_PRODUCTION + 1));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
//
// updateObject()
//
// Update the artwork file.
$file1Rev1->setOriginalFileName('updated-file-name');
$file1Rev1->setCaption('test-caption');
$updatedFile =& $submissionFileDao->updateObject($file1Rev1);
// Now change the genre so that the canonical file name
// and the file implementation will have to change.
$previousFilePath = $file1Rev1->getFilePath();
$file1Rev1->setGenreId(SUBMISSION_FILE_DAO_TEST_DOC_GENRE_ID);
$updatedFile =& $submissionFileDao->updateObject($file1Rev1);
// Test whether the target type is correct.
self::assertType('MonographFile', $updatedFile);
// Test that no data on the target interface has been lost.
$this->_compareFiles($file1Rev1, $updatedFile);
// Test the new file path and files.
$newFilePath = $updatedFile->getFilePath();
self::assertNotEquals($previousFilePath, $newFilePath);
self::assertFileNotExists($previousFilePath);
self::assertFileExists($newFilePath);
// Now change the genre back so that we can test casting
// in the other direction.
$updatedFile->setGenreId(SUBMISSION_FILE_DAO_TEST_ART_GENRE_ID);
$updatedFile =& $submissionFileDao->updateObject($updatedFile);
// Test whether the target type is correct.
self::assertType('ArtworkFile', $updatedFile);
// Test that no data on the target interface has been lost.
$this->_compareFiles($file1Rev1, $updatedFile);
// Make sure that other fields contain default values as
// they are lost on double recast.
self::assertNull($updatedFile->getCaption());
$file1Rev1 = $updatedFile;
//
// getLatestRevision()
//
// Retrieve the latest revision of file 1.
self::assertNull($submissionFileDao->getLatestRevision(null));
self::assertEquals($file1Rev2, $submissionFileDao->getLatestRevision($file1Rev1->getFileId()));
self::assertEquals($file1Rev2, $submissionFileDao->getLatestRevision($file1Rev1->getFileId(), $file1Rev1->getFileStage()));
self::assertEquals($file1Rev2, $submissionFileDao->getLatestRevision($file1Rev1->getFileId(), $file1Rev1->getFileStage(), SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getLatestRevision($file1Rev1->getFileId(), MONOGRAPH_FILE_PRODUCTION + 1));
self::assertNull($submissionFileDao->getLatestRevision($file1Rev1->getFileId(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
//
// getLatestRevisions()
//
// Calculate the unique ids of the test files.
$uniqueId1_1 = $file1Rev1->getFileIdAndRevision();
$uniqueId1_2 = $file1Rev2->getFileIdAndRevision();
$uniqueId2_1 = $file2Rev1->getFileIdAndRevision();
$uniqueId2_2 = $file2Rev2->getFileIdAndRevision();
// Retrieve the latest revisions of both files.
self::assertNull($submissionFileDao->getLatestRevisions(null));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId2_2 => $file2Rev2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId2_2 => $file2Rev2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
self::assertEquals(array(), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, MONOGRAPH_FILE_PRODUCTION + 1));
// Test paging.
$rangeInfo = new DBResultRange(2, 1);
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId2_2 => $file2Rev2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
$rangeInfo = new DBResultRange(1, 1);
self::assertEquals(array($uniqueId1_2 => $file1Rev2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
$rangeInfo = new DBResultRange(1, 2);
self::assertEquals(array($uniqueId2_2 => $file2Rev2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
//
// getAllRevisions()
//
// Retrieve all revisions of file 1.
self::assertNull($submissionFileDao->getAllRevisions(null));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId1_1 => $file1Rev1), $submissionFileDao->getAllRevisions($file1Rev1->getFileId(), MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId1_1 => $file1Rev1), $submissionFileDao->getAllRevisions($file1Rev1->getFileId(), MONOGRAPH_FILE_PRODUCTION, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertEquals(array(), $submissionFileDao->getAllRevisions($file1Rev1->getFileId(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
self::assertEquals(array(), $submissionFileDao->getAllRevisions($file1Rev1->getFileId(), MONOGRAPH_FILE_PRODUCTION + 1, null));
//
// getLatestRevisionsByAssocId()
//
// Retrieve the latest revisions by association.
self::assertNull($submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, null));
self::assertNull($submissionFileDao->getLatestRevisionsByAssocId(null, 5));
self::assertEquals(array($uniqueId1_2 => $file1Rev2), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertEquals(array($uniqueId1_2 => $file1Rev2), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION + 1));
// Retrieve all revisions by association.
self::assertNull($submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, null));
self::assertNull($submissionFileDao->getAllRevisionsByAssocId(null, 5));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId1_1 => $file1Rev1), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertEquals(array($uniqueId1_2 => $file1Rev2, $uniqueId1_1 => $file1Rev1), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION + 1));
//
// assignRevisionToReviewRound()
//
// Insert one more revision to test review round file assignments.
$file1Rev3 = cloneObject($file1Rev2);
$file1Rev3->setRevision(3);
self::assertEquals($file1Rev3, $submissionFileDao->insertObject($file1Rev3, $this->testFile));
$uniqueId1_3 = $file1Rev3->getFileIdAndRevision();
// Insert review round file assignments.
$submissionFileDao->assignRevisionToReviewRound($file1Rev1->getFileId(), $file1Rev1->getRevision(), REVIEW_TYPE_INTERNAL, 1, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
$submissionFileDao->assignRevisionToReviewRound($file2Rev2->getFileId(), $file2Rev2->getRevision(), REVIEW_TYPE_INTERNAL, 1, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
//
// getRevisionsByReviewRound()
//
// Retrieve assigned review round files by review type and round.
self::assertEquals(array($uniqueId1_1 => $file1Rev1, $uniqueId2_2 => $file2Rev2), $submissionFileDao->getRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, REVIEW_TYPE_INTERNAL, 1));
self::assertNull($submissionFileDao->getRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, null));
//
// getLatestNewRevisionsByReviewRound()
//
// Retrieve revisions of review round files that are newer than the review round files themselves.
self::assertEquals(array($uniqueId1_3 => $file1Rev3), $submissionFileDao->getLatestNewRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, REVIEW_TYPE_INTERNAL, 1));
self::assertNull($submissionFileDao->getLatestNewRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, null));
//
// deleteAllRevisionsByReviewRound()
//
$submissionFileDao->deleteAllRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, REVIEW_TYPE_INTERNAL, 1);
self::assertEquals(array(), $submissionFileDao->getRevisionsByReviewRound(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, REVIEW_TYPE_INTERNAL, 1));
//
// deleteRevision() and deleteRevisionById()
//
// Delete the first revision of file1.
// NB: This implicitly tests deletion by ID.
self::assertEquals(1, $submissionFileDao->deleteRevision($file1Rev1));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
// Re-insert the file for the next test.
self::assertEquals($file1Rev1, $submissionFileDao->insertObject($file1Rev1, $this->testFile));
//
// deleteLatestRevisionById()
//
// Delete the latest revision of file1.
self::assertEquals(1, $submissionFileDao->deleteLatestRevisionById($file1Rev1->getFileId()));
self::assertType('ArtworkFile', $submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev3->getFileId(), $file1Rev3->getRevision()));
//
// deleteAllRevisionsById()
//
// Delete all revisions of file1.
self::assertEquals(2, $submissionFileDao->deleteAllRevisionsById($file1Rev1->getFileId()));
self::assertType('MonographFile', $submissionFileDao->getRevision($file2Rev1->getFileId(), $file2Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev2->getFileId(), $file1Rev2->getRevision()));
// Re-insert the files for the next test.
self::assertEquals($file1Rev1, $submissionFileDao->insertObject($file1Rev1, $this->testFile));
self::assertEquals($file1Rev2, $submissionFileDao->insertObject($file1Rev2, $this->testFile));
//
// deleteAllRevisionsByAssocId()
//
// Delete all revisions by assoc id.
self::assertEquals(2, $submissionFileDao->deleteAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertType('MonographFile', $submissionFileDao->getRevision($file2Rev1->getFileId(), $file2Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev2->getFileId(), $file1Rev2->getRevision()));
// Re-insert the files for the next test.
self::assertEquals($file1Rev1, $submissionFileDao->insertObject($file1Rev1, $this->testFile));
self::assertEquals($file1Rev2, $submissionFileDao->insertObject($file1Rev2, $this->testFile));
//
// deleteAllRevisionsBySubmissionId()
//
// Delete all revisions by submission id.
self::assertEquals(4, $submissionFileDao->deleteAllRevisionsBySubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getRevision($file2Rev1->getFileId(), $file2Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev1->getFileId(), $file1Rev1->getRevision()));
self::assertNull($submissionFileDao->getRevision($file1Rev2->getFileId(), $file1Rev2->getRevision()));
//
// insertObject() for new revisions
//
// Test insertion of new revisions.
// Create two files with different file ids.
$file1Rev1->setFileId(null);
$file1Rev1->setRevision(null);
$file1Rev1 =& $submissionFileDao->insertObject($file1Rev1, $this->testFile);
$file1Rev2->setFileId(null);
$file1Rev2->setRevision(null);
$file1Rev2->setGenreId(SUBMISSION_FILE_DAO_TEST_DOC_GENRE_ID);
$file1Rev2 =& $submissionFileDao->insertObject($file1Rev2, $this->testFile);
// Test the file ids, revisions and identifying fields.
self::assertNotEquals($file1Rev1->getFileId(), $file1Rev2->getFileId());
self::assertNotEquals($file1Rev1->getGenreId(), $file1Rev2->getGenreId());
self::assertEquals(1, $submissionFileDao->getLatestRevisionNumber($file1Rev1->getFileId()));
self::assertEquals(1, $submissionFileDao->getLatestRevisionNumber($file1Rev2->getFileId()));
//
// setAsLatestRevision()
//
// Now make the second file a revision of the first.
$file1Rev2 =& $submissionFileDao->setAsLatestRevision($file1Rev1->getFileId(), $file1Rev2->getFileId(), $file1Rev1->getSubmissionId(), $file1Rev1->getFileStage());
// And test the file ids, revisions, identifying fields and types again.
self::assertEquals($file1Rev1->getFileId(), $file1Rev2->getFileId());
self::assertEquals($file1Rev1->getGenreId(), $file1Rev2->getGenreId());
self::assertEquals(1, $file1Rev1->getRevision());
self::assertEquals(2, $submissionFileDao->getLatestRevisionNumber($file1Rev1->getFileId()));
$submissionFiles =& $submissionFileDao->getAllRevisions($file1Rev1->getFileId());
self::assertEquals(2, count($submissionFiles));
foreach ($submissionFiles as $submissionFile) {
/* @var $submissionFile SubmissionFile */
self::assertType('ArtworkFile', $submissionFile);
}
}
/**
* Constructor.
*/
function MonographGalley()
{
parent::DataObject();
}
/**
* @covers SubmissionFileDAO
* @covers PKPSubmissionFileDAO
* @covers MonographFileDAODelegate
* @covers ArtworkFileDAODelegate
* @covers SubmissionFileDAODelegate
*/
public function testCitationCrud()
{
// Create two test files, one monograph file one artwork file.
$artworkFile1 = new ArtworkFile();
$artworkFile1->setName('test-artwork', 'en_US');
$artworkFile1->setFileName('test-artwork.jpg');
$artworkFile1->setCaption('test-caption');
$artworkFile1->setFileStage(MONOGRAPH_FILE_PRODUCTION);
$artworkFile1->setSubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
$artworkFile1->setFileType('image/jpeg');
$artworkFile1->setFileSize(512);
$artworkFile1->setDateUploaded('2011-12-04 00:00:00');
$artworkFile1->setDateModified('2011-12-04 00:00:00');
$artworkFile1->setGenreId(2);
$artworkFile1->setAssocType(ASSOC_TYPE_REVIEW_ASSIGNMENT);
$artworkFile1->setAssocId(5);
$monographFile = new MonographFile();
$monographFile->setName('test-document', 'en_US');
$monographFile->setFileName('test-file.doc');
$monographFile->setFileStage(MONOGRAPH_FILE_PRODUCTION);
$monographFile->setSubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID);
$monographFile->setFileType('application/pdf');
$monographFile->setFileSize(256);
$monographFile->setDateUploaded('2011-12-05 00:00:00');
$monographFile->setDateModified('2011-12-05 00:00:00');
$monographFile->setGenreId(1);
// Test the isInlineable method.
$submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');
/* @var $submissionFileDao SubmissionFileDAO */
self::assertFalse($submissionFileDao->isInlineable($monographFile));
self::assertTrue($submissionFileDao->isInlineable($artworkFile1));
// Persist the two test files.
$artworkFile1 =& $submissionFileDao->insertObject($artworkFile1);
/* @var $artworkFile1 ArtworkFile */
$monographFile =& $submissionFileDao->insertObject($monographFile);
// Persist a second revision of the artwork file.
$artworkFile2 =& cloneObject($artworkFile1);
/* @var $artworkFile2 ArtworkFile */
$artworkFile2->setRevision(2);
$artworkFile2->setDateUploaded('2011-12-05 00:00:00');
$artworkFile2->setDateModified('2011-12-05 00:00:00');
$artworkFile2 =& $submissionFileDao->insertObject($artworkFile2);
// Retrieve the first revision of the artwork file.
self::assertNull($submissionFileDao->getRevision(null, $artworkFile1->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), null));
self::assertEquals($artworkFile1, $submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
self::assertEquals($artworkFile1, $submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision(), $artworkFile1->getFileStage()));
self::assertEquals($artworkFile1, $submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision(), $artworkFile1->getFileStage(), SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision(), MONOGRAPH_FILE_PRODUCTION + 1));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
// Update the latest revision of the artwork file.
$artworkFile2->setOriginalFileName('updated-file-name');
$artworkFile2->setCaption('test-caption');
self::assertTrue($submissionFileDao->updateObject($artworkFile2));
// Retrieve the latest revision of the artwork file.
self::assertNull($submissionFileDao->getLatestRevision(null));
self::assertEquals($artworkFile2, $submissionFileDao->getLatestRevision($artworkFile2->getFileId()));
self::assertEquals($artworkFile2, $submissionFileDao->getLatestRevision($artworkFile2->getFileId(), $artworkFile2->getFileStage()));
self::assertEquals($artworkFile2, $submissionFileDao->getLatestRevision($artworkFile2->getFileId(), $artworkFile2->getFileStage(), SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getLatestRevision($artworkFile2->getFileId(), MONOGRAPH_FILE_PRODUCTION + 1));
self::assertNull($submissionFileDao->getLatestRevision($artworkFile2->getFileId(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
// Retrieve the latest revisions of both files.
self::assertNull($submissionFileDao->getLatestRevisions(null));
self::assertEquals(array($artworkFile2, $monographFile), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertEquals(array($artworkFile2, $monographFile), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
self::assertEquals(array(), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, MONOGRAPH_FILE_PRODUCTION + 1));
// Test paging.
$rangeInfo = new DBResultRange(2, 1);
self::assertEquals(array($artworkFile2, $monographFile), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
$rangeInfo = new DBResultRange(1, 1);
self::assertEquals(array($artworkFile2), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
$rangeInfo = new DBResultRange(1, 2);
self::assertEquals(array($monographFile), $submissionFileDao->getLatestRevisions(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID, null, $rangeInfo));
// Retrieve all revisions of the artwork file.
self::assertNull($submissionFileDao->getAllRevisions(null));
self::assertEquals(array($artworkFile2, $artworkFile1), $submissionFileDao->getAllRevisions($artworkFile1->getFileId(), MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array($artworkFile2, $artworkFile1), $submissionFileDao->getAllRevisions($artworkFile1->getFileId(), MONOGRAPH_FILE_PRODUCTION, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertEquals(array(), $submissionFileDao->getAllRevisions($artworkFile1->getFileId(), null, SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID + 1));
self::assertEquals(array(), $submissionFileDao->getAllRevisions($artworkFile1->getFileId(), MONOGRAPH_FILE_PRODUCTION + 1, null));
// Retrieve the latest revisions by association.
self::assertNull($submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, null));
self::assertNull($submissionFileDao->getLatestRevisionsByAssocId(null, 5));
self::assertEquals(array($artworkFile2), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertEquals(array($artworkFile2), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION + 1));
// Retrieve all revisions by association.
self::assertNull($submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, null));
self::assertNull($submissionFileDao->getAllRevisionsByAssocId(null, 5));
self::assertEquals(array($artworkFile2, $artworkFile1), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertEquals(array($artworkFile2, $artworkFile1), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION));
self::assertEquals(array(), $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5, MONOGRAPH_FILE_PRODUCTION + 1));
// Delete the first revision of the artwork file.
// NB: This implicitly tests deletion by ID.
self::assertEquals(1, $submissionFileDao->deleteRevision($artworkFile1));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
// Re-insert the file for the next test.
self::assertEquals($artworkFile1, $submissionFileDao->insertObject($artworkFile1));
// Delete the latest revision of the artwork file.
self::assertEquals(1, $submissionFileDao->deleteLatestRevisionById($artworkFile1->getFileId()));
self::assertType('ArtworkFile', $submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile2->getFileId(), $artworkFile2->getRevision()));
// Re-insert the file for the next test.
self::assertEquals($artworkFile2, $submissionFileDao->insertObject($artworkFile2));
// Delete all revisions of the artwork file.
self::assertEquals(2, $submissionFileDao->deleteAllRevisionsById($artworkFile1->getFileId()));
self::assertType('MonographFile', $submissionFileDao->getRevision($monographFile->getFileId(), $monographFile->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile2->getFileId(), $artworkFile2->getRevision()));
// Re-insert the files for the next test.
self::assertEquals($artworkFile1, $submissionFileDao->insertObject($artworkFile1));
self::assertEquals($artworkFile2, $submissionFileDao->insertObject($artworkFile2));
// Delete all revisions by assoc id.
self::assertEquals(2, $submissionFileDao->deleteAllRevisionsByAssocId(ASSOC_TYPE_REVIEW_ASSIGNMENT, 5));
self::assertType('MonographFile', $submissionFileDao->getRevision($monographFile->getFileId(), $monographFile->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile2->getFileId(), $artworkFile2->getRevision()));
// Re-insert the files for the next test.
self::assertEquals($artworkFile1, $submissionFileDao->insertObject($artworkFile1));
self::assertEquals($artworkFile2, $submissionFileDao->insertObject($artworkFile2));
// Delete all revisions by submission id.
self::assertEquals(3, $submissionFileDao->deleteAllRevisionsBySubmissionId(SUBMISSION_FILE_DAO_TEST_SUBMISSION_ID));
self::assertNull($submissionFileDao->getRevision($monographFile->getFileId(), $monographFile->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile1->getFileId(), $artworkFile1->getRevision()));
self::assertNull($submissionFileDao->getRevision($artworkFile2->getFileId(), $artworkFile2->getRevision()));
// Test inserting of new revisions.
// Create two artwork files with different file ids.
$artworkFile1->setFileId(null);
$artworkFile1->setRevision(null);
$artworkFile1 =& $submissionFileDao->insertObject($artworkFile1);
$artworkFile2->setFileId(null);
$artworkFile2->setRevision(null);
$artworkFile2->setGenreId($artworkFile1->getGenreId() + 1);
$artworkFile2 =& $submissionFileDao->insertObject($artworkFile2);
// Test the file ids, revisions and identifying fields.
self::assertNotEquals($artworkFile1->getFileId(), $artworkFile2->getFileId());
self::assertNotEquals($artworkFile1->getGenreId(), $artworkFile2->getGenreId());
self::assertEquals(1, $submissionFileDao->getLatestRevisionNumber($artworkFile1->getFileId()));
self::assertEquals(1, $submissionFileDao->getLatestRevisionNumber($artworkFile2->getFileId()));
// Now make the second file a revision of the first.
$artworkFile2 =& $submissionFileDao->setAsLatestRevision($artworkFile1->getFileId(), $artworkFile2->getFileId(), $artworkFile1->getSubmissionId(), $artworkFile1->getFileStage());
// And test the file ids, revisions and identifying fields again.
self::assertEquals($artworkFile1->getFileId(), $artworkFile2->getFileId());
self::assertEquals($artworkFile1->getGenreId(), $artworkFile2->getGenreId());
self::assertEquals(1, $artworkFile1->getRevision());
self::assertEquals(2, $submissionFileDao->getLatestRevisionNumber($artworkFile1->getFileId()));
}
