Talk:API:EPrints
I'm going to use this page to get my thoughts in order. Cjg 16:58, 2 September 2009 (BST)
Current 3.1 System
Unsessioned Classes
These classes don't store a session internally resulting in methods like $foo->render( $session, ARGS ).
- Repository
- DataSet
- MetaField
- Language
Sessioned Classes
These classes store a session internally resulting in methods like $foo->render( ARGS ).
- Session
- DataObj
- Plugin
- List
- Search
- Database
- Workflow
- ScreenProcessor
API
New Plan(!)
- Merge Session and Repository into a single class.
- Move XML functions into their own class.
- Move Page functions into their own class.
- Add a link to repository for dataset and metafield.
- Ensure cleanup when repository object goes out of scope.
- Make EPrints->new() return an eprints object which can pass out repository objects.
- repository objects don't have a link to the EPrints object EVER.
- When the eprints object is DESTROY'd it takes out the repositories, datasets and metafields etc.
Stage 0.9 API
We aim to finish these modules in the next few days, the 2nd list below require some more thought and are less central.
Remaining Issues
text_phrase
- Should $xhtml->text_phrase move out of XHTML
- cjg: I vote to move it to $repository. So we have $repository->phrase() and $repository->xhtml->phrase()
- TDB: Lukewarm. I'm not sure about $xhtml->phrase - the XHTML class doesn't own phrases in the same way the repository does via Lang objects (->phrase is an accessor?).
- TDB Ideally I would like $repo->phrase to return XML/XHTML because->xhtml_phrase is currently used 3x more often than ->phrase and this better represents what's going on anyway (phrases *are* XML).
- TDB: To make stringification less ambiguous?:
- cjg: I vote to move it to $repository. So we have $repository->phrase() and $repository->xhtml->phrase()
$repo->phrase_as_string( $phraseid ); # $repo->xml->to_string $repo->phrase_as_text_dump( $phraseid ); # $repo->xhtml->to_text_dump
- CJG: I kinda hate those method names. Clearly this issue remains open!
tree_to_utf8
- What do we rename tree_to_utf8 to?
- currently $xml->to_text()
- CJG: I vote to move it to $xhtml
- Also to_text() needs renaming
- CJG: It might be better to actually defer adding it until we have a good name!
- CJG: Or we could have $xhtml->to_text() which applies basic markup and $xml->to_text() which doesn't!
- TDB: $xhtml->to_text_dump( $dom_node, %opts ); # dump == elinks verb
- TDB: $xhtml->dump( $dom_node, %opts );
$dataobj->render
- ($xhtml, $title, $head_elements) = $dataobj->render; is ugly in the way it returns the result
- CJG: I vote to make a new function with a better name & return values
- Can't just change what it returns as it's an established library function
- CJG: Not sure what to name it to. render_page?
- This would be confusing as it's not related to the xhtml page function.
- maybe render_page_parts?
- CJG: Either way should return a hash or a ( body=>...., title=>...., head=>.... )
- This would be confusing as it's not related to the xhtml page function.
- TDB: Should this be:
$xhtml = $dataobj->render_head_elements; $xhtml = $dataobj->render_title; $xhtml = $dataobj->render_body;
- TDB: I think eprint_render() is on the way out anyway (replaced by XML template). We could deprecate eprint_render or do some kooky caching.
- CJG: That sounds sane, but the current eprint_render.pl function returns all 3 in one go! We could split it up in 3.2 default config, but make it also work with plain old eprints_render.pl -- actually, it feels like $c->{eprint_render} should become a hashref:
$c->{eprint_render}->{body} $c->{eprint_render}->{title} etc... nice and extendable!
- Seb: $parts = $dataobj->render_parts? $parts->{head} $parts->{title} $parts->{body} I'd rather use a hash ref than a hash.... I'm not sure how perl handles returned values, but if done via the stack, it makes more sense to send back a ref (cf in C -> "object *").
- CJG: The stack isn't significant in a high level function like this, only in lower ones like make_element. So % or \% is style, rather than opimisation.
- Ben W: Thinking about the way that pages are built though, I'm not sure I want to get all those things at once, and function that return multiple things usually end up being a pain to remember or extend. How about this?
- Seb: $parts = $dataobj->render_parts? $parts->{head} $parts->{title} $parts->{body} I'd rather use a hash ref than a hash.... I'm not sure how perl handles returned values, but if done via the stack, it makes more sense to send back a ref (cf in C -> "object *").
# Build the <head> section $dataobj1->render_head; $dataobj2->render_head; # Build the rest of it $dataobj1->render_body; $dataobj2->render_body;
Return value from $dataset->get_field
(kinda a test case) General principle:
Empty [] = it worked, but result set is empty. undef = expected error (eg field doesn't exist) die = unexpected error
Ben Wheeler: The question is, is attempting to access a non-existant field really an expected error condition? It shouldn't happen in normal circumstances if the configuration is right, so I'd argue it's a death condition, although worth trapping in an eval {} in certain circumstances (eg importing). Rule of thumb: Should the program sensibly carry on regardless if this function call fails and some idiot fails to check the return value? If 90% of the time the caller will likely want to "do_foo() or die" then do_foo() should die for them if it fails, and the other 10% they can indicate acceptance of risk by having to use "eval {}; if ($@)..." (Where 'die' obviously means 'abort nicely with helpful browser error message etc'...)
- CJG: Mostly we want to be able to make import/export plugins which don't explode when a field is missing. If someone does foreach my $badger ( @{ $eprint->get_values( "badgers" ) } ) {} that'll still explode if they don't check it's not undef, but it's probably cleaner than using has_field() etc.
- CJG: So I'm happy with the above convention. undef=expected, abort for "unexpected". Agreed?
- TDB: What about warning on get_value( "invalid" )? i.e. the user should do defined(get_field) for anything non-core but we're not going to break plugins if the admin removes fields? The alternative is to write plugins properly ofc :-)
$dataset->has_field
We're still not decided if this should go on or not.
* TDB: Kill! Kill! Kill!
EPrints
$ep = EPrints->new(); \@ids = $ep->repository_ids; # list active repository ids $repo = $ep->repository( "devel", noise=>1 ); $repo = $ep->current_repository(); # from Apache::Request URI EPrints->abort( $message );
repo
$xml = $repo->xml; $dataset = $repo->dataset( "user" ); $user = $repo->current_user; $query = $repo->query; $current_page_url = $repo->current_url; $config_element = $repo->config( $key, [@subkeys] ); $repository->log( $message ); $string = $repo->query->param( "X" ); $repo->redirect( $url ); $eprint = $repo->eprint( 23 ); $user = $repo->user( 23 ); $user = $repo->user_by_username( "cjg" ); $user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );
dataset
$string = $dataset->base_id; # eprint $string = $dataset->id; # inbox $dataobj = $datasset->create_dataobj( $data ); $user = $dataset->dataobj( 23 ); $search = $dataset->prepare_search( %options ); $list = $dataset->search( %options ); # prepare_search( %options )->execute $list = $dataset->search; # match ALL $metafield = $dataset->field( $fieldname ); $metafield = $dataset->key_field; @metafields = $dataset->fields; $dataset->search->map( sub {}, $ctx ); $n = $dataset->search->count; $ids = $dataset->search->ids; $list = $dataset->list( \@ids );
list
$n = $list->count; $list->map( sub {}, $ctx ); $dataobj = $list->item( offset ); @dataobjs = $list->slice( offset, length ); # tdb: consistent with creating a list: unbounded returns should use array ref? \@ids = $list->ids;
XML
$doc = $xml->parse_string( $string ); $doc = $xml->parse_file( $filename ); $doc = $xml->parse_url( $url ); $utf8_string = $xml->to_string( $dom_node, %opts ); $dom_node = $xml->clone( $dom_node ); # deep $dom_node = $xml->clone_node( $dom_node ); # shallow $dom_node = $xml->contents_of( $dom_node ); # clone and return child nodes $utf8_string = $xml->text_contents_of( $dom_node ); # Return text child nodes as a string $dom_node = $xml->create_element( $name, %attr ); $dom_node = $xml->create_text_node( $value ); $dom_node = $xml->create_comment_node( $value ); $dom_node = $xml->create_document_fragment; $xml->dispose( $dom_node );
- Still Under discussion (see above)
$utf8_string = $xml->to_text( $dom_node, %opts ); # nee tree_to_utf8
XHTML
$xhtml = $repo->xhtml; $utf8_string = $xhtml->to_xhtml( $dom_node, %opts ); # remove NS prefixes, fix <script> etc. $xhtml_dom_node = $xhtml->input_field( $name, $value, %opts ); # nb. type & noenter are now options. $xhtml_dom_node = $xhtml->hidden_field( $name, $value, %opts ); # tdb: this is used *a lot* and is well defined $xhtml_dom_node = $xhtml->text_area_field( $name, $value, %opts ); # tdb: value becomes a child text node $xhtml_dom_node = $xhtml->form( $method, $url ); $page = $xhtml->build_page( %opts );
- Still under discussion
# $repo->xhtml->phrase( $phrase_id ) $xhtml_dom_node = $xhtml->phrase( $phrase_id, %pins ); # is this an XHTML function or move to Repository? $utf8string = $xhtml->text_phrase( $phrase_id, %pins );
Page
$page->send( %options ); $page->write_to_file( $filename );
DataObj
$dataobj = $dataset->dataobj( $id ); $dataobj->delete; $dataobj->commit( $force ); $dataobj->set_value( $fieldname, $value ); $value = $dataobj->value( $fieldname ); \@value = $dataobj->value( $fieldname ); # multiple $boolean = $dataobj->is_set( $fieldname ); $id = $dataobj->id; $xhtml = $dataobj->render_value( $fieldname ); $xhtml = $dataobj->render_citation( $style, %opts ); $uri = $dataobj->uri; $url = $dataobj->url; $string = $dataobj->export( $plugin_id, %opts ); $dataobj = $dataobj->create_subobject( $fieldname, $epdata );
- Still Under discussion
($xhtml, $title, $head_elements) = $dataobj->render;
MetaField
Now has a handle on both it's repository/session AND dataset.
my $field = $dataset->field( $fieldname ); $field->set_property( $property, $value ); $name = $field->name; $type = $field->type; $value = $field->property( $property ); $xhtml = $field->render_name; $xhtml = $field->render_help; $xhtml = $field->render_value_label( $value ); $values = $field->values( %opts ); $sorted_list = $field->sort_values( $unsorted_list );
Stage 1.0 API
This is still required to make the basic API complete, but we'll worry about once we've got the stuff above finalisedish.
search
TERM_EQUALS = "EQ" TERM_INDEX = "IN" TERM_EXACT = "EX" MATCH_ALL = "ALL" MATCH_ANY = "ANY" $search = $dataset->prepare_search( order => "-date", satisfy_all=>1 ); $search = $dataset->prepare_search( terms => [], filters => [], ... ); $list = $search->execute; # constructor interface $s = $dataset->prepare_search( order => "-date", satisfy_all => 1, terms => [ { fields => "type", values => [qw( article book )], op => TERM_EQUALS, match => MATCH_ANY }, { fields => [qw( title abstract )], values => ["dogbert dilbert"], op => TERM_INDEX, match => MATCH_ALL }, { fields => "userid", values => "52", op => TERM_EXACT }, ] );
- tdb: meta_fields/fields/field, value/values?
- cjg: could have choice of fields=>["",""] or field=>""
# method interface $s = $dataset->prepare_search( order => "-date", satisfy_all => 1 ); $s->add_term( "type", [qw( article book )], op => TERM_EQUALS, match => MATCH_ANY ); $s->add_term( [qw( title abstract )], ["dogbert dilbert"], op => TERM_INDEX, match => MATCH_ALL ); $s->add_term( "userid", "52", op => TERM_EXACT ); $list = $s->execute; print $list->count, "\n";
- tdb: I would like to make the value argument not automagically-split on ANY but explicitly use an array ref of values to match.
- cjg: Agreed.
Maybe
$s->add_term( $dataset->field( "type" ), [qw/ article book/], merge => MERGE_ANY );
- cjg: I'm not convinced we need this.
SubObject
- tdb: superclass of Document, File, History, SavedSearch
$dataobj = $dataobj->parent;
EPrint
$eprint->set_status( "inbox" );
- tdb: consistency - ->documents ~ ->value( "documents" ) and ->value() returns array ref for multiple
my $docs = $eprint->documents( %opts ); # isVolatileVersionOf => 0 ? foreach my $document ( @$docs ) { .. } # create a new document on $eprint $doc_data = { ... }; $doc = $eprint->create_subobject( "documents", $doc_data ); # eprint to which this document belongs $eprint = $doc->parent;
User
$user = $repository->dataset( "user" )->dataobj( 23 );
- tdb: is this accessor or action? c.f. send_page()
- It's an action. Cjg 20:04, 17 September 2009 (BST)
$user->send_email( .... )
Subject
$subject = $repository->dataset("subject")->dataobj( "FOO" ); \@subjects = $subject->children; \@subjects = $subject->parents;
- CJG: issue with confusion with subobjects like document, or are these really subobjects? Maybe child_subjects parent_subjects to avoid overlapping names?
- tdb: subobject relation = if you remove parent, children are removed - is this true of subjects? Could extend subobject concept to be M:N
- $subject->value( "children" ) = ->children
- $subject->value( "parents" ) = ->parents
Document
$doc = $repo->dataset( "document" )->dataobj( 23 ); # delete a document object *forever*: $ok = $doc->delete; $url = $doc->url( [$file] );
- tdb: is $file ^^ a file object or filename?
- Cjg 20:05, 17 September 2009 (BST): Duh, we should just use $doc->file_by_filename( $file )->get_url;
# change the file which is used as the URL for the document. $doc->set_value( "main", "foo.html" ); # dealing with files $file = $doc->file_by_filename( $filename ); # nee get_stored_file \@files = $doc->value( "files" ); $file->value( "filename" ); $file->value( "filesize" ); # delete a file $doc->file_by_filename( $filename )->delete; # delete all files $files = $doc->value( "files" ); foreach my $file (@$files) { $file->delete; } # icons and previews???? These need work! $xhtml = $doc->render_icon_link( %opts ); $xhtml = $doc->render_preview_link( %opts );
Maybe
# Add files to the document # tdb: these should be deprecated from Document and moved to Import/Screen plugins $success = $doc->upload( $filehandle, $filename [, $preserve_path [, $filesize ] ] ); $success = $doc->upload_archive( $filehandle, $filename, $archive_format ); $success = $doc->add_archive( $file, $archive_format ); $success = $doc->add_directory( $directory ); $success = $doc->upload_url( $url );
File
$file = $history->file_by_filename( "dataobj.xml" ); $file->retrieve( sub { ... }, $info ); # callback-based file content retrieval
- I don't know enough about this method to know what we *must* have in. Less is better IMO, though. Cjg 01:23, 17 September 2009 (BST)
- tdb: files should probably be only created via a parent object