CGI :: Application: простая расширяемая веб-платформа

В прошлый раз мы представили концепцию размещения нашего HTML вместо кода Perl в отдельных шаблонах . Наряду с предоставлением простого способа сохранить внешний вид сайта, этот подход также удаляет много нежелательных шумов из наших программ. Как разработчики, наша задача — учитывать потребности бизнеса; необходимость беспокоиться о пользовательском интерфейсе может отвлекать.

Следующим шагом является рассмотрение того, как мы можем на самом деле добавить структуру и удобство обслуживания в наш код Когда мы пишем простые приложения, у нас может быть сценарий, который запускается с первой строки до последней, но в конечном итоге мы хотим структурированный способ построения нашего приложения, который поощряет возможность повторного использования и сопровождения. По сути, мы хотим четко определенную структуру.

Многие веб-приложения имеют концепцию «режима запуска», хотя они могут не использовать эту терминологию. Примеры режимов запуска могут быть:

• Создать пользователя
• редактировать пользователя
• список usrs

Режимы выполнения обычно закодированы в параметрах страницы, и нередко можно видеть запутанную логику, подобную той, которая содержится в следующем псевдокоде:

if (run_mode  eq 'create_user') { 

    perform create user code 

} elsif (run mode eq 'edit_user') { 

    perform edit user code  

} elsif (run mode eq 'list_users') { 

    perform list code 

} else { 

    error - invalid run mode 

}

Цель CGI :: Application — предоставить основу для повторно используемого кода, основанную на концепции режима выполнения, но таким образом, чтобы избежать большого количества спагетти-кода. Поскольку он является объектно-ориентированным (ОО), его можно легко расширять и улучшать, а позже мы рассмотрим некоторые плагины, которые значительно облегчат вашу работу. Но если вы не специалист по ОО, не бойтесь: вы не обязаны интенсивно использовать ОО-методы, если не хотите.

CGI :: Application рекомендует вам принять платформу Model-View-Controller (MVC). В мире веб-разработки MVC стал популярной концепцией для инженерных приложений, хотя его корни появились еще до Интернета. Модель — это фактическая бизнес-область, в которой вы работаете. Она включает логику и правила, которые приложение понимает и применяет. Представление — это просто пользовательский интерфейс, и по умолчанию CGI :: Application поддерживает HTML :: Template, хотя может использоваться любое шаблонное решение. Наконец, контроллер является посредником между моделью и представлением. Он принимает входные данные, передает их компонентам модели и при необходимости вызывает компоненты представления.

Образец заявки

Теперь, когда у нас есть модные слова, пришло время обнаружить, что реализовать простое приложение действительно довольно легко. Представьте, например, что нам нужно поддерживать пользователей в нашем приложении, и нам нужно записать следующие детали:

• usernamefirst_name
• last_name
• email
• password
• receive_newsletter
• display_user_form

Мы заранее знаем, что нам понадобятся следующие режимы работы:

• maintain_user
• list_users
•  1  package MyApp::User;
 2  use strict;
 3  use base 'CGI::Application';
 4  use CGI::Application::Plugin::DBH        (qw/dbh_config dbh/);
 5  use CGI::Application::Plugin::ConfigAuto (qw/cfg cfg_file/);
 6  use Data::Dumper;
 7
 8  # Define our run modes
 9  sub setup {
10      my $self = shift;
11      $self->start_mode('display_user_form');
12      $self->error_mode('error');
13      $self->mode_param('rm');
14      $self->run_modes(
15          'display_user_form' => 'display_user_form',
16          'maintain_user'     => 'maintain_user',
17          'list_users'        => 'list_users',
18      );
19  }
20
21  # Execute the following before we execute the requested run mode
22  sub cgiapp_prerun {
23  }
24
25  # Process any fatal errors
26  sub error {
27      my $self  = shift;
28      my $error = shift;
29      return "There has been an error: $error";
30  }
31
32  # Display the form for creating/maintaining users
33  sub display_user_form {
34  }
35
36  # Process the submitted form
37  sub maintain_user {
38  }
39
40  # List users for editing
41  sub list_users {
42  }
43
44  # Rules for validating the submitted form parameters
45  sub _user_profile {
46  }
47
48  # We don't want to store plain text passwords....
49  sub _encrypt_password {
50  }
51
52  # Create a new user record in the database
53  sub _create_user {
54  }
55
56  # Update an existing user record in the database
57  sub _update_user {
58  }
59
60  # Retrieve the list of users from the database
61  sub _get_users {
62  }
63
64  # Retrieve the record for a given user_id
65  sub _retrieve_user_details {
66  }
67  1;

Скелет нашего приложения будет выглядеть так:

 MyApp::User

Строка 1: наше приложение реализовано в пакете, который мы назвали $banana Perl реализует свои классы в пакетах.

Строка 2: эта прагма включает строгую проверку. Он улавливает ошибки, которые часто допускаются в скриптовых языках, например, при опечатке в имени переменной, вынуждая разработчика объявлять переменную перед ее использованием ( $banananadisplay_user_form Есть и другие преимущества, которые у нас нет времени обсуждать здесь. Вы всегда должны использовать эту прагму.

Строка 3: Здесь мы наследуем все функции CGI :: Application. Для многих приложений это почти столько же ОО, сколько вам нужно знать.

Строка 4: этот плагин обрабатывает файлы конфигурации.

Строка 5: этот плагин предоставляет API для стандартного интерфейса базы данных Perl.

 @INC

   1  <!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">  

  2  <html>  

  3  <head>  

  4  <title>Maintain Users</title>  

  5  </head>  

  6  <body>  

  7  <tmpl_include menu.tmpl><br><br>  

  8  <tmpl_var name=message>  

  9  <tmpl_if some_errors>There are errors in your form</tmpl_if>  

 10  <form action="" method="post">  

 11    <table>  

 12      <tr>  

 13        <td>Username<tmpl_unless user_id>*</tmpl_unless></td>  

 14        <td><tmpl_unless user_id>  

 15                        <input type="Text" name="username" size="15"  

 16                            value="<tmpl_var name=username>">  

 17                    <tmpl_var name=err_username>  

 18                    <tmpl_else>  

 19                        <tmpl_var name=username>  

 20                    </tmpl_unless>  

 21            </td>  

 22      </tr>  

 23      <tr>  

 24        <td>First Name*</td>  

 25        <td><input type="Text" name="first_name" size="15"  

 26                value="<tmpl_var name=first_name>">  

 27                <tmpl_var name=err_first_name></td>  

 28      </tr>  

 29      <tr>  

 30        <td>Last Name*</td>  

 31        <td><input type="Text" name="last_name" size="15"  

 32                value="<tmpl_var name=last_name>">  

 33                <tmpl_var name=err_last_name></td>  

 34      </tr>  

 35      <tr>  

 36        <td>Email</td>  

 37        <td><input type="Text" name="email" size="15"  

 38                value="<tmpl_var name=email>">  

 39                <tmpl_var name=err_email></td>  

 40      </tr>  

 41      <tr>  

 42        <td>Password<tmpl_unless user_id>*</tmpl_unless></td>  

 43        <td><input type="Password" name="password" size="15"  

 44                value="<tmpl_var name=password>">  

 45                <tmpl_var name=err_password> <tmpl_var name=err_user_id></td>  

 46      </tr>  

 47      <tr>  

 48        <td>Repeat Password<tmpl_unless user_id>*</tmpl_unless></td>  

 49        <td><input type="Password" name="password2" size="15"  

 50                value="<tmpl_var name=password2>">  

 51                <tmpl_var name=err_password2></td>  

 52      </tr>  

 53      <tr>  

 54        <td>Receive Newsletter</td>  

 55        <td><input type="Checkbox" name="receive_newsletter" value="y"  

 56                <tmpl_var name=checked>></td>  

 57      </tr>  

 58      <tr>  

 59        <td colspan="2"><input type="Submit" value="Save"></td>  

 60      </tr>  

 61    </table>  

 62    <input type="Hidden" name="user_id" value="<tmpl_var name=user_id>">  

 63    <input type="Hidden" name="rm" value="maintain_user">  

 64  </form>  

 65  </body>  

 66  </html>

 username

 $q

   1  sub maintain_user {  

  2      my $self = shift;  

  3      my $q    = $self->query;  

  4  

  5      if ($q->param('user_id') == 0) {  

  6          $self->_create_user();  

  7      } else {  

  8          $self->_update_user();  

  9      }  

 10  

 11      $self->param('message', 'User saved');  

 12      $self->display_user_form();  

 13  }

 "qr/^[a-z]w{2,5}$/i"

   1  sub maintain_user {   

  2      my $self = shift;   

  3      my $q    = $self->query;   

  4   
  5      use CGI::Application::Plugin::ValidateRM (qw/check_rm/);   

  6      my ($results, $err_page) =   

  7          $self->check_rm('display_user_form', '_user_profile');   

  8      return $err_page if $err_page;   

  9   

 10      if ($q->param('user_id') == 0) {   

 11          $self->_create_user();   

 12      } else {   

 13          $self->_update_user();   

 14      }   

 15   

 16      $self->param('message', 'User saved');   

 17      $self->display_user_form();   

 18  }

 $cfg{user}            = 'myusername';         

$cfg{password}        = 'mypassword';     

$cfg{dsn}             = 'dbi:driver:mydb';    

$cfg{template_path}   = 'templates/';    

%cfg;

   1  #!c:/perl/bin/perl -T    

  2  use lib 'path/to/my/libs';    

  3  use strict;    

  4  use CGI::Carp qw(fatalsToBrowser);    

  5  use MyApp::User;    
  6  my $webapp = MyApp::User->new();    

  7  $webapp->cfg_file('myapp.cfg');    

  8  $webapp->run();

   1  sub cgiapp_prerun {    

  2      my $self = shift;    

  3      $self->dbh_config($self->cfg('dsn'), $self->cfg('user'),    

  4          $self->cfg('password'));    

  5      $self->tmpl_path($self->cfg('template_path'));    

  6  }

 $sth = $dbh->prepare("select column from table");

 $sth = $self->dbh->prepare("select column from table");

   1  sub _encrypt_password {    

  2      my $password = shift;    

  3      my @chars    = ('.', '/', 0 .. 9, 'A' .. 'Z', 'a' .. 'z');    

  4      my $salt     = $chars[rand @chars] . $chars[rand @chars];    

  5      return crypt($password, $salt);    

  6  }    

  7    

  8  sub _create_user {    

  9      my $self = shift;    

 10      my $q    = $self->query;    

 11    

 12      my $encrypted_password = _encrypt_password($q->param('password'));    

 13    

 14      my $sql = "insert into app_user (username, password, first_name, last_name,    

 15          email, receive_newsletter) values (?, ?, ?, ?, ?, ?)";    

 16    

 17      $self->dbh->{PrintError} = 0;    

 18      $self->dbh->{RaiseError} = 1;    

 19      $self->dbh->do($sql, undef, ($q->param('username'), $encrypted_password,    

 20          $q->param('first_name'), $q->param('last_name'), $q->param('email'),    

 21          $q->param('receive_newsletter')));    

 22  }

 use base 'CGI::Application';

 use base 'MyApp::Base';

 $self->session->param('logged-in', 'y');

 return if ($self->session->param('logged-in') eq 'y');