Editing Archive:Https3 (section)

== Bugs ==

=== Broken Actions ===

Links which call Perl cgi scripts are broken – e.g. Under Manage Deposits, click New Item. Select an Item Type and then click Next. You will be returned to the Manage Deposits page, rather than to the next step in the workflow. This appears to be because the form action is pointing to http://publications.modhist.ox.ac.uk/cgi/users/home#t rather than /publications/cgi/users/home. As far as I can see, this is a bug, rather than a configuration mistake, though I'm happy to be advised otherwise.

The workaround I have for this bug is to install patch 252, which can be downloaded from http://files.eprints.org/252/

The patch seeks to resolve the problem by introducing a configuration variable users_url in 20_baseurls.pl. The use of perl_url has been replaced with users_url for all links to scripts in cgi/users. For insecure use, users_url can be set to perl_url. When https is requires, it can be adjusted appropriately.

Apply the patch to the EPrints 3.x source (patch -d eprints-3.0/ -p0 < users-url.patch) and re-run configure and install.pl. Add the following lines to /opt/eprints3/archives/repos1/cfg/cfg.d/20_baseurls.pl :

  $c->{secure_urlpath} = $c->{securepath};
  $c->{secure_url} = "https://".$c->{securehost}.($c->{secureport}!=443?":".$c->{secureport}:"").$c->{secure_urlpath};

  # Mod_perl scripts for users scripts
  # If not using https, make this the same as perl_url
  # Otherwise make it  $c->{secure_url}."/cgi"
  #$c->{users_url} = $c->{perl_url};
  $c->{users_url} = $c->{secure_url}."/cgi";

Similarly for /opt/eprints3/archives/repos2/cfg/cfg.d/20_baseurls.pl. Restart Apache. It should now be possible to upload documents, step through workflows etc.

However, some bugs with image urls remain.

=== Internet Explorer 'Secure and non Secure items' ===

We're not done yet! Internet Explorer complains if non-secure (http) and secure (https) items are displayed on the same page. This happens when a full url, beginning http:// is embedded in a page that is https. If the securepath and url_path variables were the same, e.g. we were using http://repos1.FQDN/repos1 and https://eprints.FQDN/repos1 then we could simply make all urls relative, but because they are different, e.g http://repos1.FQDN/ and https://eprints.FQDN/repos1 we must handle the secure and non-secure cases separately.

Edit /opt/eprints3/archives/repos1/cfg/lang/en/templates/secure.xml to use full https:// urls for included javascript and css and for the logo and .ico files. The head section should look something like this:

  <head>
    <title><epc:pin ref="title" textonly="yes"/> - <epc:phrase ref="archive_name"/></title>
    <script src="{$config{secure_url}}/javascript/auto.js" type="text/javascript"><!-- nope --></script>
    <style type="text/css" media="screen">@import url(<epc:print expr="$config{secure_url}"/>/style/secure_auto.css);</style>
    <style type="text/css" media="print">@import url(<epc:print expr="$config{secure_url}"/>/style/print.css);</style>
    <link rel="icon" href="{$config{secure_url}}/favicon.ico" type="image/x-icon"/>
    <link rel="shortcut icon" href="{$config{secure_url}}/favicon.ico" type="image/x-icon"/>
    <link rel="Top" href="{$config{frontpage}}"/>
    <link rel="Search" href="{$config{perl_url}}/search"/>
    <epc:pin ref="head"/>
  </head>
  <body bgcolor="#ffffff" text="#000000">
  div class="ep_noprint">
  <noscript><style type='text/css'>@import url(<epc:print expr="$config{secure_url}"/>/style/nojs.css);</style></noscript>
  </div>
  <epc:pin ref="pagetop"/>
  div class="ep_tm_header ep_noprint">
  div class="ep_tm_logo"><a href="{$config{frontpage}}"><img alt="Logo" src="{$config{secure_url}}{$config{site_logo}}" /></a></div>

also change the link to the EPrints logo in the footer:

  <a href="http://eprints.org/software/"><img src="{$config{secure_url}}/images/eprintslogo.gif" border="0"/></a>

We now need to modify 'generate_static' to create the secure_auto.css file as well as auto.css. The relevant section should be modified like this:

   # do the magic auto.js and auto.css
        my $js = "";
        my $css = "";
        my $secure_css ="";
        my $fn;
        my $base_url = $session->get_repository->get_conf( "base_url" );
        my $secure_url =  $session->get_repository->get_conf( "secure_url" );
        foreach my $target ( sort keys %{$map} )
        {
                if( $target =~ m/(\/style\/auto\/.*\.css$)/ )
                {
                        $css .= "\@import url($base_url$1);\n";
                        $secure_css .= "\@import url($secure_url$1);\n";
                }       
                if( $target =~ m/(\/javascript\/auto\/.*\.js$)/ )
                {
                        $fn = $map->{$target};
                        open( JS, $fn ) || EPrints::abort( "Can't read $fn: $!" );
                        $js .= "\n\n\n/* From: $fn */\n\n";
                        $js .= join( "", <JS> );
                        close JS;                        }        
        }
  
        $fn = "$base_target_dir/style/auto.css";
        open( CSS, ">$fn" ) || EPrints::abort( "Can't write $fn: $!" );
        $wrote_files->{$fn} = 1;
        print CSS $css;
        close CSS;
  
        $fn = "$base_target_dir/style/secure_auto.css";
        open( CSS, ">$fn" ) || EPrints::abort( "Can't write $fn: $!" );
        $wrote_files->{$fn} = 1;
        print CSS $secure_css;
        close CSS;
  
Re-run generate_static repos1.

=== Missing Images ===

A number of image links will be broken because eprints is looking for them on urlpath rather than on secureurl. In some cases this can be fixed by replacing urlpath with secureurl in the code, but some phrases may appear on both secure and insecure pages. Therefore we also need a solution which can be evaluated by a epin in a template. The cleanest way I could find of doing this is as follows:

Add two methods to  EPrints::Session


  ######################################################################
  =pod
  
  =item $foo = $session->get_baseurl()
  
  Gets the base url for images, depending on whether the session is secure
  or not (N.B. by secure we mean EPrints_secure is yes)
  Added by CSH 26 June 2007
  
  =cut
  ######################################################################
  sub get_baseurl
  {
  	my( $self ) = @_;
  	
  	my $esec = $self->get_request->dir_config( "EPrints_Secure" );
     	if( defined $esec && $esec eq "yes" )
  	{
     		return $self->get_repository->get_conf( "securepath" );
   	}
   	else
   	{
   		return $self->get_repository->get_conf( "base_url" );
   	}		
  }
  
  ######################################################################
  =pod
   
  =item $foo = $session->get_imageurl()
  
  Gets the base url for images, depending on whether the session is secure
  or not (N.B. by secure we mean EPrints_secure is yes)
  Added by CSH 26 June 2007
  
  =cut
  ######################################################################
  sub get_imageurl
  {
  	my( $self ) = @_;
  	
  	return $self->get_baseurl."/style/images/";
  }  

Search through the eprints code for every occurrence of the string /style/images/ and replace with a call to get_imageurl

e.g. In /opt/eprints/perl_lib/EPrints/Plugin/Screen/Items.pm, change the line

  my $imagesurl = $self->{session}->get_repository->get_conf( "urlpath" )."/style/images";

to

  my $imagesurl = $self->{session}->get_imageurl;


We will add a variable called baseurl to the variables available in a script:

In the execute method of EPrints::Script, add:

  $state->{baseurl} = [$state->{session}->get_baseurl, "STRING" ];

before the run command is called on the compiler. It will now be possible to get the url for images in a phrase through {$baseurl}

In /opt/eprints3/lib/lang/en/phrases/system.xml, change the links to images in the following phrases to use $baseurl

sys:ep_form_required
Plugin/InputForm/Surround/Default:show_help
Plugin/InputForm/Surround/Default:hide_help
lib/session:show_help
lib/session:hide_help


e.g. the ep_form_required phrase becomes:

  <epp:phrase id="sys:ep_form_required"><img src="{$baseurl}/style/images/required.png" border="0" class="ep_required" alt="Required"/>&nbsp;<epc:pin name="label"/></epp:phrase>

If some repositories aren't using https, you may prefer to override these phrases on a per repository basis.