lib/SGN.pm

   1
   2 =head1 NAME
   3
   4 SGN - Catalyst-based application to run the SGN website.
   5
   6 =head1 SYNOPSIS
   7
   8     script/sgn_server.pl
   9
  10 =head1 DESCRIPTION
  11
  12 This is the main class for the Sol Genomics Network main website.
  13
  14 =cut
  15
  16 package SGN;
  17 use Moose;
  18 use namespace::autoclean;
  19
  20 BEGIN {
  21     $ENV{WEB_PROJECT_NAME} = $ENV{PROJECT_NAME} = __PACKAGE__;
  22 }
  23
  24 use SGN::Exception;
  25
  26 use Catalyst::Runtime 5.80;
  27
  28 =head1 ROLES
  29
  30 Does the roles L<SGN::Role::Site::Config>,
  31 L<SGN::Role::Site::DBConnector>, L<SGN::Role::Site::DBIC>,
  32 L<SGN::Role::Site::Exceptions>, L<SGN::Role::Site::Files>,
  33 L<SGN::Role::Site::Mason>, L<SGN::Role::Site::SiteFeatures>,
  34 L<SGN::Role::Site::TestMode>
  35
  36 =cut
  37
  38 use Catalyst qw/
  39      ConfigLoader
  40      Static::Simple
  41      Authentication
  42      +SGN::Authentication::Store
  43      Authorization::Roles
  44      +SGN::Role::Site::Config
  45      +SGN::Role::Site::DBConnector
  46      +SGN::Role::Site::DBIC
  47      +SGN::Role::Site::Exceptions
  48      +SGN::Role::Site::Files
  49      +SGN::Role::Site::Mason
  50      +SGN::Role::Site::SiteFeatures
  51      +SGN::Role::Site::TestMode
  52  /;
  53
  54 extends 'Catalyst';
  55
  56 =head1 METHODS
  57
  58 =cut
  59
  60 # configure catalyst-related things.  in general, things should not be
  61 # added here.  add them to SGN.conf, with comments.
  62 __PACKAGE__->config(
  63
  64     name => 'SGN',
  65     root => 'static',
  66
  67     disable_component_resolution_regex_fallback => 1,
  68
  69     default_view => 'Mason',
  70
  71     # Static::Simple configuration
  72     static => {
  73         dirs => [qw[ css s static img documents static_content data ]],
  74     },
  75
  76     'Plugin::ConfigLoader' => {
  77         substitutions => {
  78             UID       => sub { $> },
  79             USERNAME  => sub { (getpwuid($>))[0] },
  80             GID       => sub { $) },
  81             GROUPNAME => sub { (getgrgid($)))[0] },
  82            },
  83        },
  84
  85     # configure SGN::Role::Site::TestMode.  These are the
  86     # configuration keys that it will change so that they point into
  87     # t/data
  88     'Plugin::TestMode' => {
  89         test_data_dir => __PACKAGE__->path_to('t','data'),
  90         reroot_conf   =>
  91             [qw(
  92
  93                 blast_db_path
  94                 cluster_shared_tempdir
  95                 ftpsite_root
  96                 image_path
  97                 genefamily_dir
  98                 homepage_files_dir
  99                 intron_finder_database
 100                 r_qtl_temp_path
 101                 static_content_path
 102                 static_datasets_path
 103                 trace_path
 104
 105                )],
 106        },
 107
 108     'Plugin::Cache'=>{
 109         backend => {
 110             store =>"FastMmap",
 111         },
 112     },
 113
 114
 115
 116     'Plugin::Authentication' => {
 117         default_realm => 'default',
 118         realms => {
 119             default => {
 120                 credential => {
 121                     class => '+SGN::Authentication::Credentials',
 122                 },
 123
 124                 store => {
 125                     class => "+SGN::Authentication::Store",
 126                     user_class => "+SGN::Authentication::User",
 127 ###                 role_column => 'roles',
 128                 },
 129             },
 130         },
 131     },
 132
 133     ( $ENV{SGN_TEST_MODE} ? ( test_mode => 1 ) : () ),
 134 );
 135
 136
 137 # on startup, do some dynamic configuration
 138 after 'setup_finalize' => sub {
 139     my $self = shift;
 140
 141     $self->config->{basepath} = $self->config->{home};
 142
 143     # all files written by web server should be group-writable
 144     umask 000002;
 145
 146     # update the symlinks used to serve static files
 147     $self->_update_static_symlinks;
 148 };
 149
 150 __PACKAGE__->setup;
 151
 152 sub _update_static_symlinks {
 153     my $self = shift;
 154
 155     # symlink the static_datasets and
 156     # static_content in the root dir so that
 157     # Catalyst::Plugin::Static::Simple can serve them.  in production,
 158     # these will be served directly by Apache
 159
 160     # make symlinks for static_content and static_datasets
 161     my @links =
 162         map [ $self->config->{$_.'_path'} =>
 163                $self->path_to( $self->config->{root}, $self->config->{$_.'_url'} )
 164             ],
 165         qw( static_content static_datasets );
 166
 167     for my $link (@links) {
 168         if( $self->debug ) {
 169             my $l1_rel = $link->[1]->relative( $self->path_to );
 170             $self->log->debug("symlinking static dir '$link->[0]' -> '$l1_rel'") if $self->debug;
 171         }
 172         unlink $link->[1];
 173         symlink( $link->[0], $link->[1] )
 174             or die "$! symlinking $link->[0] => $link->[1]";
 175     }
 176 }
 177
 178 =head1 SEE ALSO
 179
 180 L<SGN::Controller::Root>, L<Catalyst>
 181
 182 =head1 AUTHOR
 183
 184 The SGN team
 185
 186 =head1 LICENSE
 187
 188 This library is free software. You can redistribute it and/or modify
 189 it under the same terms as Perl itself.
 190
 191 =cut
 192
 193 1;