Difference between revisions of "MePrintsInstall"
Line 1: | Line 1: | ||
+ | |||
+ | For an overview of MePrints features, see MePrintsFeatures. | ||
+ | |||
+ | ==Installation (EPrints 3.1+)== | ||
+ | |||
+ | Download the latest release to your local repository directory (eg. /opt/eprints3/archives/ARCHIVEID/). | ||
+ | |||
+ | Extract files: | ||
+ | |||
+ | tar xzvf meprints_xx.tgz | ||
+ | |||
+ | ===Installing bin scripts=== | ||
+ | |||
+ | Edit the bin/generate_meprints file and check the include path on the first line. For example if you have installed EPrints in /var/lib/eprints3 change the line from: | ||
+ | |||
+ | #!/usr/bin/perl -w -I/opt/eprints3/perl_lib | ||
+ | |||
+ | to: | ||
+ | |||
+ | #!/usr/bin/perl -w -I/var/lib/eprints3/perl_lib | ||
+ | |||
+ | ===Installing cgi scripts=== | ||
+ | |||
+ | Link the meprints cgi scripts into the EPrints cgi directory: | ||
+ | |||
+ | ln -s /opt/eprints3/archives/ARCHIVEID/cgi/meprints/ /opt/eprints3/cgi/ | ||
+ | ln -s /opt/eprints3/archives/ARCHIVEID/cgi/users/meprints/ /opt/eprints3/cgi/users/ | ||
+ | |||
+ | ===Add MePrints fields=== | ||
+ | |||
+ | Add the new MePrints user fields (defined in cfg/cfg.d/z_meprints.pl) to your repository database: | ||
+ | |||
+ | cd /opt/eprints3/ | ||
+ | bin/epadmin update_database_stucture ARCHIVEID --verbose | ||
+ | |||
+ | ==Getting Started== | ||
+ | |||
+ | To active MePrints, you will need to make some small changes to your EPrints setup. | ||
+ | |||
+ | ===bin/generate_meprints== | ||
+ | |||
+ | |||
==Patches== | ==Patches== | ||
Line 45: | Line 87: | ||
Quick Notes for meprints-1.0_rc1-2.tgz (from you to me) | Quick Notes for meprints-1.0_rc1-2.tgz (from you to me) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
2- bin/generate_meprints REPOSITORY_ID should work, test | 2- bin/generate_meprints REPOSITORY_ID should work, test |
Revision as of 10:58, 17 September 2009
For an overview of MePrints features, see MePrintsFeatures.
Contents
Installation (EPrints 3.1+)
Download the latest release to your local repository directory (eg. /opt/eprints3/archives/ARCHIVEID/).
Extract files:
tar xzvf meprints_xx.tgz
Installing bin scripts
Edit the bin/generate_meprints file and check the include path on the first line. For example if you have installed EPrints in /var/lib/eprints3 change the line from:
#!/usr/bin/perl -w -I/opt/eprints3/perl_lib
to:
#!/usr/bin/perl -w -I/var/lib/eprints3/perl_lib
Installing cgi scripts
Link the meprints cgi scripts into the EPrints cgi directory:
ln -s /opt/eprints3/archives/ARCHIVEID/cgi/meprints/ /opt/eprints3/cgi/ ln -s /opt/eprints3/archives/ARCHIVEID/cgi/users/meprints/ /opt/eprints3/cgi/users/
Add MePrints fields
Add the new MePrints user fields (defined in cfg/cfg.d/z_meprints.pl) to your repository database:
cd /opt/eprints3/ bin/epadmin update_database_stucture ARCHIVEID --verbose
Getting Started
To active MePrints, you will need to make some small changes to your EPrints setup.
=bin/generate_meprints
Patches
EPrints::Apache::Rewrite
- rewrite /profile/foo URLs
- check profile is public (to be moved out - MR)
EPrints::DataSet
- add public_profile_users pseudo dataset
EPrints::Update::View
- don't use hardcoded dataset
cgi/handle404
- not needed?
Changes
plugins.pl
- Add settings to use MePrints::Homepage instead of User::View
user_fields_automatic.pl
- Remove static on change
apachevhost.conf
<Directory "/opt/meprints_test/archives/meprints/user_profiles"> SetHandler perl-script PerlResponseHandler EPrints::Apache::Template::handler </Directory>
workflows/user/default.xml
add profile_visibility
Quick Notes for meprints-1.0_rc1-2.tgz (from you to me)
2- bin/generate_meprints REPOSITORY_ID should work, test
3- to have the static profiles rendered properly:
=pod Marcus: Open up bin/generate_apacheconf and after;
my $https_cgiroot = $repository->get_conf( "https_cgiroot" );
add;
my $profile_root = $repository->get_conf( "archiveroot" )."/user_profiles";
Next after;
<Directory "$htdocs_path"> SetHandler perl-script PerlResponseHandler EPrints::Apache::Template::handler </Directory>
add;
<Directory "$profile_root"> SetHandler perl-script PerlResponseHandler EPrints::Apache::Template::handler </Directory>
Run 'bin/generate_apacheconf' and then restart your web server to reflect the changes to the server configuration.
Test: If you now go to http://repositoryurl.com/cgi/meprints/profile?userid=1 you should see the profile id 1.
8. extras:
0- default user citation: replace default_with_thumbnail.xml with default.xml
1- for custom 404 errors when hitting a non-existing profile:
=pod marcus: For custom user not found errors update the code code in cgi/handle_404 so that it resembles the following;
if( defined $newurl ) {
$session->redirect( $newurl );
} elsif( $url =~ m#^$urlpath/profile/(.*)/?# ) {
&nouser_404( $session, $1 );
} elsif( $url =~ m#^$urlpath/view/# ) {
&noview_404( $session );
} else {
&plain_404( $session );
}
Now add a new subroutine to cgi/handle_404 called nouser_404;
sub nouser_404 {
my( $session, $username ) = @_;
$session->build_page( $session->html_phrase( "cgi/handle_http_error:404_user_title" ), $session->html_phrase( "cgi/handle_http_error:404_user_blurb", username => $session->make_text( $username ) ), "nouser_404" );
$session->send_page();
} =cut
2. To enable the pretty urls:
=pod marcus: Now the final step is to update perl_lib/EPrints/Apache/Rewrite.pm so that we can have pretty URLs for user profiles of the form http://repositoryurl.com/profile/USERNAME. Look for the following block;
$r->filename( $repository->get_conf( "htdocs_path" )."/".$lang.$localpath );
if( $uri =~ m#^/view(.*)# ) { my $session = new EPrints::Session(2); # don't open the CGI info EPrints::Update::Views::update_view_file( $session, $lang, $localpath, $uri ); $session->terminate; } else { EPrints::Update::Static::update_static_file( $repository, $lang, $localpath ); }
Replace it with;
# $r->filename( $repository->get_conf( "htdocs_path" )."/".$lang.$localpath );
if ( $uri =~ m! ^/profile\/([0-9a-z]+)(.*)$ !x ) {
my $session = new EPrints::Session(2); # don't open the CGI info
my $ds = $session->get_repository->get_dataset( 'hidden_profile_users' ); my $searchexp = EPrints::Search->new( satisfy_all => 1, session => $session, dataset => $ds );
$searchexp->add_field( $ds->get_field( 'username' ), $1 ); my $result = $searchexp->perform_search; if ( $result->count > 0 ) { return FORBIDDEN; }
$searchexp->clear;
$ds = $session->get_repository->get_dataset( 'registered_profile_users' ); $searchexp->set_dataset( $ds ); $searchexp->add_field( $ds->get_field( 'username' ), $1 ); $result = $searchexp->perform_search; if ( $result->count > 0 and not defined $session->current_user ) { return FORBIDDEN; }
my $user = EPrints::User::user_with_username( $session, $1 ); if ( defined $user ) { $r->filename( $repository->get_conf( 'archiveroot' )."/user_profiles/".$user->get_id."/profile/index.html" ); } } else { $r->filename( $repository->get_conf( 'htdocs_path' ).'/'.$lang.$localpath ); }
if( $uri =~ m#^/view(.*)# ) { my $session = new EPrints::Session(2); # don't open the CGI info EPrints::Update::Views::update_view_file( $session, $lang, $localpath, $uri ); $session->terminate; } else { EPrints::Update::Static::update_static_file( $repository, $lang, $localpath ); } =cut
9. Restart web server, generate views etc.