EPrints Technical Mailing List Archive

Message: #04960

< Previous (by date) | Next (by date) > | < Previous (in thread) | Next (in thread) > | Messages - Most Recent First | Threads - Most Recent First

[EP-tech] Re: Data object validation; $for_archive

I spent 15 minutes trying to track it through the code, and met with little success, I'm afraid.  

	https://github.com/eprints/eprints/blob/de3b8d19f310efdbd993d07e9dfd57a15e103354/perl_lib/EPrints/Plugin/Screen/EPrint/Deposit.pm#L88

...implies that it's set on the screen processor, but I couldn't find anywhere where it's actually set.


One cheeky alternative: you could check eprint_status and if it's in the buffer, you can guess it's going to be live soon.

--
Adam Field
Business Relationship Manager and Community Lead
EPrints Services
+44 (0)23 8059 8814





On 20 Oct 2015, at 17:37, John Salter wrote:

> Hi,
> I'm trying to work out how the '$for_archive' flag works when validating EPrints (I suspect it doesn’t, but am hoping to be proved wrong. I want to use this feature).
> 
> Starting here: https://github.com/eprints/eprints/blob/3.3/perl_lib/EPrints/DataObj.pm#L2046-L2047
> The 'validate' method on a dataobject can take a '$for_archive' flag.
> This *should* be set as true when the item is about to be moved into the live archive.
> 
> It is referenced in many places - passed method-to-method, but as far as I can tell, this value is not set anywhere (and therefore is never true).
> https://github.com/eprints/eprints/search?q=for_archive
> 
> Can anyone help me trace it through the EPrints code, and confirm that it is or isn't used (especially at the point where an EPrint is made live)?
> 
> The comments  https://github.com/eprints/eprints/blob/3.3/lib/defaultcfg/cfg.d/eprint_validate.pl#L13-L14
> refer to 'comments at the start of the validation section'.
> I think these were carried over from Eprints2 days when all the validation routines were in one place: http://www.eprints.org/files/eprints2/eprints-2.2/defaultcfg/ArchiveValidateConfig.pm 
> 
> #  $for_archive is a boolean flag (1 or 0) it is set to 0 when the
> #  item is being validated as a submission and to 1 when the item is
> #  being validated for submission to the actual archive. This allows
> #  a stricter validation for editors than for submitters. A useful 
> #  example would be that a deposit may have one of several format of
> #  documents but the editor must ensure that it has a PDF before it
> #  can be submitted into the main archive. If it doesn't have a PDF
> #  file, then the editor will have to generate one.
> 
> Also in Eprints2, this is where the 'for_archive' gets set:
> http://www.eprints.org/files/eprints2/eprints-2.2/perl_lib/EPrints/SubmissionForm.pm, Line 129
> 
> Cheers,
> John
> 
> *** Options: http://mailman.ecs.soton.ac.uk/mailman/listinfo/eprints-tech
> *** Archive: http://www.eprints.org/tech.php/
> *** EPrints community wiki: http://wiki.eprints.org/
> *** EPrints developers Forum: http://forum.eprints.org/