diff --git a/core/modules/block/block.install b/core/modules/block/block.install index c16e50a..4b52cfc 100644 --- a/core/modules/block/block.install +++ b/core/modules/block/block.install @@ -36,13 +36,14 @@ function block_install() { * Implements hook_update_dependencies(). */ function block_update_dependencies() { + debug('yo chocolates'); // Convert role IDs after User module converted {role}. $dependencies['block'][8002] = array( 'user' => 8002, ); // Migrate users.data after User module prepared the tables. $dependencies['block'][8005] = array( - 'user' => 8011, + 'user' => 8016, ); return $dependencies; } @@ -194,6 +195,220 @@ function block_update_8006() { } /** + * Make changes required to {block_custom}. + * + * Note this table now resides in custom_block_schema() but for 7.x to 8.x + * upgrades, changes must be made from block module as custom_block module is + * only enabled during upgrade process. + */ +function block_update_8007() { + // Add the {block_custom_revision} table. + db_create_table('block_custom_revision', array( + 'description' => 'Stores contents of custom-made blocks.', + 'fields' => array( + 'bid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => "The block's {block}.bid.", + ), + // Defaults to NULL in order to avoid a brief period of potential + // deadlocks on the index. + 'vid' => array( + 'description' => 'The current version identifier.', + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'log' => array( + 'description' => 'The log entry explaining the changes in this version.', + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + ), + ), + 'unique keys' => array( + 'vid' => array('vid'), + ), + 'primary key' => array('vid'), + )); + // Add the vid column to {block_custom}. + db_add_field('block_custom', 'vid', array( + 'description' => 'The current {block_custom_revision}.vid version identifier.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => FALSE, + 'default' => NULL, + ), array( + 'unique keys' => array( + 'vid' => array('vid'), + ), + )); + // Add the uuid column to {block_custom}. + db_add_field('block_custom', 'uuid', array( + 'description' => 'Unique Key: Universally unique identifier for this entity.', + 'type' => 'varchar', + 'length' => 128, + 'not null' => FALSE, + ), + array( + 'unique keys' => array( + 'uuid' => array('uuid'), + ), + )); + // Add the machine_name column to {block_custom}. + db_add_field('block_custom', 'machine_name', array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => 'Machine name of block.', + )); + // Add the type column to {block_custom}. + db_add_field('block_custom', 'type', array( + 'description' => 'The type of this custom block.', + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + )); + // Add the langcode column to {block_custom}. + db_add_field('block_custom', 'langcode', array( + 'description' => 'The {language}.langcode of this node.', + 'type' => 'varchar', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', + )); + // Populate the {custom_block_revision} table. + $results = db_select('block_custom', 'bc')->fields('bc')->execute(); + foreach ($results as $block) { + $revision = array( + 'bid' => $block->bid, + 'log' => 'Initial value from 7.x to 8.x upgrade' + ); + drupal_write_record('custom_block_revision', $revision); + db_update('block_custom')->values( + array( + 'vid' => $revision['vid'], + 'langcode' => LANGUAGE_NOT_SPECIFIED, + 'type' => 'basic', + 'machine_name' => preg_replace('^([a-z|0-9|\_]', '', $block->info) + ) + )->condition('bid', $block->bid)->execute(); + } +} + +/** + * Generate a UUID for all comments. + */ +function block_update_8008(&$sandbox) { + if (!isset($sandbox['progress'])) { + $sandbox['progress'] = 0; + $sandbox['last'] = 0; + $sandbox['max'] = db_query('SELECT COUNT(bid) FROM {block_custom} WHERE uuid IS NULL')->fetchField(); + } + + $bids = db_query_range('SELECT bid FROM {block_custom} WHERE bid > :bid AND uuid IS NULL ORDER BY bid ASC', 0, 10, array(':bid' => $sandbox['last']))->fetchCol(); + update_add_uuids($sandbox, 'block_custom', 'bid', $bids); + + $sandbox['#finished'] = empty($sandbox['max']) ? 1 : ($sandbox['progress'] / $sandbox['max']); +} + +/** + * Migrate {block_custom}.body and {block_custom}.format to block_body field. + */ +function block_update_8009() { + $sandbox['#finished'] = 0; + + if (!isset($sandbox['total'])) { + // Initial invocation. + + // First, create the body field. + $body_field = array( + 'field_name' => 'block_body', + 'type' => 'text_with_summary', + 'entity_types' => array('custom_block'), + 'module' => 'text', + 'cardinality' => 1, + ); + _update_7000_field_create_field($body_field); + + $instance = array( + 'field_name' => 'block_body', + 'entity_type' => 'custom_block', + 'bundle' => 'basic', + 'label' => 'Block body', + 'widget' => array('type' => 'text_textarea_with_summary'), + 'settings' => array('display_summary' => FALSE), + ); + _update_7000_field_create_instance($body_field, $instance); + + // Used below when updating the stored text format of each body. + $sandbox['existing_text_formats'] = db_query("SELECT format FROM {filter_format}")->fetchCol(); + + // Initialize state for future calls. + $sandbox['last'] = 0; + $sandbox['count'] = 0; + + $query = db_select('block_custom', 'bc'); + $sandbox['total'] = $query->countQuery()->execute()->fetchField(); + + $sandbox['body_field_id'] = $body_field['id']; + } + else { + // Subsequent invocations. + + $found = FALSE; + if ($sandbox['total']) { + // Operate on each block in turn. + $batch_size = 200; + $query = db_select('block_custom', 'bc'); + $query + ->fields('bc', array('bid', 'vid', 'body', 'format')) + ->condition('bc.bid', $sandbox['last'], '>') + ->orderBy('bc.bid', 'ASC') + ->range(0, $batch_size); + $blocks = $query->execute(); + + // Load the block, set up 'body' and save the field data. + foreach ($blocks as $block) { + $found = TRUE; + + $data = array( + LANGUAGE_NOT_SPECIFIED => array( + array( + 'format' => $block->format, + 'value' => $block->body + ) + ) + ); + // This is a core update and no contrib modules are enabled yet, so + // we can assume default field storage for a faster update. + _update_7000_field_sql_storage_write('custom_block', 'basic', $block->nid, $block->vid, 'block_body', $data); + + $sandbox['last'] = $block->bid; + $sandbox['count'] += 1; + } + + $sandbox['#finished'] = min(0.99, $sandbox['count'] / $sandbox['total']); + } + + if (!$found) { + // All blocks are processed. + + // Remove the now-obsolete body info from block_custom. + db_drop_field('block_custom', 'body'); + db_drop_field('block_custom', 'format'); + + // We're done. + $sandbox['#finished'] = 1; + } + } +} + +/** * @} End of "addtogroup updates-7.x-to-8.x". * The next series of updates should start at 9000. */ diff --git a/core/modules/block/custom_block/config/custom_block.type.basic.yml b/core/modules/block/custom_block/config/custom_block.type.basic.yml new file mode 100644 index 0000000..e2bb99e --- /dev/null +++ b/core/modules/block/custom_block/config/custom_block.type.basic.yml @@ -0,0 +1,3 @@ +id: basic +label: Basic block +revision: '0' diff --git a/core/modules/block/custom_block/custom_block.admin.inc b/core/modules/block/custom_block/custom_block.admin.inc new file mode 100644 index 0000000..4fb5906 --- /dev/null +++ b/core/modules/block/custom_block/custom_block.admin.inc @@ -0,0 +1,101 @@ +render(); +} + +/** + * Page callback: Presents the custom block type creation form. + * + * @return array + * A form array as expected by drupal_render(). + * + * @see custom_block_menu() + */ +function custom_block_type_add() { + drupal_set_title(t('Add custom block type')); + $block_type = entity_create('custom_block_type', array()); + return entity_get_form($block_type); +} + +/** + * Page callback: Presents the custom block type edit form. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlockType $block_type + * The custom block type to edit. + * + * @return array + * A form array as expected by drupal_render(). + * + * @see custom_block_menu() + */ +function custom_block_type_edit(CustomBlockType $block_type) { + drupal_set_title(t('Edit %label custom block type', array('%label' => $block_type->label())), PASS_THROUGH); + return entity_get_form($block_type); +} + +/** + * Page callback: Form constructor for the custom block type deletion form. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlockType $block_type + * The custom block type to be deleted. + * + * @see custom_block_menu() + * @see custom_block_type_delete_form_submit() + * + * @ingroup forms + */ +function custom_block_type_delete_form($form, &$form_state, CustomBlockType $block_type) { + $form_state['custom_block_type'] = $block_type; + $form['id'] = array( + '#type' => 'value', + '#value' => $block_type->id(), + ); + + $message = t('Are you sure you want to delete %label?', array('%label' => $block_type->label())); + + $blocks = entity_query('custom_block')->condition('type', $block_type->id())->execute(); + if (!empty($blocks)) { + drupal_set_title($message, PASS_THROUGH); + $caption = '

' . format_plural(count($blocks), '%label is used by 1 custom block on your site. You can not remove this block type until you have removed all of the %label blocks.', '%label is used by @count custom blocks on your site. You may not remove %label until you have removed all of the %label custom blocks.', array('%label' => $block_type->label())) . '

'; + $form['description'] = array('#markup' => $caption); + return $form; + } + + return confirm_form( + $form, + $message, + 'admin/structure/custom-blocks', + t('This action cannot be undone.'), + t('Delete') + ); +} + +/** + * Form submission handler for custom_block_type_delete_form(). + */ +function custom_block_type_delete_form_submit($form, &$form_state) { + $block_type = $form_state['custom_block_type']; + $block_type->delete(); + + drupal_set_message(t('Custom block type %label has been deleted.', array('%label' => $block_type->label()))); + watchdog('custom_block', 'Custom block type %label has been deleted.', array('%label' => $block_type->label()), WATCHDOG_NOTICE); + + $form_state['redirect'] = 'admin/structure/custom-blocks'; +} diff --git a/core/modules/block/custom_block/custom_block.info b/core/modules/block/custom_block/custom_block.info index 3dafb61..8d50a2f 100644 --- a/core/modules/block/custom_block/custom_block.info +++ b/core/modules/block/custom_block/custom_block.info @@ -4,3 +4,4 @@ package = Core version = VERSION core = 8.x dependencies[] = block +dependencies[] = text diff --git a/core/modules/block/custom_block/custom_block.install b/core/modules/block/custom_block/custom_block.install index 4a0e4b0..6345b7f 100644 --- a/core/modules/block/custom_block/custom_block.install +++ b/core/modules/block/custom_block/custom_block.install @@ -19,12 +19,11 @@ function custom_block_schema() { 'not null' => TRUE, 'description' => "The block's {block}.bid.", ), - 'body' => array( - 'type' => 'text', + 'uuid' => array( + 'description' => 'Unique Key: Universally unique identifier for this entity.', + 'type' => 'varchar', + 'length' => 128, 'not null' => FALSE, - 'size' => 'big', - 'description' => 'Block contents.', - 'translatable' => TRUE, ), 'info' => array( 'type' => 'varchar', @@ -33,17 +32,83 @@ function custom_block_schema() { 'default' => '', 'description' => 'Block description.', ), - 'format' => array( + 'machine_name' => array( 'type' => 'varchar', - 'length' => 255, + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => 'Machine name of block.', + ), + // Defaults to NULL in order to avoid a brief period of potential + // deadlocks on the index. + 'vid' => array( + 'description' => 'The current {block_custom_revision}.vid version identifier.', + 'type' => 'int', + 'unsigned' => TRUE, 'not null' => FALSE, - 'description' => 'The {filter_format}.format of the block body.', + 'default' => NULL, + ), + 'type' => array( + 'description' => 'The type of this custom block.', + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + ), + 'langcode' => array( + 'description' => 'The {language}.langcode of this node.', + 'type' => 'varchar', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', ), ), + 'indexes' => array( + 'block_custom_type' => array(array('type', 4)), + ), 'unique keys' => array( + 'vid' => array('vid'), + 'uuid' => array('uuid'), 'info' => array('info'), ), + 'foreign keys' => array( + 'block_custom_revision' => array( + 'table' => 'block_custom_revision', + 'columns' => array('vid' => 'vid'), + ), + ), 'primary key' => array('bid'), ); + + $schema['block_custom_revision'] = array( + 'description' => 'Stores contents of custom-made blocks.', + 'fields' => array( + 'bid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => "The block's {block}.bid.", + ), + // Defaults to NULL in order to avoid a brief period of potential + // deadlocks on the index. + 'vid' => array( + 'description' => 'The current version identifier.', + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + ), + 'log' => array( + 'description' => 'The log entry explaining the changes in this version.', + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + ), + ), + 'unique keys' => array( + 'vid' => array('vid'), + ), + 'primary key' => array('vid'), + ); return $schema; } diff --git a/core/modules/block/custom_block/custom_block.js b/core/modules/block/custom_block/custom_block.js new file mode 100644 index 0000000..fb0905a --- /dev/null +++ b/core/modules/block/custom_block/custom_block.js @@ -0,0 +1,46 @@ +/** + * @file + * Defines Javascript behaviors for the custom_block module. + */ + +(function ($) { + +"use strict"; + +Drupal.behaviors.customBlockDetailsSummaries = { + attach: function (context) { + var $context = $(context); + $context.find('.custom-block-form-revision-information').drupalSetSummary(function (context) { + var $context = $(context); + var revisionCheckbox = $context.find('.form-item-revision input'); + + // Return 'New revision' if the 'Create new revision' checkbox is checked, + // or if the checkbox doesn't exist, but the revision log does. For users + // without the "Administer content" permission the checkbox won't appear, + // but the revision log will if the content type is set to auto-revision. + if (revisionCheckbox.is(':checked') || (!revisionCheckbox.length && $context.find('.form-item-log textarea').length)) { + return Drupal.t('New revision'); + } + + return Drupal.t('No revision'); + }); + + $context.find('fieldset.custom-block-translation-options').drupalSetSummary(function (context) { + var $context = $(context); + var translate; + var $checkbox = $context.find('.form-item-translation-translate input'); + + if ($checkbox.size()) { + translate = $checkbox.is(':checked') ? Drupal.t('Needs to be updated') : Drupal.t('Does not need to be updated'); + } + else { + $checkbox = $context.find('.form-item-translation-retranslate input'); + translate = $checkbox.is(':checked') ? Drupal.t('Flag other translations as outdated') : Drupal.t('Do not flag other translations as outdated'); + } + + return translate; + }); + } +}; + +})(jQuery); diff --git a/core/modules/block/custom_block/custom_block.module b/core/modules/block/custom_block/custom_block.module index d3e1588..bee1d7b 100644 --- a/core/modules/block/custom_block/custom_block.module +++ b/core/modules/block/custom_block/custom_block.module @@ -5,6 +5,9 @@ * Allows the creaation of custom blocks through the user interface. */ +use Drupal\custom_block\Plugin\Core\Entity\CustomBlockType; +use Drupal\custom_block\Plugin\Core\Entity\CustomBlock; + /** * Implements hook_menu(). */ @@ -19,19 +22,121 @@ function custom_block_menu() { $items['admin/structure/block/list/' . $plugin_id . '/add/custom_blocks'] = array( 'title' => 'Add custom block', 'description' => 'Create a block with custom content and settings.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('block_admin_configure', 'custom_block:custom_block', $theme), - 'access callback' => TRUE, + 'page callback' => 'drupal_goto', + 'page arguments' => array( + 'block/add', + array('query' => array('theme' => $theme)) + ), + 'access arguments' => array('administer blocks'), 'type' => MENU_LOCAL_ACTION, - 'file' => 'block.admin.inc', - 'file path' => drupal_get_path('module', 'block'), ); } } + + $items['admin/structure/custom-blocks'] = array( + 'title' => 'Block types', + 'description' => 'Manage custom block types.', + 'page callback' => 'custom_block_type_list', + 'access arguments' => array('administer blocks'), + 'file' => 'custom_block.admin.inc', + ); + $items['admin/structure/custom-blocks/add'] = array( + 'title' => 'Add custom block type', + 'page callback' => 'custom_block_type_add', + 'access arguments' => array('administer blocks'), + 'type' => MENU_LOCAL_ACTION, + 'weight' => 1, + 'file' => 'custom_block.admin.inc', + ); + $items['admin/structure/custom-blocks/manage/%custom_block_type'] = array( + 'title' => 'Edit custom block type', + 'title callback' => 'entity_page_label', + 'title arguments' => array(4), + 'page callback' => 'custom_block_type_edit', + 'page arguments' => array(4), + 'access arguments' => array('administer blocks'), + 'file' => 'custom_block.admin.inc', + ); + $items['admin/structure/custom-blocks/manage/%custom_block_type/edit'] = array( + 'title' => 'Edit', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items['admin/structure/custom-blocks/manage/%custom_block_type/delete'] = array( + 'title' => 'Delete', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('custom_block_type_delete_form', 4), + 'access arguments' => array('administer blocks'), + 'type' => MENU_LOCAL_TASK, + 'weight' => 10, + 'file' => 'custom_block.admin.inc', + ); + + $items['block/add'] = array( + 'title' => 'Add custom block', + 'page callback' => 'custom_block_add_page', + 'access arguments' => array('administer blocks'), + 'file' => 'custom_block.pages.inc', + ); + + $items['block/add/%custom_block_type'] = array( + 'title callback' => 'entity_page_label', + 'title arguments' => array(2), + 'page callback' => 'custom_block_add', + 'page arguments' => array(2), + 'access arguments' => array('administer blocks'), + 'description' => 'Add custom block', + 'file' => 'custom_block.pages.inc', + ); + $items['block/%custom_block_machine_name'] = array( + 'title callback' => 'entity_page_label', + 'title arguments' => array(1), + 'page callback' => 'custom_block_page_view', + 'page arguments' => array(1), + 'access arguments' => array('view custom blocks'), + 'file' => 'custom_block.pages.inc', + ); + $items['block/%custom_block_machine_name/view'] = array( + 'title' => 'View', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items['block/%custom_block_machine_name/edit'] = array( + 'title' => 'Edit', + 'page callback' => 'custom_block_edit', + 'page arguments' => array(1), + 'access arguments' => array('administer blocks'), + 'weight' => 0, + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE, + 'file' => 'custom_block.pages.inc', + ); + $items['block/%custom_block_machine_name/delete'] = array( + 'title' => 'Delete', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('custom_block_delete_form', 1), + 'access arguments' => array('administer blocks'), + 'weight' => 1, + 'type' => MENU_LOCAL_TASK, + 'context' => MENU_CONTEXT_INLINE, + 'file' => 'custom_block.pages.inc', + ); return $items; } /** + * Implements hook_permission(). + */ +function custom_block_permission() { + return array( + 'view custom blocks' => array( + 'title' => t('View custom blocks on a page'), + 'description' => t('View custom blocks on a page of their own.') + ) + ); +} + +/** * Implements hook_theme(). */ function custom_block_theme($existing, $type, $theme, $path) { @@ -53,3 +158,160 @@ function theme_custom_block_block($variables) { return check_markup($body, $format); } + +/** + * Loads a custom block type. + * + * @param int $id + * The ID of the custom block type to load. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlockType|false + * A CustomBlockType object or FALSE if the requested $id does not exist. + */ +function custom_block_type_load($id) { + return entity_load('custom_block_type', $id); +} + +/** + * Loads a custom block. + * + * @param int $bid + * The bid of the custom block. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlock|false + * A CustomBlock object or FALSE if the requested $id does not exist. + */ +function custom_block_load($bid) { + return entity_load('custom_block', $bid); +} + +/** + * Loads a custom block. + * + * @param string $machine_name + * The machine name of the custom block. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlock|false + * A CustomBlock object or FALSE if the requested $id does not exist. + */ +function custom_block_machine_name_load($machine_name) { + $block_ids = entity_query('custom_block')->condition('machine_name', $machine_name)->execute(); + if (!empty($block_ids) && ($block_id = reset($block_ids))) { + return entity_load('custom_block', $block_id); + } + return FALSE; +} + +/** + * Entity URI callback. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlockType $block_type + * A custom block type entity. + * + * @return array + * An array with 'path' as the key and the path to the custom block type as + * the value. + */ +function custom_block_type_uri(CustomBlockType $block_type) { + return array( + 'path' => 'admin/structure/custom-blocks/manage/' . $block_type->id(), + ); +} + +/** + * Implements hook_entity_info(). + */ +function custom_block_entity_info(&$types) { + // Add a translation handler for fields if the language module is enabled. + if (module_exists('language')) { + $types['custom_block']['translation']['custom_block'] = TRUE; + } + foreach (config_get_storage_names_with_prefix('custom_block.type.') as $config_name) { + $config = config($config_name); + $types['custom_block']['bundles'][$config->get('id')] = array( + 'label' => $config->get('label'), + 'admin' => array( + 'path' => 'admin/structure/custom-blocks/manage/%', + 'real path' => 'admin/structure/custom-blocks/manage/' . $config->get('id'), + 'bundle argument' => 4, + 'access arguments' => array('administer blocks'), + ), + ); + } +} + +/** + * Adds the default body field to a custom block type. + * + * @param string $block_type_id + * Id of the block type. + * @param string $label + * (optional) The label for the body instance. Defaults to 'Block body' + * + * @return array() + * Body field instance. + */ +function custom_block_add_body_field($block_type_id, $label = 'Block body') { + // Add or remove the body field, as needed. + $field = field_info_field('block_body'); + $instance = field_info_instance('custom_block', 'block_body', $block_type_id); + if (empty($field)) { + $field = array( + 'field_name' => 'block_body', + 'type' => 'text_with_summary', + 'entity_types' => array('custom_block'), + ); + $field = field_create_field($field); + } + if (empty($instance)) { + $instance = array( + 'field_name' => 'block_body', + 'entity_type' => 'custom_block', + 'bundle' => $block_type_id, + 'label' => $label, + 'widget' => array('type' => 'text_textarea_with_summary'), + 'settings' => array('display_summary' => FALSE), + ); + $instance = field_create_instance($instance); + + // Assign display settings for 'default' view mode. + entity_get_display('custom_block', $block_type_id, 'default') + ->setComponent('block_body', array( + 'label' => 'hidden', + 'type' => 'text_default', + )) + ->save(); + } + + return $instance; +} + +/** + * Implements hook_form_FORM_ID_alter() for block_plugin_ui(). + */ +function custom_block_form_block_plugin_ui_alter(&$form, $form_state) { + foreach ($form['left']['plugin_library']['#rows'] as $plugin_id => &$row) { + @list($base, $derivative) = explode(':', $plugin_id); + if ($base !== 'custom_block') { + continue; + } + $row['1']['data']['#links']['edit'] = array( + 'title' => t('Edit'), + 'href' => 'block/' . $derivative . '/edit' + ); + } +} + +/** + * Implements hook_admin_paths(). + */ +function custom_block_admin_paths() { + $paths = array( + 'block/add' => TRUE, + 'block/add/*' => TRUE, + 'block/*/edit' => TRUE, + 'block/*/delete' => TRUE, + 'admin/structure/custom-blocks/*' => TRUE, + ); + return $paths; +} diff --git a/core/modules/block/custom_block/custom_block.pages.inc b/core/modules/block/custom_block/custom_block.pages.inc new file mode 100644 index 0000000..45651ec --- /dev/null +++ b/core/modules/block/custom_block/custom_block.pages.inc @@ -0,0 +1,164 @@ +label()); + $uri = $block->uri(); + // Set the block path as the canonical URL to prevent duplicate content. + drupal_add_html_head_link(array('rel' => 'canonical', 'href' => url($uri['path'])), TRUE); + // Set the non-aliased path as a default shortlink. + drupal_add_html_head_link(array('rel' => 'shortlink', 'href' => url($uri['path'], array('alias' => TRUE))), TRUE); + return entity_view($block, 'full'); +} + + +/** + * Page callback: Displays add custom block links for available types. + * + * Redirects to block/add/[type] if only one custom block type is available. + * + * @return array + * A render array for a list of the custom block types that can be added; + * however, if there is only one custom block type defined for the site, the + * function redirects to the custom block add page for that one custom block + * type and does not return at all. + * + * @see custom_block_menu() + */ +function custom_block_add_page() { + drupal_set_title(t('Add custom block')); + $options = array(); + if (isset($_GET['theme']) && in_array($_GET['theme'], array_keys(list_themes()))) { + // We have navigated to this page from the block library and will keep track + // of the theme for redirecting the user to the configuration page for the + // newly created block in the given theme. + $options = array( + 'query' => array('theme' => $_GET['theme']) + ); + } + $types = config_get_storage_names_with_prefix('custom_block.type.'); + if (count($types) == 1) { + $config = config(reset($types)); + drupal_goto('block/add/' . $config->get('id'), $options); + } + // Multiple custom block types exist, present a list of links. + $links = array(); + + foreach ($types as $config_name) { + $config = config($config_name); + $links[] = l($config->get('label'), 'block/add/' . $config->get('id'), $options); + } + return array( + '#theme' => array( + 'item_list', + 'item_list__custom_block_add' + ), + '#items' => $links, + '#title' => t('Choose a block type to continue.') + ); +} + +/** + * Page callback: Presents the custom block creation form. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlockType $block_type + * The custom block type to add. + * + * @return array + * A form array as expected by drupal_render(). + * + * @see custom_block_menu() + */ +function custom_block_add(CustomBlockType $block_type) { + drupal_set_title(t('Add %type custom block', array( + '%type' => $block_type->label() + )), PASS_THROUGH); + $block = entity_create('custom_block', array( + 'type' => $block_type->id() + )); + $options = array(); + if (isset($_GET['theme']) && in_array($_GET['theme'], array_keys(list_themes()))) { + // We have navigated to this page from the block library and will keep track + // of the theme for redirecting the user to the configuration page for the + // newly created block in the given theme. + $block->setTheme($_GET['theme']); + } + return entity_get_form($block); +} + +/** + * Page callback: Presents the custom block edit form. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlock $block + * The custom block to edit. + * + * @return array + * A form array as expected by drupal_render(). + * + * @see custom_block_menu() + */ +function custom_block_edit(CustomBlock $block) { + drupal_set_title(t('Edit custom block %label', array('%label' => $block->label())), PASS_THROUGH); + return entity_get_form($block); +} + +/** + * Page callback: Form constructor for the custom block deletion form. + * + * @param Drupal\custom_block\Plugin\Core\Entity\CustomBlock $block + * The custom block to be deleted. + * + * @see custom_block_menu() + * @see custom_block_delete_form_submit() + * + * @ingroup forms + */ +function custom_block_delete_form($form, &$form_state, CustomBlock $block) { + $form_state['custom_block'] = $block; + $form['id'] = array( + '#type' => 'value', + '#value' => $block->id(), + ); + + return confirm_form( + $form, + t('Are you sure you want to delete %label?', array('%label' => $block->label())), + 'admin/structure/block', + t('This action cannot be undone.'), + t('Delete') + ); +} + +/** + * Form submission handler for custom_block_delete_form(). + */ +function custom_block_delete_form_submit($form, &$form_state) { + // @todo Delete all configured instances of the block. + $block = $form_state['custom_block']; + $block->delete(); + + drupal_set_message(t('Custom block %label has been deleted.', array('%label' => $block->label()))); + watchdog('custom_block', 'Custom block %label has been deleted.', array('%label' => $block->label()), WATCHDOG_NOTICE); + + $form_state['redirect'] = 'admin/structure/block'; +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockFormController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockFormController.php new file mode 100644 index 0000000..a1aa4ae --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockFormController.php @@ -0,0 +1,226 @@ +type->value); + // If this is a new custom block, fill in the default values. + if (isset($block->bid->value)) { + $block->set('log', NULL); + } + // Always use the default revision setting. + $block->setNewRevision($block_type->revision); + + module_invoke_all('custom_block_prepare', $block); + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::form(). + */ + public function form(array $form, array &$form_state, EntityInterface $block) { + + // Override the default CSS class name, since the user-defined custom block + // type name in 'TYPE-block-form' potentially clashes with third-party class + // names. + $form['#attributes']['class'][0] = drupal_html_class('block-' . $block->type->value . '-form'); + + // Basic block information. + // These elements are just values so they are not even sent to the client. + foreach (array('bid', 'vid') as $key) { + $form[$key] = array( + '#type' => 'value', + '#value' => $block->$key->value, + ); + } + + $form['info'] = array( + '#type' => 'textfield', + '#title' => t('Block description'), + '#required' => TRUE, + '#default_value' => $block->info->value, + '#weight' => -5, + '#description' => t('A brief description of your block. Used on the Blocks administration page.', array('@overview' => url('admin/structure/block'))), + ); + + $form['machine_name'] = array( + '#type' => 'machine_name', + '#default_value' => $block->machine_name->value, + '#machine_name' => array( + 'exists' => 'custom_block_load', + 'source' => array('info') + ), + '#weight' => -4, + '#disabled' => !$block->isNew(), + ); + + $language_configuration = module_invoke('language', 'get_default_configuration', 'custom_block', $block->type->value); + $form['langcode'] = array( + '#title' => t('Language'), + '#type' => 'language_select', + '#default_value' => $block->langcode->value, + '#languages' => LANGUAGE_ALL, + '#access' => isset($language_configuration['language_hidden']) && !$language_configuration['language_hidden'], + ); + + $form['additional_settings'] = array( + '#type' => 'vertical_tabs', + '#weight' => 99, + ); + + // Add a log field if the "Create new revision" option is checked, or if the + // current user has the ability to check that option. + $form['revision_information'] = array( + '#type' => 'details', + '#title' => t('Revision information'), + '#collapsible' => TRUE, + // Collapsed by default when "Create new revision" is unchecked. + '#collapsed' => !$block->isNewRevision(), + '#group' => 'additional_settings', + '#attributes' => array( + 'class' => array('custom-block-form-revision-information'), + ), + '#attached' => array( + 'js' => array(drupal_get_path('module', 'custom_block') . '/custom_block.js'), + ), + '#weight' => 20, + '#access' => $block->isNewRevision() || user_access('administer blocks'), + ); + + $form['revision_information']['revision'] = array( + '#type' => 'checkbox', + '#title' => t('Create new revision'), + '#default_value' => $block->isNewRevision(), + '#access' => user_access('administer blocks'), + ); + + // Check the revision log checkbox when the log textarea is filled in. + // This must not happen if "Create new revision" is enabled by default, + // since the state would auto-disable the checkbox otherwise. + if (!$block->isNewRevision()) { + $form['revision_information']['revision']['#states'] = array( + 'checked' => array( + 'textarea[name="log"]' => array('empty' => FALSE), + ), + ); + } + + $form['revision_information']['log'] = array( + '#type' => 'textarea', + '#title' => t('Revision log message'), + '#rows' => 4, + '#default_value' => !empty($block->log->value) ? $block->log->value : '', + '#description' => t('Briefly describe the changes you have made.'), + ); + + return parent::form($form, $form_state, $block); + } + + /** + * Updates the custom block object by processing the submitted values. + * + * This function can be called by a "Next" button of a wizard to update the + * form state's entity with the current step's values before proceeding to the + * next step. + * + * Overrides Drupal\Core\Entity\EntityFormController::submit(). + */ + public function submit(array $form, array &$form_state) { + // Build the block object from the submitted values. + $block = parent::submit($form, $form_state); + + // Save as a new revision if requested to do so. + if (!empty($form_state['values']['revision'])) { + $block->setNewRevision(); + } + + foreach (module_implements('custom_block_submit') as $module) { + $function = $module . '_custom_block_submit'; + $function($block, $form, $form_state); + } + + return $block; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::save(). + */ + public function save(array $form, array &$form_state) { + $block = $this->getEntity($form_state); + $insert = empty($block->bid->value); + $block->save(); + $watchdog_args = array('@type' => $block->bundle(), '%info' => $block->label()); + $block_type = entity_load('custom_block_type', $block->type->value); + $t_args = array('@type' => $block_type->label(), '%info' => $block->label()); + + if ($insert) { + watchdog('content', '@type: added %info.', $watchdog_args, WATCHDOG_NOTICE); + drupal_set_message(t('@type %info has been created.', $t_args)); + } + else { + watchdog('content', '@type: updated %info.', $watchdog_args, WATCHDOG_NOTICE); + drupal_set_message(t('@type %info has been updated.', $t_args)); + } + + if ($block->bid->value) { + $form_state['values']['bid'] = $block->bid->value; + $form_state['bid'] = $block->bid->value; + if ($insert) { + if ($theme = $block->getTheme()) { + $form_state['redirect'] = 'admin/structure/block/manage/custom_block:' . $block->machine_name->value . '/' . $theme; + } + else { + $form_state['redirect'] = 'admin/structure/block/manage/custom_block:' . $block->machine_name->value . '/' . variable_get('theme_default', 'stark'); + } + } + else { + $form_state['redirect'] = 'admin/structure/block'; + } + } + else { + // In the unlikely case something went wrong on save, the block will be + // rebuilt and block form redisplayed. + drupal_set_message(t('The block could not be saved.'), 'error'); + $form_state['rebuild'] = TRUE; + } + + // Clear the page and block caches. + cache_invalidate_tags(array('content' => TRUE)); + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::delete(). + */ + public function delete(array $form, array &$form_state) { + $destination = array(); + if (isset($_GET['destination'])) { + $destination = drupal_get_destination(); + unset($_GET['destination']); + } + $block = $this->buildEntity($form, $form_state); + $form_state['redirect'] = array('block/' . $block->machine_name->value . '/delete', array('query' => $destination)); + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockRenderController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockRenderController.php new file mode 100644 index 0000000..422981c --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockRenderController.php @@ -0,0 +1,30 @@ +bid->value) && $view_mode == 'full') { + $build['#contextual_links']['custom_block'] = array('block', array($entity->machine_name->value)); + } + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockStorageController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockStorageController.php new file mode 100644 index 0000000..963bd3f --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockStorageController.php @@ -0,0 +1,126 @@ +isNewRevision()) { + // When inserting either a new custom block or a new custom_block + // revision, $entity->log must be set because {block_custom_revision}.log + // is a text column and therefore cannot have a default value. However, + // it might not be set at this point (for example, if the user submitting + // the form does not have permission to create revisions), so we ensure + // that it is at least an empty string in that case. + // @todo: Make the {block_custom_revision}.log column nullable so that we + // can remove this check. + if (!isset($record->log)) { + $record->log = ''; + } + } + elseif (!isset($record->log) || $record->log === '') { + // If we are updating an existing custom_block without adding a new + // revision, we need to make sure $entity->log is unset whenever it is + // empty. As long as $entity->log is unset, drupal_write_record() will not + // attempt to update the existing database column when re-saving the + // revision; therefore, this code allows us to avoid clobbering an + // existing log entry with an empty one. + unset($record->log); + } + + } + + /** + * Overrides Drupal\Core\Entity\DatabaseStorageController::attachLoad(). + */ + protected function attachLoad(&$blocks, $load_revision = FALSE) { + // Create an array of block types for passing as a load argument. + // Note that blocks at this point are still \StdClass objects returned from + // the database. + foreach ($blocks as $id => $entity) { + $types[$entity->type] = $entity->type; + } + + // Besides the list of blocks, pass one additional argument to + // hook_custom_block_load(), containing a list of block types that were + // loaded. + $this->hookLoadArguments = array($types); + parent::attachLoad($blocks, $load_revision); + } + + /** + * Overrides Drupal\Core\Entity\DatabaseStorageController::postSave(). + */ + function postSave(EntityInterface $block, $update) { + // Invalidate the block cache to update custom block-based derivatives. + if (module_exists('block')) { + drupal_container()->get('plugin.manager.block')->clearCachedDefinitions(); + } + } + + /** + * Implements \Drupal\Core\Entity\DataBaseStorageControllerNG::basePropertyDefinitions(). + */ + public function baseFieldDefinitions() { + $properties['bid'] = array( + 'label' => t('ID'), + 'description' => t('The custom block ID.'), + 'type' => 'integer_field', + 'read-only' => TRUE, + ); + $properties['uuid'] = array( + 'label' => t('UUID'), + 'description' => t('The custom block UUID.'), + 'type' => 'string_field', + ); + $properties['vid'] = array( + 'label' => t('Revision ID'), + 'description' => t('The revision ID.'), + 'type' => 'integer_field', + ); + $properties['langcode'] = array( + 'label' => t('Language code'), + 'description' => t('The comment language code.'), + 'type' => 'language_field', + ); + $properties['info'] = array( + 'label' => t('Subject'), + 'description' => t('The custom block name.'), + 'type' => 'string_field', + ); + $properties['machine_name'] = array( + 'label' => t('Machine name'), + 'description' => t('The custom block machine name.'), + 'type' => 'string_field', + ); + $properties['type'] = array( + 'label' => t('Block type'), + 'description' => t("The block type."), + 'type' => 'string_field', + ); + $properties['log'] = array( + 'label' => t('Revision log message'), + 'description' => t("The revision log message."), + 'type' => 'string_field', + ); + return $properties; + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTranslationController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTranslationController.php new file mode 100644 index 0000000..860aef6 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTranslationController.php @@ -0,0 +1,59 @@ + 'additional_settings', + '#weight' => 100, + '#attributes' => array( + 'class' => array('custom-block-translation-options'), + ), + ); + } + } + + /** + * Overrides EntityTranslationController::entityFormTitle(). + */ + protected function entityFormTitle(EntityInterface $entity) { + $block_type = entity_load('custom_block_type', $entity->type->value); + return t('Edit @type @title', array('@type' => $block_type->label(), '@title' => $entity->label())); + } + + /** + * Overrides EntityTranslationController::entityFormTitle(). + * + * Custom Block menu paths are keyed by machine name, not id. + */ + protected function getPathInstance($path, $entity_id) { + $entity = entity_load('custom_block', $entity_id); + $wildcard = '%custom_block_machine_name'; + return str_replace($wildcard, $entity->machine_name->value, $path); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeFormController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeFormController.php new file mode 100644 index 0000000..75484f9 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeFormController.php @@ -0,0 +1,101 @@ + 'textfield', + '#title' => t('Label'), + '#maxlength' => 255, + '#default_value' => $block_type->label(), + '#description' => t("Provide a label for this block type to help identify it in the administration pages."), + '#required' => TRUE, + ); + $form['id'] = array( + '#type' => 'machine_name', + '#default_value' => $block_type->id(), + '#machine_name' => array( + 'exists' => 'custom_block_type_load', + ), + '#disabled' => !$block_type->isNew(), + ); + + $form['revision'] = array( + '#type' => 'checkbox', + '#title' => t('Create new revision'), + '#default_value' => $block_type->revision, + '#description' => t('Create a new revision by default for this block type.') + ); + + // @todo Remove this check once language settings are generalized. + if (module_exists('translation_entity')) { + $translation_form = $form; + $translation_form_state['translation_entity']['key'] = 'language_configuration'; + $form += translation_entity_enable_widget('custom_block', $block_type->id(), $translation_form, $translation_form_state); + } + + $form['actions'] = array('#type' => 'actions'); + $form['actions']['submit'] = array( + '#type' => 'submit', + '#value' => t('Save'), + ); + + return $form; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::save(). + */ + public function save(array $form, array &$form_state) { + $block_type = $this->getEntity($form_state); + $status = $block_type->save(); + + $uri = $block_type->uri(); + if ($status == SAVED_UPDATED) { + drupal_set_message(t('Custom block type %label has been updated.', array('%label' => $block_type->label()))); + watchdog('custom_block', 'Custom block type %label has been updated.', array('%label' => $block_type->label()), WATCHDOG_NOTICE, l(t('Edit'), $uri['path'] . '/edit')); + } + else { + drupal_set_message(t('Custom block type %label has been added.', array('%label' => $block_type->label()))); + watchdog('custom_block', 'Custom block type %label has been added.', array('%label' => $block_type->label()), WATCHDOG_NOTICE, l(t('Edit'), $uri['path'] . '/edit')); + } + + if (module_exists('translation_entity')) { + $key = 'language_configuration'; + $translation_form_state = array( + 'translation_entity' => array('key' => $key), + 'language' => array($key => array('entity_type' => 'custom_block', 'bundle' => $block_type->id())), + 'values' => array($key => array('translation_entity' => $form_state['values']['translation_entity'])), + ); + translation_entity_language_configuration_element_submit($form, $translation_form_state); + } + $form_state['redirect'] = 'admin/structure/custom-blocks'; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::delete(). + */ + public function delete(array $form, array &$form_state) { + $block_type = $this->getEntity($form_state); + $form_state['redirect'] = 'admin/structure/custom-blocks/manage/' . $block_type->id() . '/delete'; + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeListController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeListController.php new file mode 100644 index 0000000..a59799e --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeListController.php @@ -0,0 +1,58 @@ +uri(); + $operations['manage-fields'] = array( + 'title' => t('Manage fields'), + 'href' => $uri['path'] . '/fields', + 'options' => $uri['options'], + 'weight' => 11, + ); + $operations['manage-display'] = array( + 'title' => t('Manage display'), + 'href' => $uri['path'] . '/display', + 'options' => $uri['options'], + 'weight' => 12, + ); + } + return $operations; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::buildHeader(). + */ + public function buildHeader() { + $row['type'] = t('Block type'); + $row['operations'] = t('Operations'); + return $row; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::buildRow(). + */ + public function buildRow(EntityInterface $entity) { + $row['type'] = check_plain($entity->label()); + $row['operations']['data'] = $this->buildOperations($entity); + return $row; + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeStorageController.php b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeStorageController.php new file mode 100644 index 0000000..d9600c6 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/CustomBlockTypeStorageController.php @@ -0,0 +1,44 @@ +id()); + custom_block_add_body_field($entity->id()); + } + elseif ($entity->original->id() != $entity->id()) { + field_attach_rename_bundle('custom_block', $entity->original->id(), $entity->id()); + } + } + + /** + * Overrides \Drupal\Core\Config\Entity\ConfigStorageController::postDelete(). + */ + protected function postDelete($entities) { + parent::postDelete($entities); + + foreach ($entities as $entity) { + field_attach_delete_bundle('custom_block', $entity->id()); + } + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlock.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlock.php new file mode 100644 index 0000000..8befb87 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlock.php @@ -0,0 +1,224 @@ +bid->value; + } + + /** + * Implements Drupal\Core\Entity\EntityInterface::bundle(). + */ + public function bundle() { + return $this->type->value; + } + + /** + * Implements Drupal\Core\Entity\EntityInterface::label(). + */ + public function label($langcode = NULL) { + return $this->info->value; + } + + /** + * Overrides Drupal\Core\Entity\Entity::createDuplicate(). + */ + public function createDuplicate() { + $duplicate = parent::createDuplicate(); + $duplicate->set('vid', NULL); + $duplicate->set('bid', NULL); + $duplicate->set('machine_name', NULL); + return $duplicate; + } + + /** + * Overrides Drupal\Core\Entity\Entity::getRevisionId(). + */ + public function getRevisionId() { + return $this->vid->value; + } + + /** + * Sets the theme value. + * + * When creating a new custom block from the block library, the user is + * redirected to the configure form for that block in the given theme. The + * theme is stored against the block when the custom block add form is shown. + * + * @param string $theme + * The theme name. + */ + public function setTheme($theme) { + $this->theme = $theme; + } + + /** + * Gets the theme value. + * + * When creating a new custom block from the block library, the user is + * redirected to the configure form for that block in the given theme. The + * theme is stored against the block when the custom block add form is shown. + * + * @return string + * The theme name. + */ + public function getTheme() { + return $this->theme; + } + + /** + * The plain data values of the contained properties. + * + * Define default values. + * + * @var array + */ + protected $values = array(); + + /** + * Initialize the object. Invoked upon construction and wake up. + */ + protected function init() { + parent::init(); + // We unset all defined properties, so magic getters apply. + unset($this->bid); + unset($this->info); + unset($this->vid); + unset($this->log); + unset($this->machine_name); + unset($this->uuid); + unset($this->langcode); + unset($this->type); + unset($this->new); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlockType.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlockType.php new file mode 100644 index 0000000..fb6f2b5 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/Core/Entity/CustomBlockType.php @@ -0,0 +1,65 @@ +derivatives[$result->bid] = $base_plugin_definition; - $this->derivatives[$result->bid]['settings'] = array( - 'info' => $result->info, - 'body' => $result->body, - 'format' => $result->format, + $custom_blocks = entity_load_multiple('custom_block', entity_query('custom_block')->execute()); + foreach ($custom_blocks as $custom_block) { + $this->derivatives[$custom_block->machine_name->value] = $base_plugin_definition; + $this->derivatives[$custom_block->machine_name->value]['settings'] = array( + 'info' => $custom_block->info->value, ) + $base_plugin_definition['settings']; - $this->derivatives[$result->bid]['subject'] = $result->info; + $this->derivatives[$custom_block->machine_name->value]['subject'] = $custom_block->info->value; } - $this->derivatives['custom_block'] = $base_plugin_definition; return $this->derivatives; } } diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/block/block/CustomBlock.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/block/block/CustomBlock.php index 8b142ef..f472ff7 100644 --- a/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/block/block/CustomBlock.php +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Plugin/block/block/CustomBlock.php @@ -1,6 +1,6 @@ '', + 'view_mode' => 'full' ); } @@ -47,8 +47,7 @@ public function getConfig() { $this->configuration = parent::getConfig(); $this->configuration['status'] = $definition['settings']['status']; $this->configuration['info'] = $definition['settings']['info']; - $this->configuration['body'] = $definition['settings']['body']; - $this->configuration['format'] = $definition['settings']['format']; + $this->configuration['view_mode'] = $definition['settings']['view_mode']; return $this->configuration; } @@ -58,25 +57,17 @@ public function getConfig() { * Adds body and description fields to the block configuration form. */ public function blockForm($form, &$form_state) { - // @todo Disable this field when editing an existing block and provide a - // separate interface for administering custom blocks. - $form['custom_block']['info'] = array( - '#type' => 'textfield', - '#title' => t('Block description'), - '#required' => TRUE, - '#default_value' => $this->configuration['info'], - '#description' => t('A brief description of your block. Used on the Blocks administration page. Changing this field will change the description for all copies of this block.', array('@overview' => url('admin/structure/block'))), - ); - // @todo Disable this field when editing an existing block and provide a - // separate interface for administering custom blocks. - $form['custom_block']['body'] = array( - '#type' => 'text_format', - '#title' => t('Block body'), - '#default_value' => $this->configuration['body'], - '#format' => isset($this->configuration['format']) ? $this->configuration['format'] : filter_default_format(), - '#description' => t('The content of the block as shown to the user. Changing this field will change the block body everywhere it is used.'), - '#rows' => 15, - '#required' => TRUE, + $view_modes = array(); + $info = entity_get_info('custom_block'); + foreach ($info['view_modes'] as $view_mode => $detail) { + $view_modes[$view_mode] = $detail['label']; + } + $form['custom_block']['view_mode'] = array( + '#type' => 'select', + '#options' => $view_modes, + '#title' => t('View mode'), + '#description' => t('Output the block in this view mode.'), + '#default_value' => $this->configuration['view_mode'] ); $form['custom_block']['title']['#description'] = t('The title of the block as shown to the user.'); return $form; @@ -86,15 +77,6 @@ public function blockForm($form, &$form_state) { * Overrides \Drupal\block\BlockBase::blockSubmit(). */ public function blockSubmit($form, &$form_state) { - list(, $bid) = explode(':', $this->getPluginId()); - $block = array( - 'info' => $form_state['values']['info'], - 'body' => $form_state['values']['body']['value'], - 'format' => $form_state['values']['body']['format'], - 'bid' => is_numeric($bid) ? $bid : NULL, - ); - drupal_write_record('block_custom', $block, !is_null($block['bid']) ? array('bid') : array()); - $this->configuration['id'] = 'custom_block:' . $block['bid']; // Invalidate the block cache to update custom block-based derivatives. if (module_exists('block')) { drupal_container()->get('plugin.manager.block')->clearCachedDefinitions(); @@ -105,12 +87,19 @@ public function blockSubmit($form, &$form_state) { * Implements \Drupal\block\BlockBase::blockBuild(). */ public function blockBuild() { - // Populate the block with the user-defined block body. - return array( - '#theme' => 'custom_block_block', - '#body' => $this->configuration['body'], - '#format' => $this->configuration['format'], - ); + list(, $machine_name) = explode(':', $this->getPluginId()); + if ($block = custom_block_machine_name_load($machine_name)) { + return entity_view($block, $this->configuration['view_mode']); + } + else { + return array( + '#markup' => t('Block with name %name does not exist. Add custom block.', array( + '%name' => $block_id, + '!url' => url('block/add') + )), + '#access' => user_access('administer blocks') + ); + } } } diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php new file mode 100644 index 0000000..5ec715c --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php @@ -0,0 +1,38 @@ + 'Rebuild content', + 'description' => 'Test the rebuilding of content for full view modes.', + 'group' => 'Custom Block', + ); + } + + /** + * Ensures that content is rebuilt in calls to custom_block_build_content(). + */ + function testCustomBlockRebuildContent() { + $block = $this->createCustomBlock(); + + // Set a property in the content array so we can test for its existence later on. + $block->content['test_content_property'] = array( + '#value' => $this->randomString(), + ); + $content = entity_view_multiple(array($block), 'full'); + + // If the property doesn't exist it means the block->content was rebuilt. + $this->assertFalse(isset($content['test_content_property']), 'Custom block content was emptied prior to being built.'); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCreationTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCreationTest.php new file mode 100644 index 0000000..49e0b22 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCreationTest.php @@ -0,0 +1,100 @@ + 'Custom Block creation', + 'description' => 'Create a block and test saving it.', + 'group' => 'Custom Block', + ); + } + + function setUp() { + parent::setUp(); + $this->drupalLogin($this->admin_user); + } + + /** + * Creates a "Basic page" block and verifies its consistency in the database. + */ + function testCustomBlockCreation() { + // Create a block. + $edit = array(); + $langcode = LANGUAGE_NOT_SPECIFIED; + $edit['info'] = $this->randomName(8); + $edit['machine_name'] = drupal_strtolower($edit['info']); + $edit["block_body[$langcode][0][value]"] = $this->randomName(16); + $this->drupalPost('block/add/basic', $edit, t('Save')); + + // Check that the Basic block has been created. + $this->assertRaw(format_string('!block %name has been created.', array( + '!block' => 'Basic block', + '%name' => $edit["info"] + )), 'Basic block created.'); + + // Check that the block exists in the database. + $blocks = entity_load_multiple_by_properties('custom_block', array('info' => $edit['info'])); + $block = reset($blocks); + $this->assertTrue($block, 'Custom Block found in database.'); + } + + /** + * Verifies that a transaction rolls back the failed creation. + */ + function testFailedBlockCreation() { + // Create a block. + try { + $this->createCustomBlock('fail_creation'); + $this->fail('Expected exception has not been thrown.'); + } + catch (Exception $e) { + $this->pass('Expected exception has been thrown.'); + } + + if (Database::getConnection()->supportsTransactions()) { + // Check that the block does not exist in the database. + $bid = db_select('block_custom', 'b') + ->fields('b', array('bid')) + ->condition('info', 'fail_creation') + ->execute() + ->fetchField(); + $this->assertFalse($bid, 'Transactions supported, and block not found in database.'); + } + else { + // Check that the block exists in the database. + $bid = db_select('block_custom', 'b') + ->fields('b', array('bid')) + ->condition('info', 'fail_creation') + ->execute() + ->fetchField(); + $this->assertTrue($bid, 'Transactions not supported, and block found in database.'); + + // Check that the failed rollback was logged. + $records = db_query("SELECT wid FROM {watchdog} WHERE message LIKE 'Explicit rollback failed%'")->fetchAll(); + $this->assertTrue(count($records) > 0, 'Transactions not supported, and rollback error logged to watchdog.'); + } + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockLoadHooksTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockLoadHooksTest.php new file mode 100644 index 0000000..30b2203 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockLoadHooksTest.php @@ -0,0 +1,67 @@ + 'Custom Block load hooks', + 'description' => 'Test the hooks invoked when a custom block is being loaded.', + 'group' => 'Custom Block', + ); + } + + /** + * Tests that hook_custom_block_load() is invoked correctly. + */ + function testHookCustomBlockLoad() { + $other_bundle = $this->createCustomBlockType('other'); + // Create some sample articles and pages. + $custom_block1 = $this->createCustomBlock(); + $custom_block2 = $this->createCustomBlock(); + $custom_block3 = $this->createCustomBlock(); + $custom_block4 = $this->createCustomBlock(FALSE, $other_bundle->id()); + + // Check that when a set of custom blocks that only contains basic blocks is + // loaded, the properties added to the custom block by + // custom_block_test_load_custom_block() correctly reflect the expected + // values. + $custom_blocks = entity_load_multiple_by_properties('custom_block', array('type' => 'basic')); + $loaded_custom_block = end($custom_blocks); + $this->assertEqual($loaded_custom_block->custom_block_test_loaded_bids, array( + $custom_block1->bid->value, + $custom_block2->bid->value, + $custom_block3->bid->value + ), 'hook_custom_block_load() received the correct list of custom_block IDs the first time it was called.'); + $this->assertEqual($loaded_custom_block->custom_block_test_loaded_types, array('basic'), 'hook_custom_block_load() received the correct list of custom block types the first time it was called.'); + + // Now, as part of the same page request, load a set of custom_blocks that contain + // both basic and other bundle, and make sure the parameters passed to + // custom_block_test_custom_block_load() are correctly updated. + $custom_blocks = entity_load_multiple('custom_block', entity_query('custom_block')->execute(), TRUE); + $loaded_custom_block = end($custom_blocks); + $this->assertEqual($loaded_custom_block->custom_block_test_loaded_bids, array( + $custom_block1->bid->value, + $custom_block2->bid->value, + $custom_block3->bid->value, + $custom_block4->bid->value + ), 'hook_custom_block_load() received the correct list of custom_block IDs the second time it was called.'); + $this->assertEqual($loaded_custom_block->custom_block_test_loaded_types, array('basic', 'other'), 'hook_custom_block_load() received the correct list of custom_block types the second time it was called.'); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockRevisionsTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockRevisionsTest.php new file mode 100644 index 0000000..2497ff5 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockRevisionsTest.php @@ -0,0 +1,86 @@ + 'Custom Block revisions', + 'description' => 'Create a block with revisions.', + 'group' => 'Custom Block', + ); + } + + function setUp() { + parent::setUp(); + + // Create initial block. + $block = $this->createCustomBlock('initial'); + + $blocks = array(); + $logs = array(); + + // Get original block. + $blocks[] = $block->vid->value; + $logs[] = ''; + + // Create three revisions. + $revision_count = 3; + for ($i = 0; $i < $revision_count; $i++) { + $block->setNewRevision(TRUE); + $logs[] = $block->log->value = $this->randomName(32); + $block->save(); + $blocks[] = $block->vid->value; + } + + $this->blocks = $blocks; + $this->logs = $logs; + } + + /** + * Checks block revision related operations. + */ + function testRevisions() { + $blocks = $this->blocks; + $logs = $this->logs; + + foreach ($blocks as $delta => $vid) { + // Confirm the correct revision text appears. + $loaded = entity_revision_load('custom_block', $vid); + // Verify log is the same. + $this->assertEqual($loaded->log->value, $logs[$delta], format_string('Correct log message found for revision !revision', array( + '!revision' => $loaded->vid->value + ))); + } + + // Confirm that this is the default revision. + $this->assertTrue($loaded->isDefaultRevision(), 'Third block revision is the default one.'); + + // Make a new revision and set it to not be default. + // This will create a new revision that is not "front facing". + // Save this as a non-default revision. + $loaded->setNewRevision(); + $loaded->isDefaultRevision = FALSE; + $loaded->block_body = $this->randomName(8); + $loaded->save(); + + $this->drupalGet('block/' . $loaded->bid->value); + $this->assertNoText($loaded->block_body->value, 'Revision body text is not present on default version of block.'); + + // Verify that the non-default revision vid is greater than the default + // revision vid. + $default_revision = entity_load('custom_block', $loaded->bid->value); + $this->assertTrue($loaded->vid->value > $default_revision->vid->value, 'Revision vid is greater than default revision vid.'); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockSaveTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockSaveTest.php new file mode 100644 index 0000000..077294b --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockSaveTest.php @@ -0,0 +1,103 @@ + 'Custom Block save', + 'description' => 'Test $custom_block->save() for saving content.', + 'group' => 'Custom Block', + ); + } + + function setUp() { + parent::setUp(); + $this->drupalLogin($this->admin_user); + } + + /** + * Checks whether custom block IDs are saved properly during an import. + */ + function testImport() { + // Custom block ID must be a number that is not in the database. + $max_bid = db_query('SELECT MAX(bid) FROM {block_custom}')->fetchField(); + $test_bid = $max_bid + mt_rand(1000, 1000000); + $info = $this->randomName(8); + $block = array( + 'info' => $info, + 'machine_name' => $info, + 'block_body' => array(LANGUAGE_NOT_SPECIFIED => array(array('value' => $this->randomName(32)))), + 'type' => 'basic', + 'bid' => $test_bid + ); + $block = entity_create('custom_block', $block); + $block->enforceIsNew(TRUE); + $block->save(); + + // Verify that block_submit did not wipe the provided bid. + $this->assertEqual($block->bid->value, $test_bid, 'Block imported using provide bid'); + + // Test the import saved. + $block_by_bid = custom_block_load($test_bid); + $this->assertTrue($block_by_bid, 'Custom block load by block ID.'); + } + + /** + * Tests determing changes in hook_block_presave() and verifies the static + * block load cache is cleared upon save. + */ + function testDeterminingChanges() { + // Initial creation. + $block = $this->createCustomBlock('test_changes'); + + // Update the block without applying changes. + $block->save(); + $this->assertEqual($block->label(), 'test_changes', 'No changes have been determined.'); + + // Apply changes. + $block->info->value = 'updated'; + $block->save(); + + // The hook implementations custom_block_test_custom_block_presave() and + // custom_block_test_custom_block_update() determine changes and change the + // title. + $this->assertEqual($block->label(), 'updated_presave_update', 'Changes have been determined.'); + + // Test the static block load cache to be cleared. + $block = custom_block_load($block->bid->value); + $this->assertEqual($block->label(), 'updated_presave', 'Static cache has been cleared.'); + } + + /** + * Tests saving a block on block insert. + * + * This test ensures that a block has been fully saved when + * hook_custom_block_insert() is invoked, so that the block can be saved again + * in a hook implementation without errors. + * + * @see block_test_block_insert() + */ + function testCustomBlockSaveOnInsert() { + // custom_block_test_custom_block_insert() tiggers a save on insert if the + // title equals 'new'. + $block = $this->createCustomBlock('new'); + $this->assertEqual($block->label(), 'CustomBlock ' . $block->bid->value, 'Custom block saved on block insert.'); + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTestBase.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTestBase.php new file mode 100644 index 0000000..aa11305 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTestBase.php @@ -0,0 +1,92 @@ +admin_user = $this->drupalCreateUser($this->permissions); + } + + /** + * Creates a custom block. + * + * @param string $title + * (optional) Title of block. When no value is given uses a random name. + * Defaults to FALSE. + * @param string $bundle + * (optional) Bundle name. Defaults to 'basic'. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlock + * Created custom block. + */ + function createCustomBlock($title = FALSE, $bundle = 'basic') { + $title = ($title ? : $this->randomName()); + if ($custom_block = entity_create('custom_block', array( + 'machine_name' => $title, + 'info' => $title, + 'type' => $bundle, + 'langcode' => 'en' + ))) { + $custom_block->save(); + } + return $custom_block; + } + + /** + * Creates a custom block type (bundle). + * + * @param string $label + * The block type label. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlockType + * Created custom block type. + */ + function createCustomBlockType($label) { + $bundle = entity_create('custom_block_type', array( + 'id' => $label, + 'label' => $label, + 'revision' => FALSE + )); + $bundle->save(); + return $bundle; + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTranslationUITest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTranslationUITest.php new file mode 100644 index 0000000..7c6513b --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTranslationUITest.php @@ -0,0 +1,144 @@ + 'Custom Block translation UI', + 'description' => 'Tests the node translation UI.', + 'group' => 'Custom Block', + ); + } + + /** + * Overrides \Drupal\simpletest\WebTestBase::setUp(). + */ + function setUp() { + $this->entityType = 'custom_block'; + $this->bundle = 'basic'; + $this->name = drupal_strtolower($this->randomName()); + parent::setUp(); + } + + /** + * Overrides \Drupal\translation_entity\Tests\EntityTranslationUITest::getTranslatorPermission(). + */ + function getTranslatorPermissions() { + return array('translate any entity', 'edit original values', 'access administration pages', 'administer blocks'); + } + + /** + * Creates a custom block. + * + * @param string $title + * (optional) Title of block. When no value is given uses a random name. + * Defaults to FALSE. + * @param string $bundle + * (optional) Bundle name. When no value is given, defaults to + * $this->bundle. Defaults to FALSE. + * + * @return Drupal\custom_block\Plugin\Core\Entity\CustomBlock + * Created custom block. + */ + function createCustomBlock($title = FALSE, $bundle = FALSE) { + $title = ($title ? : $this->randomName()); + $bundle = ($bundle ? : $this->bundle); + $custom_block = entity_create('custom_block', array( + 'machine_name' => $title, + 'info' => $title, + 'type' => $bundle, + 'langcode' => 'en' + )); + $custom_block->save(); + return $custom_block; + } + + /** + * Tests field translation form. + */ + function testFieldTranslationForm() { + $admin_user = $this->drupalCreateUser(array('translate any entity', 'access administration pages', 'administer blocks')); + $this->drupalLogin($admin_user); + + $block = $this->createCustomBlock($this->name); + + // Visit translation page. + $this->drupalGet('block/' . $block->machine_name->value . '/translations'); + $this->assertRaw('Not translated'); + + // Delete the only translatable field. + field_delete_field('field_test_et_ui_test'); + + // Visit translation page. + $this->drupalGet('block/' . $block->machine_name->value . '/translations'); + $this->assertRaw('no translatable fields'); + } + + /** + * Overrides \Drupal\translation_entity\Tests\EntityTranslationUITest::getNewEntityValues(). + */ + protected function getNewEntityValues($langcode) { + return array('machine_name' => $this->name, 'info' => $this->name) + parent::getNewEntityValues($langcode); + } + + /** + * Test that no metadata is stored for a disabled bundle. + */ + public function testDisabledBundle() { + // Create a bundle that does not have translation enabled. + $disabledBundle = $this->randomName(); + $bundle = entity_create('custom_block_type', array( + 'id' => $disabledBundle, + 'label' => $disabledBundle, + 'revision' => FALSE + )); + $bundle->save(); + + // Create a node for each bundle. + $enabledCustomBlock = $this->createCustomBlock(); + $disabledCustomBlock = $this->createCustomBlock(FALSE, $bundle->id()); + + // Make sure that only a single row was inserted into the + // {translation_entity} table. + $rows = db_query('SELECT * FROM {translation_entity}')->fetchAll(); + $this->assertEqual(1, count($rows)); + $this->assertEqual($enabledCustomBlock->id(), reset($rows)->entity_id); + } + + /** + * Overrides \Drupal\translation_entity\Tests\EntityTranslationUITest::getEditValues(). + */ + protected function getEditValues($values, $langcode, $new = FALSE) { + $edit = parent::getEditValues($values, $langcode, $new); + // Can't submit machine name if not new. + if (!$new) { + unset($edit['machine_name']); + } + return $edit; + } +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTypeTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTypeTest.php new file mode 100644 index 0000000..805824d --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockTypeTest.php @@ -0,0 +1,123 @@ + 'CustomBlock types', + 'description' => 'Ensures that custom block type functions work correctly.', + 'group' => 'Custom Block', + ); + } + + /** + * Tests creating a block type programmatically and via a form. + */ + function testCustomBlockTypeCreation() { + // Create a block type programmaticaly. + $type = $this->createCustomBlockType('other'); + + $block_type = entity_load('custom_block_type', 'other'); + $this->assertTrue($block_type, 'The new block type has been created.'); + + // Login a test user. + $this->drupalLogin($this->admin_user); + + $this->drupalGet('block/add/' . $type->id()); + $this->assertResponse(200, 'The new block type can be accessed at bloack/add.'); + + // Create a block type via the user interface. + $edit = array( + 'id' => 'foo', + 'label' => 'title for foo', + ); + $this->drupalPost('admin/structure/custom-blocks/add', $edit, t('Save')); + $block_type = entity_load('custom_block_type', 'foo'); + $this->assertTrue($block_type, 'The new block type has been created.'); + } + + /** + * Tests editing a block type using the UI. + */ + function testCustomBlockTypeEditing() { + $this->drupalLogin($this->admin_user); + // We need two block types to prevent /block/add redirecting. + $this->createCustomBlockType('other'); + + $instance = field_info_instance('custom_block', 'block_body', 'basic'); + $this->assertEqual($instance['label'], 'Block body', 'Body field was found.'); + + // Verify that title and body fields are displayed. + $this->drupalGet('block/add/basic'); + $this->assertRaw('Block description', 'Block info field was found.'); + $this->assertRaw('Block body', 'Body field was found.'); + + // Change the block type name. + $edit = array( + 'label' => 'Bar', + ); + $this->drupalPost('admin/structure/custom-blocks/manage/basic', $edit, t('Save')); + field_info_cache_clear(); + + $this->drupalGet('block/add'); + $this->assertRaw('Bar', 'New name was displayed.'); + $this->clickLink('Bar'); + $this->assertEqual(url('block/add/basic', array('absolute' => TRUE)), $this->getUrl(), 'Original machine name was used in URL.'); + + // Remove the body field. + $this->drupalPost('admin/structure/custom-blocks/manage/basic/fields/block_body/delete', array(), t('Delete')); + // Resave the settings for this type. + $this->drupalPost('admin/structure/custom-blocks/manage/basic', array(), t('Save')); + // Check that the body field doesn't exist. + $this->drupalGet('block/add/basic'); + $this->assertNoRaw('Block body', 'Body field was not found.'); + } + + /** + * Tests deleting a block type that still has content. + */ + function testCustomBlockTypeDeletion() { + // Create a block type programmatically. + $type = $this->createCustomBlockType('foo'); + + $this->drupalLogin($this->admin_user); + + // Add a new block of this type. + $block = $this->createCustomBlock(FALSE, 'foo'); + // Attempt to delete the block type, which should not be allowed. + $this->drupalGet('admin/structure/custom-blocks/manage/' . $type->id() . '/delete'); + $this->assertRaw( + t('%label is used by 1 custom block on your site. You can not remove this block type until you have removed all of the %label blocks.', array('%label' => $type->label())), + 'The block type will not be deleted until all blocks of that type are removed.' + ); + $this->assertNoText(t('This action cannot be undone.'), 'The node type deletion confirmation form is not available.'); + + // Delete the block. + $block->delete(); + // Attempt to delete the block type, which should now be allowed. + $this->drupalGet('admin/structure/custom-blocks/manage/' . $type->id() . '/delete'); + $this->assertRaw( + t('Are you sure you want to delete %type?', array('%type' => $type->id())), + 'The block type is available for deletion.' + ); + $this->assertText(t('This action cannot be undone.'), 'The custom block type deletion confirmation form is available.'); + } + +} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/PageEditTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/PageEditTest.php new file mode 100644 index 0000000..bd00e45 --- /dev/null +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/PageEditTest.php @@ -0,0 +1,86 @@ + 'Custom Block edit', + 'description' => 'Create a block and test block edit functionality.', + 'group' => 'Custom Block', + ); + } + + function setUp() { + $this->permissions[] = 'view custom blocks'; + parent::setUp(); + } + + /** + * Checks block edit functionality. + */ + function testPageEdit() { + $this->drupalLogin($this->admin_user); + + $langcode = LANGUAGE_NOT_SPECIFIED; + $title_key = 'info'; + $body_key = "block_body[$langcode][0][value]"; + // Create block to edit. + $edit = array(); + $edit['info'] = $edit['machine_name'] = drupal_strtolower($this->randomName(8)); + $edit[$body_key] = $this->randomName(16); + $this->drupalPost('block/add/basic', $edit, t('Save')); + + // Check that the block exists in the database. + $blocks = entity_query('custom_block')->condition('info', $edit['info'])->execute(); + $block = entity_load('custom_block', reset($blocks)); + $this->assertTrue($block, 'Custom block found in database.'); + + // Check that "edit" link points to correct page. + $this->drupalGet('block/'. $block->machine_name->value); + $this->clickLink(t('Edit')); + $edit_url = url("block/" . $block->machine_name->value . "/edit", array('absolute' => TRUE)); + $actual_url = $this->getURL(); + $this->assertEqual($edit_url, $actual_url, 'On edit page.'); + + // Check that the title and body fields are displayed with the correct values. + $active = '' . t('(active tab)') . ''; + $link_text = t('!local-task-title!active', array('!local-task-title' => t('Edit'), '!active' => $active)); + $this->assertText(strip_tags($link_text), 0, 'Edit tab found and marked active.'); + $this->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.'); + $this->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.'); + + // Edit the content of the block. + $edit = array(); + $edit[$title_key] = $this->randomName(8); + $edit[$body_key] = $this->randomName(16); + // Stay on the current page, without reloading. + $this->drupalPost(NULL, $edit, t('Save')); + + // Check that the title and body fields are displayed with the updated values. + $this->drupalGet('block/'. $block->machine_name->value); + $this->assertText($edit[$title_key], 'Title displayed.'); + $this->assertText($edit[$body_key], 'Body displayed.'); + + // Edit the same block, creating a new revision. + $this->drupalGet("block/" . $block->machine_name->value . "/edit"); + $edit = array(); + $edit['info'] = $this->randomName(8); + $edit[$body_key] = $this->randomName(16); + $edit['revision'] = TRUE; + $this->drupalPost(NULL, $edit, t('Save')); + + // Ensure that the block revision has been created. + $revised_block = entity_load('custom_block', $block->bid->value, TRUE); + $this->assertNotIdentical($block->vid->value, $revised_block->vid->value, 'A new revision has been created.'); + } +} diff --git a/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.info b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.info new file mode 100644 index 0000000..9993892 --- /dev/null +++ b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.info @@ -0,0 +1,5 @@ +name = "Custom Block module tests" +description = "Support module for custom block related testing." +package = Testing +core = 8.x +hidden = TRUE diff --git a/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module new file mode 100644 index 0000000..83e3f4f --- /dev/null +++ b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module @@ -0,0 +1,82 @@ +custom_block_test_loaded_bids = $bids; + $custom_block->custom_block_test_loaded_types = $types; + } +} + +/** + * Implements hook_custom_block_view(). + */ +function custom_block_test_custom_block_view(CustomBlock $custom_block, $view_mode) { + // Add extra content. + $custom_block->content['extra_content'] = array( + '#markup' => 'Yowser', + ); +} + +/** + * Implements hook_custom_block_presave(). + */ +function custom_block_test_custom_block_presave(CustomBlock $custom_block) { + if ($custom_block->info->value == 'testing_custom_block_presave') { + $custom_block->info->value .= '_presave'; + } + // Determine changes. + if (!empty($custom_block->original) && $custom_block->original->info->value == 'test_changes') { + if ($custom_block->original->info->value != $custom_block->info->value) { + $custom_block->info->value .= '_presave'; + } + } +} + +/** + * Implements hook_custom_block_update(). + */ +function custom_block_test_custom_block_update(CustomBlock $custom_block) { + // Determine changes on update. + if (!empty($custom_block->original) && $custom_block->original->info->value == 'test_changes') { + if ($custom_block->original->info->value != $custom_block->info->value) { + $custom_block->info->value .= '_update'; + } + } +} + +/** + * Implements hook_custom_block_insert(). + * + * This tests saving a custom_block on custom_block insert. + * + * @see \Drupal\custom_block\Tests\CustomBlockSaveTest::testCustomBlockSaveOnInsert() + */ +function custom_block_test_custom_block_insert(CustomBlock $custom_block) { + // Set the custom_block title to the custom_block ID and save. + if ($custom_block->info->value == 'new') { + $custom_block->info->value = 'CustomBlock '. $custom_block->bid->value; + $custom_block->save(); + } + if ($custom_block->info->value == 'fail_creation') { + throw new Exception('Test exception for rollback.'); + } +} diff --git a/core/modules/block/lib/Drupal/block/Plugin/system/plugin_ui/BlockPluginUI.php b/core/modules/block/lib/Drupal/block/Plugin/system/plugin_ui/BlockPluginUI.php index 27256a2..61f3dd4 100644 --- a/core/modules/block/lib/Drupal/block/Plugin/system/plugin_ui/BlockPluginUI.php +++ b/core/modules/block/lib/Drupal/block/Plugin/system/plugin_ui/BlockPluginUI.php @@ -73,7 +73,7 @@ public function form($form, &$form_state, $facet = NULL) { $rows = array(); foreach ($plugins as $plugin_id => $display_plugin_definition) { if (empty($facet) || $this->facetCompare($facet, $display_plugin_definition)) { - $rows[] = $this->row($plugin_id, $display_plugin_definition); + $rows[$plugin_id] = $this->row($plugin_id, $display_plugin_definition); } foreach ($plugin_definition['facets'] as $key => $title) { $facets[$key][$display_plugin_definition[$key]] = $this->facetLink($key, $plugin_id, $display_plugin_definition); diff --git a/core/modules/block/lib/Drupal/block/Tests/BlockTest.php b/core/modules/block/lib/Drupal/block/Tests/BlockTest.php index c607973..0b6cc0e 100644 --- a/core/modules/block/lib/Drupal/block/Tests/BlockTest.php +++ b/core/modules/block/lib/Drupal/block/Tests/BlockTest.php @@ -106,25 +106,34 @@ public function testCustomBlock() { } } - // Add a new custom block by filling out the input form on the admin/structure/block/add page. + // Add a new custom block by filling out the input form on block/add/basic. $info = strtolower($this->randomName(8)); + $langcode = LANGUAGE_NOT_SPECIFIED; + $values = array( + 'info' => $info, + 'machine_name' => $info, + "block_body[$langcode][0][value]" => $this->randomName(8) + ); + $this->drupalPost('block/add/basic', $values, t('Save')); $custom_block['machine_name'] = $info; - $custom_block['info'] = $info; $custom_block['title'] = $this->randomName(8); - $custom_block['body[value]'] = $this->randomName(32); $custom_block['region'] = $this->regions[0]; - $this->drupalPost("admin/structure/block/list/block_plugin_ui:$default_theme/add/custom_blocks", $custom_block, t('Save block')); + $this->drupalPost(NULL, $custom_block, t('Save block')); $plugin_id = "plugin.core.block.$default_theme.$info"; $block = $manager->getInstance(array('config' => $plugin_id)); $config = $block->getConfig(); // Confirm that the custom block has been created, and then query the created bid. - $this->assertText(t('The block configuration has been saved.'), 'Custom block successfully created.'); + $this->assertText(t('The block configuration has been saved.'), 'Custom block instance successfully created.'); - // Check that block_block_view() returns the correct title and content. + // Check that block_block_view() returns the correct content. $data = $block->build(); - $format = $config['format']; - $this->assertEqual(check_markup($custom_block['body[value]'], $format), render($data), 'BlockInterface::build() provides correct block content.'); + $output = render($data); + + $this->drupalSetcontent($output); + $elements = $this->xpath('//div[@class=:class]', array(':class' => 'field-item even')); + + $this->assertEqual($values["block_body[$langcode][0][value]"], $elements[0], 'BlockInterface::build() provides correct block content.'); // Check whether the block can be moved to all available regions. $custom_block['module'] = 'block'; @@ -158,36 +167,41 @@ public function testCustomBlockFormat() { $default_theme = variable_get('theme_default', 'stark'); $this->removeDefaultBlocks(); - // Add a new custom block by filling out the input form on the admin/structure/block/add page. - $info = $this->randomName(8); + // Add a new custom block by filling out the input form on block/add/basic. + $info = strtolower($this->randomName(8)); + $langcode = LANGUAGE_NOT_SPECIFIED; + $values = array( + 'info' => $info, + 'machine_name' => $info, + "block_body[$langcode][0][value]" => '

Full HTML

', + "block_body[$langcode][0][format]" => 'full_html' + ); + $this->drupalPost('block/add/basic', $values, t('Save')); $custom_block['machine_name'] = $info; - $custom_block['info'] = $info; $custom_block['title'] = $this->randomName(8); - $custom_block['body[value]'] = '

Full HTML

'; - $full_html_format = filter_format_load('full_html'); - $custom_block['body[format]'] = $full_html_format->format; $custom_block['region'] = $this->regions[0]; - $this->drupalPost("admin/structure/block/list/block_plugin_ui:$default_theme/add/custom_blocks", $custom_block, t('Save block')); + $this->drupalPost(NULL, $custom_block, t('Save block')); // Set the created custom block to a specific region. $edit['blocks[0][region]'] = $this->regions[1]; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); - // Confirm that the custom block is being displayed using configured text format. + // Confirm that the custom block is being displayed using configured text + // format. $this->drupalGet(''); $this->assertRaw('

Full HTML

', 'Custom block successfully being displayed using Full HTML.'); - // Confirm that a user without access to Full HTML can not see the body field, - // but can still submit the form without errors. + // Confirm that a user without access to Full HTML can not see the body + // field, but can still submit the form without errors. $block_admin = $this->drupalCreateUser(array('administer blocks')); $config_block_id = "admin/structure/block/manage/plugin.core.block.$default_theme.$info/$default_theme"; $this->drupalLogin($block_admin); - $this->drupalGet("$config_block_id/configure"); - $this->assertFieldByXPath("//textarea[@name='body[value]' and @disabled='disabled']", t('This field has been disabled because you do not have sufficient permissions to edit it.'), 'Body field contains denied message'); - $this->drupalPost("$config_block_id/configure", array(), t('Save block')); + $this->drupalGet("block/$info/edit"); + $this->assertFieldByXPath("//textarea[@name='block_body[und][0][value]' and @disabled='disabled']", t('This field has been disabled because you do not have sufficient permissions to edit it.'), 'Body field contains denied message'); $this->assertNoText(t('Ensure that each block description is unique.')); - // Confirm that the custom block is still being displayed using configured text format. + // Confirm that the custom block is still being displayed using configured + // text format. $this->drupalGet(''); $this->assertRaw('

Full HTML

', 'Custom block successfully being displayed using Full HTML.'); } diff --git a/core/modules/field/field.attach.inc b/core/modules/field/field.attach.inc index 9748b6b..dfd1551 100644 --- a/core/modules/field/field.attach.inc +++ b/core/modules/field/field.attach.inc @@ -1431,6 +1431,9 @@ function field_attach_view(EntityInterface $entity, EntityDisplay $display, $lan // Remove the BC layer now. $entity = $entity->getOriginalEntity(); + // Remove the BC layer now. + $entity = $entity->getOriginalEntity(); + // Let other modules alter the renderable array. $view_mode = $display->originalViewMode; $context = array(