package EPrints::Plugin::Screen::EPrint::HefceOA;

our @ISA = ( 'EPrints::Plugin::Screen::EPrint' );

use HefceOA::Const;
use strict;

sub new
{
	my( $class, %params ) = @_;

	my $self = $class->SUPER::new(%params);

	$self->{appears} = [
		{
			place => "eprint_view_tabs",
			position => 3000,
		},
	];
	#avoid issues with multiple archives under <v3.3.13
	$self->{disable} = 1;
	
	return $self;
}

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

	return unless $self->{processor}->{eprint}->is_set( "hoa_compliant" );

    my $repo = $self->{repository};
    if( $repo->get_conf( "hefce_oa", "hide_tab" ) ) # we want to hide the tab for eprints accepted/published after the submission deadline
    {
        my $out_of_scope = $repo->call( [ "hefce_oa", "OUT_OF_SCOPE_reason" ], $repo, $self->{processor}->{eprint} );
        return if $out_of_scope eq "over";       
    }
	return $self->allow( "eprint/hefce_oa" );
}

sub render
{
	my( $self ) = @_;
	my $repo = $self->{repository};
	my $page = $repo->xml->create_element( "div" ); # wrapper

	my $eprint = $self->{processor}->{eprint};
	my $flag = $eprint->value( "hoa_compliant" ) || 0;

	# overall compliance
	my $out_of_scope = $repo->call( [ "hefce_oa", "OUT_OF_SCOPE_reason" ], $repo, $eprint );
	if( $out_of_scope )
	{
                #not currently compliant, but could be if embargo is released properly
                my $div = $repo->make_element( "div", class=>"ep_msg_message" );
                my $content_div = $repo->make_element( "div", class=>"ep_msg_message_content" );
                my $table = $repo->make_element( "table" );
                my $tr = $repo->make_element( "tr" );
                $table->appendChild( $tr );

                my $td1 = $repo->make_element( "td" );
                my $imagesurl = $repo->get_conf( "rel_path" );
                $td1->appendChild(
                        $repo->make_element(
                                "img",
                                class => "ep_msg_message_icon",
                                src => "$imagesurl/style/images/hoa_out_of_scope.png",
                                alt => $self->phrase( "out_of_scope_alt" )
                        )
                );
                $tr->appendChild( $td1 );

                my $td2 = $repo->make_element( "td" );
                my $emb_len = $eprint->value( "hoa_emb_len" ) || 0;
                $tr->appendChild( $td2 );

		if( $out_of_scope eq "gold" )
		{
 	               $td2->appendChild( $self->html_phrase( "out_of_scope:gold" ) );
		}
		elsif( $out_of_scope eq "issn" )
		{
 	               $td2->appendChild( $self->html_phrase( "out_of_scope:issn" ) );
		}
        elsif( $out_of_scope eq "over" )
        {
 	               $td2->appendChild( $self->html_phrase( "out_of_scope:over" ) );
        }
		else
		{
 	               $td2->appendChild( $self->html_phrase( "out_of_scope:timing" ) );
		}

                $content_div->appendChild( $table );
                $div->appendChild( $content_div );

                $page->appendChild( $div );
	}
	elsif( $flag & HefceOA::Const::COMPLIANT )
	{
        $page->appendChild( $repo->render_message( "message", $self->html_phrase( "compliant" ) ) );
    }
	elsif( $flag & HefceOA::Const::DEP && 
		$flag & HefceOA::Const::DIS &&
		$flag & HefceOA::Const::ACC_EMBARGO &&
		$repo->call( ["hefce_oa", "could_become_ACC_TIMING_compliant"], $repo, $eprint ) )
	{
		#not currently compliant, but could be if embargo is released properly
        	my $div = $repo->make_element( "div", class=>"ep_msg_warning" );
        	my $content_div = $repo->make_element( "div", class=>"ep_msg_warning_content" );
        	my $table = $repo->make_element( "table" );
        	my $tr = $repo->make_element( "tr" );
        	$table->appendChild( $tr );

                my $td1 = $repo->make_element( "td" );
                my $imagesurl = $repo->get_conf( "rel_path" );
                $td1->appendChild( 
			$repo->make_element( 
				"img", 
				class => "ep_msg_warning_icon",
				src => "$imagesurl/style/images/hoa_future_compliant.png",
				alt => $self->phrase( "future_compliant_alt" )
			)
		);
                $tr->appendChild( $td1 );

        	my $td2 = $repo->make_element( "td" );
		my $emb_len = $eprint->value( "hoa_emb_len" ) || 0;
        	$tr->appendChild( $td2 );
        	$td2->appendChild( $self->html_phrase( 
			"future_compliant", 
			last_foa_date => $repo->xml->create_text_node( $repo->call( [ "hefce_oa", "calculate_last_compliant_foa_date" ], $repo, $eprint )->strftime( "%Y-%m-%d" ) ),
			hoa_emb_len => $repo->xml->create_text_node( $emb_len ),
		) );
        	$content_div->appendChild( $table );
        	$div->appendChild( $content_div );

		$page->appendChild( $div );
        }
        else
        {
            $page->appendChild( $repo->render_message( "warning", $self->html_phrase( "non_compliant" ) ) );
        }

	# if incomplete dates are stored for hoa_date_acc or hoa_date_pub, display a warning
	# incomplete embargo end dates do not get a warning, as the behaviour in this case is known (embargo released after
	# most-defined date)
	my @incomplete_dates;
	for( qw( hoa_date_acc hoa_date_pub ) )
	{
		if( $eprint->is_set( $_ ) && $eprint->value( $_ ) !~ /^\d{4}\-\d{2}\-\d{2}$/ )
		{
			push @incomplete_dates, $_;
		}
	}
	if( @incomplete_dates ) 
	{
		my $dates = $repo->xml->create_document_fragment;
		for( @incomplete_dates )
		{
			$dates->appendChild( $self->html_phrase( "render_incomplete_date", 
				date_field => $repo->html_phrase( "eprint_fieldname_$_" ),
				value => $eprint->render_value( $_ ),
			) );
		}
	    
		$page->appendChild( $repo->render_message( "warning", $self->html_phrase( "render_incomplete_dates", dates => $dates ) ) );
	}

	$page->appendChild( $self->html_phrase( "render_test_description",
		description => $repo->html_phrase( "hefce_oa:test_description:COMPLIANT" )
	) );

	# tabs for individual requirements and exceptions
	my @labels;
	my @tabs;
	for(
		[ "DEP", [qw( DEP_COMPLIANT DEP_TIMING )] ],
		[ "DIS", [qw( DIS_DISCOVERABLE )] ],
		[ "ACC", [qw( ACC_TIMING ACC_EMBARGO )] ],
		[ "EX", [qw( EX_DEP EX_ACC EX_TEC EX_FUR )] ],
        [ "AUDIT", [qw( AUD_UP_OA AUD_UP_URL )] ],
	)
	{
		my( $label, $tab ) = $self->render_tab( @$_ );
		push @labels, $label;
		push @tabs, $tab;
	}
	$page->appendChild( $repo->xhtml->tabs(
		\@labels,
		\@tabs,
		basename => "hoa_tabs",
	) );

	$page->appendChild( $repo->xml->create_element( "br" ) );

	# data used to check compliance
	my $box = $repo->make_element( "div", style=>"text-align: left" );
	$box->appendChild( EPrints::Box::render(
		id => "hoa_data",
		title => $self->html_phrase( "data:title" ),
		content => $self->render_data,
		collapsed => 1,
		session => $repo,
	) );
	$page->appendChild( $box );

	return $page;
}

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

	my $repo = $self->{repository};
	my $eprint = $self->{processor}->{eprint};

    my $div = $repo->xml->create_element( "div", class => "hoa_data_tables" );
   
    # Compliance Data Table
    my $compliance_div = $repo->xml->create_element( "div", class => "hoa_data_compliance" );
    $compliance_div->appendChild( $self->html_phrase( "data:compliance_table" ) );

	my $compliance_table = $repo->xml->create_element( "table", border => 0, cellpadding => 3 );

	foreach my $field ( qw( hoa_date_acc hoa_date_pub hoa_date_fcd eprint_status hoa_date_foa hoa_emb_len hoa_ref_pan hoa_gold ) )
	{
		my $tr = $repo->xml->create_element( "tr" );
		$compliance_table->appendChild( $tr );

		my $th = $repo->xml->create_element( "th", class => "ep_row" );
		$th->appendChild( $repo->html_phrase( "eprint_fieldname_$field" ) );
		$tr->appendChild( $th );

		my $td = $repo->xml->create_element( "td", class => "ep_row" );
		$td->appendChild( $eprint->is_set( $field ) ? $eprint->render_value( $field ) : $self->html_phrase( "data:unknown" ) );

		if( $field eq "hoa_ref_pan" && !$eprint->is_set( $field ) && $repo->can_call( 'hefce_oa', 'deduce_panel' ) )
		{
			my $deduced_panel = $repo->call( [ 'hefce_oa', 'deduce_panel' ], $eprint );
			if( defined $deduced_panel )
			{
				$td->appendChild( $self->html_phrase( "data:deduced_panel", panel => $repo->make_text( $deduced_panel ) ) );
			}
		}
		$tr->appendChild( $td );
	}

    $compliance_div->appendChild( $compliance_table );
    $div->appendChild( $compliance_div );

    # Audit Data Table
    my $audit_div = $repo->xml->create_element( "div", class => "hoa_data_audit" );
    $audit_div->appendChild( $self->html_phrase( "data:audit_table" ) );

    my $audit_table = $repo->xml->create_element( "table", border => 0, cellpadding => 3 );

    # first thing we use is the doi s0 lets show the one we're using
    my $doi_field = "id_number";
    if(EPrints::Utils::is_set($repo->get_conf("hefce_oa","eprintdoifield"))){
        #a) have we defined the doi_field within the hefce_oa conf?
        $doi_field = $repo->get_conf("hefce_oa","eprintdoifield");
    }elsif(EPrints::Utils::is_set($repo->get_conf("datacitedoi","eprintdoifield"))){
        #b) have we already defined the doi_field within the dataitedoi plugin?
        $doi_field = $repo->get_conf("datacitedoi","eprintdoifield");
    }

    my $tr = $repo->xml->create_element( "tr" );
    $audit_table->appendChild( $tr );

    my $th = $repo->xml->create_element( "th", class => "ep_row" );
    $th->appendChild( $repo->html_phrase( "eprint_fieldname_$doi_field" ) );
    $tr->appendChild( $th );

    my $td = $repo->xml->create_element( "td", class => "ep_row" );
    $td->appendChild( $eprint->is_set( $doi_field ) ? $eprint->render_value( $doi_field ) : $self->html_phrase( "data:unknown" ) );
    $tr->appendChild( $td );

    $audit_div->appendChild( $audit_table );

    # now show our audit record
    my $audit_ds = $repo->dataset( "hefce_oa_audit" );
    my $audit = $audit_ds->dataobj_class->get_audit_record( $repo, $eprint );
    if( !defined $audit )
    {
        # no audit record to display data from
        $audit_div->appendChild( $self->html_phrase( "data:no_audit" ) );  
    }   
    else
    {
        # display unpaywall data
        if( $audit->is_set( "up_datestamp" ) )
        {
            $audit_div->appendChild( $self->html_phrase( "data:up_audit", date => $audit->render_value( "up_datestamp" ) ) );
            my $up_table = $repo->xml->create_element( "table", border => 0, cellpadding => 3 );
            $audit_div->appendChild( $up_table );

	        foreach my $field ( qw( up_is_oa up_url_for_pdf up_locations ) )
        	{
                my $tr = $repo->xml->create_element( "tr" );
                $up_table->appendChild( $tr );

                my $th = $repo->xml->create_element( "th", class => "ep_row" );
                $th->appendChild( $repo->html_phrase( "hefce_oa_audit_fieldname_$field" ) );
                $tr->appendChild( $th );

                my $td = $repo->xml->create_element( "td", class => "ep_row" );

                if( $field eq "up_locations" )
                {
                    my $ul = $repo->make_element( "ul" );
                    foreach my $location ( @{$audit->get_value( $field )} )
                    {
                        my $li = $repo->make_element( "li" );
                        my $link = $repo->render_link( $location->{url}, "_blank" );
                        if( defined $location->{pmh_id} )
                        {
                            $link->appendChild( $repo->make_text( $location->{pmh_id} ) );
                        }
                        else
                        {
                            my $text = $location->{url};
                            if( length( $text ) > 40 ) { $text = substr( $text, 0, 40 )."..."; }
                            $link->appendChild( $repo->make_text( $text ) );
                        }
                        $li->appendChild( $link );
                        $ul->appendChild( $li );
                    }
                    $td->appendChild( $ul );
                }
                elsif( $field eq "up_url_for_pdf" )
                {
                    if( $audit->is_set( $field ) )
                    {
                        
                        my $link = $repo->render_link( $audit->get_value( $field ), "_blank" );
                        my $text = $audit->get_value( $field );
                        if( length( $text ) > 40 ) { $text = substr( $text, 0, 40 )."..."; }
                        $link->appendChild( $repo->make_text( $text ) );
            		    $td->appendChild( $link );
                    }
                    else
                    {
            		    $td->appendChild( $self->html_phrase( "data:unknown" ) );
                    }      
                }
                else # up_is_oa
                {
            		$td->appendChild( $audit->is_set( $field ) ? $audit->render_value( $field ) : $self->html_phrase( "data:unknown" ) );
                }
                
                $tr->appendChild( $td );
            }
        }

        $audit_div->appendChild( $self->html_phrase( "data:core_audit_unavailable_title" ) );  
        $audit_div->appendChild( $self->html_phrase( "data:core_audit_unavailable_message" ) );  

        # display core data - disabled for now because Core data and RE's usage of it is a bit confusing
        if( 0 ) 
        {
        if( $audit->is_set( "core_datestamp" ) )
        {
            $audit_div->appendChild( $self->html_phrase( "data:core_audit", date => $audit->render_value( "core_datestamp" ) ) );  
            my $core_table = $repo->xml->create_element( "table", border => 0, cellpadding => 3 );
            $audit_div->appendChild( $core_table );

            my $tr = $repo->xml->create_element( "tr" );
            $core_table->appendChild( $tr );

            my $th = $repo->xml->create_element( "th", class => "ep_row" );
            $th->appendChild( $repo->html_phrase( "hefce_oa_audit_fieldname_core_sources" ) );
            $tr->appendChild( $th );

            my $td = $repo->xml->create_element( "td", class => "ep_row" );
            my $ul = $repo->make_element( "ul" );
            foreach my $cs ( @{$audit->get_value( "core_sources" )} )
            {
                my $li = $repo->make_element( "li" );

                # link to the core page 
                my $href = $repo->get_conf("hefce_oa","core_url") . $cs->{core_id};
                my $link = $repo->render_link( $href, "_blank" );
                $link->appendChild( $repo->make_text( $cs->{core_id} ) );
                $li->appendChild( $self->html_phrase( "data:core_source_link", repo => $repo->make_text( $cs->{repo_name} ), core => $link ) ); 

                # show the relevant dates
                $li->appendChild( $self->html_phrase( "data:core_source_dates", dep => $repo->make_text( $cs->{depositedDate} ), pub => $repo->make_text( $cs->{datePublished} ) ) );

                $ul->appendChild( $li );
            }
            $td->appendChild( $ul );
            $tr->appendChild( $td );  
        }
}
    }

    $div->appendChild( $audit_div );

    return $div;
}

sub render_tab
{
	my( $self, $title, $tests ) = @_;

	return $self->render_exceptions_tab( $title, $tests ) if $title eq "EX";
	return $self->render_access_tab( $title, $tests ) if $title eq "ACC";
    return $self->render_audit_tab( $title, $tests ) if $title eq "AUDIT";

	my $repo = $self->{repository};
	my $tab = $repo->xml->create_document_fragment;

	my $eprint = $self->{processor}->{eprint};
	my $flag = $eprint->value( "hoa_compliant" ) || 0;

	my $tab_title = $self->html_phrase( "render_tab_title",
		title => $repo->html_phrase( "hefce_oa:test_title:$title" ),
		class => $repo->xml->create_text_node( $flag & HefceOA::Const->$title ? "hoa_compliant" : "hoa_non_compliant" )
	);
	
	$tab->appendChild( $self->html_phrase( "render_test_description",
		description => $repo->html_phrase( "hefce_oa:test_description:$title" )
	) );

	my $sub = $repo->xml->create_document_fragment;
	for( @$tests )
	{
		$sub->appendChild( $self->html_phrase( "render_test",
			title => $repo->html_phrase( "hefce_oa:test_title:$_" ),
			description => $repo->html_phrase( "hefce_oa:test_description:$_" ),
			class => $repo->xml->create_text_node( $flag & HefceOA::Const->$_ ? "hoa_compliant" : "hoa_non_compliant" )
		) );
	}
	$tab->appendChild( $self->html_phrase( "render_tests", tests => $sub ) );

	return( $tab_title, $tab );
}

sub render_exceptions_tab
{
	my( $self, $title, $tests ) = @_;

	my $repo = $self->{repository};
	my $tab = $repo->xml->create_document_fragment;

	my $eprint = $self->{processor}->{eprint};
	my $flag = $eprint->value( "hoa_compliant" ) || 0;

	my $count = 0;

	unless( $flag & HefceOA::Const::EX )
	{
		$tab->appendChild( $self->html_phrase( "render_no_exceptions" ) );
	}
	else
	{
		my $ex = $repo->xml->create_document_fragment;
		for( qw( hoa_ex_dep hoa_ex_acc hoa_ex_tec hoa_ex_fur ) )
		{
			if( $eprint->is_set( $_ ) )
			{
				$ex->appendChild( $self->html_phrase( "render_exception", 
					title => $repo->html_phrase( "eprint_fieldname_$_" ),
					exception => $eprint->render_value( $_ ),
					explanation => $eprint->render_value( "$_\_txt" ),
				) );
				$count++;
			}
		}
		$tab->appendChild( $self->html_phrase( "render_exceptions", exceptions => $ex ) );
	}

	my $tab_title = $self->html_phrase( "render_exception_tab_title",
		count => $repo->xml->create_text_node( $count ),
	);

	return( $tab_title, $tab );
}

sub render_access_tab
{
	my( $self, $title, $tests ) = @_;

	my $repo = $self->{repository};
	my $tab = $repo->xml->create_document_fragment;

	my $eprint = $self->{processor}->{eprint};
	my $flag = $eprint->value( "hoa_compliant" ) || 0;

	# special case: this item may become compliant when the embargo is released
	my $class = "hoa_non_compliant";
	if( $flag & HefceOA::Const::ACC )
	{
		$class = "hoa_compliant";
	}
	elsif( $repo->call( [ "hefce_oa", "could_become_ACC_TIMING_compliant" ], $repo, $eprint)  && $flag & HefceOA::Const::ACC_EMBARGO )
	{
		$class="hoa_future_compliant";	
	}

	my $tab_title = $self->html_phrase( "render_tab_title",
		title => $repo->html_phrase( "hefce_oa:test_title:$title" ),
		class => $repo->xml->create_text_node( $class )
	);

	$tab->appendChild( $self->html_phrase( "render_test_description",
		description => $repo->html_phrase( "hefce_oa:test_description:$title" )
	) );

	my $sub = $repo->xml->create_document_fragment;
	for( @$tests )
	{
		my $test_class = ( $flag & HefceOA::Const->$_ ? "hoa_compliant" : "hoa_non_compliant" );
		if( $_ eq "ACC_TIMING" && $test_class eq "hoa_non_compliant" && $repo->call( [ "hefce_oa", "could_become_ACC_TIMING_compliant" ], $repo, $eprint ) ){
			$test_class= "hoa_future_compliant";
		}
		$sub->appendChild( $self->html_phrase( "render_test",
			title => $repo->html_phrase( "hefce_oa:test_title:$_" ),
			description => $repo->html_phrase( "hefce_oa:test_description:$_" ),
			class => $repo->xml->create_text_node( $test_class )
		) );
	}
	$tab->appendChild( $self->html_phrase( "render_tests", tests => $sub ) );

	return( $tab_title, $tab );
}

sub render_audit_tab
{
	my( $self, $title, $tests ) = @_;

	my $repo = $self->{repository};
	my $tab = $repo->xml->create_document_fragment;

	my $eprint = $self->{processor}->{eprint};
	my $flag = $eprint->value( "hoa_compliant" ) || 0;

	my $tab_title = $self->html_phrase( "render_audit_tab_title",
		class => $repo->xml->create_text_node( $flag & HefceOA::Const->$title ? "hoa_compliant" : "hoa_non_compliant" )
	);

	$tab->appendChild( $self->html_phrase( "render_audit_test_description" ) );

	my $sub = $repo->xml->create_document_fragment;
	for( @$tests )
	{
        my $test_class="audit_test ";
		$test_class .= ( $flag & HefceOA::Const->$_ ? "hoa_compliant" : "hoa_non_compliant" );
		$sub->appendChild( $self->html_phrase( "render_audit_test",
			title => $repo->html_phrase( "hefce_oa:test_title:$_" ),
			class => $repo->xml->create_text_node( $test_class )
		) );
	}
	$tab->appendChild( $self->html_phrase( "render_tests", tests => $sub ) );

	$tab->appendChild( $self->html_phrase( "render_audit_test_core_message" ) );

	return( $tab_title, $tab );
}

1;