Drupal Install Profile

запостил: deimos
Версия Друпала:
6.x

Наверняка все сталкивались с готовыми сборками сайтов на Drupal, когда после установки получаешь готовый сайт с набором необходимых модулей, своей темой и т.д. Существует большое количество таких сборок, среди них Open Atrium, Drupal Commons и т.п. Думаю возникал вопрос "А как это реализовано? или "Как это сделать?" Ответ на этот вопрос - Drupal Install Profile. И так, как создать свой установочный профиль. В основном инсталляционные профили создаются на основе существующего сайта.

Шаг 1. Подготовка файлов.

Создаем папку "modules", в ней папку "contrib", в которую копируем все необходимые для работы сайта модули. Создаем папку "themes", в которой размещаем папку с нашей темой, например acquia_prosper, и набором .tpl.php и .js и .css файлов, созданных в процессе разработки сайта. Для включения некоторых особых элементов сайта в сборку, таких как views, типы контента, меню, роли, права доступа и т.д., используется модуль Features. Созданые "фичи" положим в папку "features" и разместим в папке "modules".

Примечание: На данный момент модуль Features не переносит словари таксономии и термины в них, возможно это будет реализовано в следующих версиях модуля, поэтому это приходится выполнять вручную. Об этом будет написано ниже.

Получаем структуру:

    myprofile
    • modules
    • contrib
    • features
  • themes

Шаг 2. Создание файла .profile.

Этот файл является "мозгом" нашего профиля, он руководит процессом установки сайта.

Примечание: На данном этапе работы сайта фукнция t() не работает, поэтому используется ее эквивалент - st ().

2.1. Создаем файл myprofile.profile.

2.2. _profile_modules().

В файле формируем функцию myprofile_profile_modules (). В этой функции описываются модули, которые после установки должны быть включены.

<?php
// $Id$

// Указываем id словаря таксономии
define('MYPROFILE_NEWS_VOCAB_ID', 1);

// Указываем название темы
define('MYPROFILE_ACQUIA_THEME', 'acquia_prosper');
define('MYPROFILE_FUSION_CORE', 'fusion_core');


/**
 * Возвращает массив модулей, которые будут включены после установки профиля
 */
function myprofile_profile_modules() {
  $modules = array(
    // Default Drupal modules.
    'color', 'comment', 'dblog', 'help', 'menu', 'path', 'taxonomy',
    
    //ADMINISTRATION
    'admin', 'admin_menu',
    
    //CCK
    'content', 'text', 'ctools', 'content_permissions', 'fieldgroup', 'filefield',
    'optionwidgets', 'nodereference', 'userreference',
    
    //FILEFIELD PATHS
    'filefield_paths',
                
    //IMAGECACHE
    'imageapi', 'imageapi_gd', 'imagecache', 'imagecache_ui', 'imagecache_customactions',
    
    //TOKEN
    'token',
    
    //VIEWS
    'views', 'views_bulk_operations', 'viewscarousel', 'views_export', 'views_or', 'views_slideshow',
    'views_ui',
    
    //META TAGS
    'nodewords', 'nodewords_basic', 'nodewords_extra', 'nodewords_verification_tags',
                
    //USER INTERFACE
    'imce', 'wysiwyg', 'jquery_ui', 'jquery_update', 'dialog','vertical_tabs', 'imce_wysiwyg',
                
    //SKINR
    'skinr', 'skinr_ui',
                
    //OTHER
    'better_formats', 'globalredirect', 'no_anon', 'pathauto',
    'url_alter', 'subpath_alias', 'token_actions', 'transliteration', 'vertical_tabs',
                
    //UBERCART
    'ca', 'uc_order', 'uc_store', 'uc_product', 'uc_cart',
    'uc_payment', 'uc_reports', 'uc_shipping', 'uc_product_power_tools', 'uc_stock',
                
    //XML SITEMAP
    'xmlsitemap', 'xmlsitemap_engines', 'xmlsitemap_menu', 'xmlsitemap_node'
  );

  return $modules;
}
?>

Примечание: Модули, которые являются зависимыми от других (depends on), должны быть указаны после модулей, от которых они зависят. Также возникают проблемы при включении модуля url_alter. Решение можно найти здесь.

2.3. _profile_details().

Описание профиля, которое будет выведено на экране установки профиля.

<?php
/** @return
 * array with keys "name" and "description", describing the given profile,
 * and additional "language", to redefine language for a profile
 */
function myprofile_profile_details() {
  $description = st('Select this profile to install the My custom profile.');
  
  return array(
    'name' => 'My profile',
    'description' => $description,
  );
}
?>

2.4. _profile_task_list()

Список задач, которые будут выполняться при установке профиля.

<?php
function myprofile_profile_task_list() {
  $tasks = array();
  $tasks['configure-myprofile'] = st('Configure My profile');
  $tasks['install-myprofile'] = st('Install My profile');
  return $tasks;
}
?>

2.5. _profile_tasks(&$task, $url)

Данная функция отвечает непосредственно за этап установки профиля.

<?php
/**
 * Выполняет окончательные задачи установки профиля.
 */
function myprofile_profile_tasks(&$task, $url) {
  // пропустим стандартный этап установки
  if ($task == 'profile') {
    $task = 'install-myprofile';  
  }
  
  // Вызывает форму выбора "фич"
  if ($task == 'configure-myprofile') {
    $output = drupal_get_form('myprofile_features_form', $url);
  }
  
  // Инсталляционный batch процесс
  if ($task == 'install-myprofile') {
    $operations = array();
    
    // Доустановочные операции
    $operations[] = array('myprofile_config_taxonomy', array()); // создание словаря таксономии
    
    // Установка "фич"
    $features = variable_get('myprofile_selected_features', array());
    foreach ($features as $feature) {
      $operations[] = array('features_install_modules', array(array($feature)));
    }

    // Послеинсталляционные операции
    $operations[] = array('myprofile_config_theme', array()); // включения собственной темы
    $operations['finished'] = 'myprofile_configure_batch_finished';
  
    // Строим batch процесс
    $batch = array(
      'operations' => $operations,
      'title' => st('Configuring My profile'),
      'error_message' => st('An error occurred. Please try reinstalling again.'),
      'finished' => 'myprofile_cleanup',
    );
  
    // Старт batch
    variable_set('install_task', 'install-myprofile-batch');
    batch_set($batch);
    batch_process($url, $url);
  }
  
  // Показывает страницу выполнения batch
  if ($task == 'install-myprofile-batch') {
    include_once 'includes/batch.inc';
    $output = _batch_page();
  }
  
  return $output;
}
?>

2.6. _features_form()

Форма выбора созданных "фич", для переноса их функционала на сайт.

<?php
function myprofile_features_form($form_state, $url) {
  $form = array();
  drupal_set_title(st('Choose from available features'));
  
  // Вспомогательное сообщение
  $form['message'] = array(
    '#type' => 'item',
    '#value' => st('The selected features will be enabled after the installation has completed. At any time, you can turn the available features on or off.'),
  );

  $form['content'] = array(
    '#type' => 'checkbox',
    '#title' => st('Content types'),
    '#default_value' => 1,
    '#description' => st('Some test content types'),
  );
  $form['menu_links'] = array(
    '#type' => 'checkbox',
    '#title' => st('Menu'),
    '#default_value' => 1,
    '#description' => st('Some test menu'),
  );
  $form['views_default'] = array(
    '#type' => 'checkbox',
    '#title' => st('View'),
    '#default_value' => 1,
    '#description' => st('Some test view'),
  );

  // Возвращает к установке без ее прерывания
  $form['url'] = array(
    '#type' => 'value',
    '#value' => $url,
  );
  
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => st('Continue'),
  );
  
  return $form;
}
?>

2.7. _features_form_submit()

Эта функция формирует массив выбранных "фич".

<?php
function myprofile_features_form_submit(&$form, &$form_state) {
  // Массив выбранных "фіч"
  $features = array();
  foreach ($form_state['values'] as $key => $value) {
    $features[] = $key;
  }
  
  // Сформируем временную переменную с выбранными "фичами"
  variable_set('myprofile_selected_features', $features);
  
  // Инициируем следующий шаг установки
  variable_set('install_task', 'install-myprofile');
  
  // Возвращаемся к странице установки
  drupal_goto($form_state['values']['url']);
}
?>

2.8. _config_taxonomy()

Создаем словарь таксономии.

<?php
function myprofile_config_taxonomy() {  
   $vocab = array(
    'name' => st('Test'),
    'description' => st('Test vocabulary'),
    'multiple' => '1',
    'required' => '1',
    'hierarchy' => '1',
    'relations' => '1',
    'tags' => '0',
    'module' => 'taxonomy',
  );
  taxonomy_save_vocabulary($vocab); 
  db_query("UPDATE {vocabulary} SET vid = %d WHERE name = '%s", MYPROFILE_NEWS_VOCAB_ID, st('Test'));
}
?>

2.9. _config_theme()

Включаем собственную тему, т.е. она станет активной после установки.

<?php
function myprofile_config_theme() {
  // Выключаем тему garland
  db_query("UPDATE {system} SET status = 0 WHERE type = 'theme' and name = '%s'", 'garland');
  
  // Включаем темы fusion и acquia_prosper
  db_query("UPDATE {system} SET status = 1 WHERE type = 'theme' and name = '%s
                  ",  MYPROFILE_ACQUIA_THEME);
  db_query("UPDATE {system} SET status = 1 WHERE type = 'theme' and name = '%s
                  ", MYPROFILE_FUSION_CORE);

  // Ставим тему acquia_prosper по умолчанию
  variable_set('theme_default', MYPROFILE_ACQUIA_THEME);
  
  // Обновим реестр
  list_themes(TRUE);
  drupal_rebuild_theme_registry();
}
?>

2.10. _cleanup()

Убираем за собой  :) .

<?php
function myprofile_cleanup() {
  // Перестраиваем типы контента
  node_types_rebuild();
  
  // Очищаем кэш
  $core = array('cache', 'cache_block', 'cache_filter', 'cache_page');
  $cache_tables = array_merge(module_invoke_all('flush_caches'), $core);
  foreach ($cache_tables as $table) {
    cache_clear_all('*', $table, TRUE);
  }
  
  // Очищаем JS и CSS кэшы
  drupal_clear_css_cache();
  drupal_clear_js_cache();
  
  // "Фичи" должны быть возвращены
  $revert = array(
    'myprofile_features' => array('content', 'menu_links', 'views_default')
  );
  features_revert($revert);  
  
  // Завершаем установку
  variable_set('install_task', 'profile-finished');
}
?>

Создан myprofile.profile нужно разместить в папке "myprofile". Конечная структура файлов:

    myprofile
    • modules
    • contrib
    • features
  • themes
  • myprofile.profile

И последнее, что нужно сделать, это перенести папку с нашим профилем "myprofile" в дистрибутив Drupal по пути drupal-6.х -> profiles.

Примечание: Данный пример сделан на основе Drupal Commons, он может послужить примером реализации установочного профиля.

Итак, подытожим. Для того, чтобы создать свой установочный профиль, нам необходимо создать "упаковку " с необходимыми модулями, "фичами" и темой, а также создать файл .profile.

Тэги:
Drupal, features, install profile