forward.admin.inc in Forward 7.3
Same filename and directory in other branches
Administrative page for Forward module
File
forward.admin.incView source
<?php
/**
* @file
* Administrative page for Forward module
*
*/
/**
* Callback function for administration menu item
*/
function forward_admin_settings($form, &$form_state) {
// Entity Types
$form['forward_entities'] = array(
'#type' => 'fieldset',
'#title' => t('Entity Types'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$entity_types = entity_get_info();
$options = array();
$defaults = array();
foreach ($entity_types as $type => $info) {
if (!empty($info['view modes'])) {
$options[$type] = check_plain($info['label']);
if (variable_get('forward_entity_' . $type, FALSE)) {
$defaults[] = $type;
}
}
}
$form['forward_entities']['forward_entity_types'] = array(
'#type' => 'checkboxes',
'#title' => t('Entity types'),
'#options' => $options,
'#default_value' => $defaults,
'#description' => t('Choose entity types to show Forward on.'),
);
// Bundles
foreach ($entity_types as $type => $info) {
if (!empty($info['view modes'])) {
if (variable_get('forward_entity_' . $type, FALSE)) {
if (count($entity_types[$type]['bundles']) == 1) {
foreach ($entity_types[$type]['bundles'] as $bundle => $bundle_info) {
$form['forward_entities']['forward_' . $type . '_types'] = array(
'#type' => 'hidden',
'#value' => $bundle,
);
}
}
else {
$options = array();
$defaults = array();
foreach ($entity_types[$type]['bundles'] as $bundle => $bundle_info) {
$options[$bundle] = check_plain($bundle_info['label']);
if (variable_get('forward_' . $type . '_' . $bundle, FALSE)) {
$defaults[] = $bundle;
}
}
$form['forward_entities']['forward_' . $type . '_types'] = array(
'#type' => 'checkboxes',
'#title' => t($info['label'] . ' bundles'),
'#options' => $options,
'#default_value' => $defaults,
'#description' => t('Choose ' . strtolower($info['label']) . ' bundles to show Forward on.'),
);
}
}
}
}
// View Modes
$modes = array(
'full' => t('Full entity'),
'teaser' => t('Teaser'),
);
$options = array();
$defaults = array();
foreach ($modes as $mode => $info) {
$options[$mode] = check_plain($info);
if (variable_get('forward_view_' . $mode, FALSE)) {
$defaults[] = $mode;
}
}
$form['forward_entities']['forward_view_modes'] = array(
'#type' => 'checkboxes',
'#title' => t('View modes'),
'#options' => $options,
'#default_value' => $defaults,
'#description' => t('Choose view modes to show Forward on. Use Display Suite layouts to configure additional view modes.'),
);
// Interface
$form['forward_interface'] = array(
'#type' => 'fieldset',
'#title' => t('Interface'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_interface']['forward_interface_type'] = array(
'#type' => 'select',
'#title' => t('Interface type'),
'#default_value' => variable_get('forward_interface_type', 'link'),
'#options' => array(
'link' => t('Link to separate page'),
'form' => t('Display inline form'),
),
'#description' => t('Choose how the Forward form is reached from the displayed entity. Inline forms are displayed within a collapsible fieldset on the entity being forwarded.'),
);
$form['forward_interface']['forward_link_title'] = array(
'#type' => 'textfield',
'#title' => t('Title of interface element'),
'#size' => 40,
'#default_value' => variable_get('forward_link_title', 'Email this [forward:entity-type]'),
'#description' => t('Set the text of the link or fieldset title. Replacement tokens, as found below, may be used.'),
);
$form['forward_interface']['forward_link_options'] = array(
'#type' => 'fieldset',
'#title' => t('Link Options'),
'#collapsible' => FALSE,
);
$form['forward_interface']['forward_link_options']['forward_link_style'] = array(
'#type' => 'radios',
'#title' => t('Style'),
'#default_value' => variable_get('forward_link_style', 0),
'#options' => array(
0 => t('Text only'),
1 => t('Icon only'),
2 => t('Icon and text'),
),
'#description' => t('Select the visual style of the link.'),
);
$form['forward_interface']['forward_link_options']['forward_link_icon'] = array(
'#type' => 'textfield',
'#size' => 40,
'#title' => t('Path to custom icon'),
'#default_value' => variable_get('forward_link_icon', ''),
'#description' => t('The path to the file you would like to use as your link icon instead of the default icon.'),
);
$form['forward_interface']['forward_link_options']['forward_link_alias'] = array(
'#type' => 'checkbox',
'#title' => t('Use the path alias for the entity, if available, when generating the forward link'),
'#default_value' => variable_get('forward_link_alias', 1),
);
$form['forward_interface']['forward_link_options']['forward_link_noindex'] = array(
'#type' => 'checkbox',
'#title' => t('Generate a noindex meta tag on the forward page') . ' (name="robots", content="noindex, nofollow")',
'#default_value' => variable_get('forward_link_noindex', 1),
);
$form['forward_interface']['forward_link_options']['forward_link_nofollow'] = array(
'#type' => 'checkbox',
'#title' => t('Generate a nofollow tag on the forward link (rel="nofollow")'),
'#default_value' => variable_get('forward_link_nofollow', 0),
);
// Thank You Email Values
$form['forward_thank_you'] = array(
'#type' => 'fieldset',
'#title' => t('Thank You Email'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_thank_you']['forward_thankyou_send'] = array(
'#type' => 'checkbox',
'#title' => t('Send a thank you email to the person doing the forwarding'),
'#return_value' => 1,
'#default_value' => variable_get('forward_thankyou_send', FALSE),
);
$form['forward_thank_you']['forward_thankyou_subject'] = array(
'#type' => 'textfield',
'#title' => t('Thank you email subject'),
'#default_value' => variable_get('forward_thankyou_subject', 'Thank you for spreading the word about [site:name]'),
);
$form['forward_thank_you']['forward_thankyou_text'] = array(
'#type' => 'textarea',
'#title' => t('Thank you email text'),
'#default_value' => variable_get('forward_thankyou_text', "Dear [forward:sender],\n\nThank you for spreading the word about [site:name]. We appreciate your help."),
'#cols' => 40,
'#rows' => 10,
);
// Global Defaults
$form['forward_global'] = array(
'#type' => 'fieldset',
'#title' => t('Global Defaults'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_global']['personal_messages'] = array(
'#type' => 'fieldset',
'#title' => t('Personal Messages'),
'#collapsible' => FALSE,
);
$form['forward_global']['personal_messages']['forward_message'] = array(
'#type' => 'select',
'#title' => t('Personal message field'),
'#options' => array(
0 => 'Disabled',
1 => 'Optional',
2 => 'Required',
),
'#default_value' => variable_get('forward_message', 1),
'#description' => t('Choose whether the personal message field will be disabled, optional, or required.'),
);
$form['forward_global']['personal_messages']['forward_filter_html'] = array(
'#type' => 'checkbox',
'#title' => t('Allow HTML in personal messages'),
'#return_value' => 1,
'#default_value' => variable_get('forward_filter_html', FALSE),
'#description' => t('Filter XSS and all tags not allowed below from the custom body field. Otherwise, the body will converted to plain text with all HTML converted to character entities'),
);
$form['forward_global']['personal_messages']['forward_filter_tags'] = array(
'#type' => 'textfield',
'#title' => t('Allowed HTML tags'),
'#size' => 40,
'#default_value' => variable_get('forward_filter_tags', 'p,br,em,strong,cite,code,ul,ol,li,dl,dt,dd'),
'#description' => t('List of allowed tags (separated by commas) that will be allowed by the XSS filter if enabled above. The default tags allowed are: p,br,em,strong,cite,code,ul,ol,li,dl,dt,dd'),
);
$form['forward_global']['emails'] = array(
'#type' => 'fieldset',
'#title' => t('Sent Emails'),
'#collapsible' => FALSE,
);
$form['forward_global']['emails']['forward_sender_address'] = array(
'#type' => 'textfield',
'#title' => t('From address'),
'#default_value' => variable_get('forward_sender_address', variable_get('site_mail', '')),
'#size' => 40,
'#maxlength' => 40,
'#description' => t('If left blank, the from address entered in the form will be used as the from address for the email. Enter a valid email address here to override that. The sender\'s email will still appear in the body of the message.'),
);
$form['forward_global']['emails']['forward_width'] = array(
'#type' => 'textfield',
'#title' => t('Email width'),
'#default_value' => variable_get('forward_width', 400),
'#size' => 10,
'#description' => t('Set a width for the table in the email template. Ideally, this should be somewhere between 400 and 600 pixels to avoid breaking the layout in various email clients.'),
'#attributes' => FALSE,
);
$form['forward_global']['emails']['forward_header_image'] = array(
'#type' => 'textfield',
'#title' => t('Header Image for Email'),
'#default_value' => variable_get('forward_header_image', ''),
'#size' => 40,
'#maxlength' => 256,
'#description' => t('Enter the URL of the image to use as a logo at the top of forwarded pages.'),
'#attributes' => FALSE,
);
$form['forward_global']['forward_form'] = array(
'#type' => 'fieldset',
'#title' => t('Forward Form'),
'#collapsible' => FALSE,
);
$form['forward_global']['forward_form']['forward_instructions'] = array(
'#type' => 'textarea',
'#title' => t('Instructions'),
'#default_value' => variable_get('forward_instructions', '<p>Thank you for your interest in spreading the word about [site:name].</p><p>NOTE: We only request your email address so that the person you are recommending the page to knows that you wanted them to see it, and that it is not junk mail. We do not capture any email address.</p>'),
'#cols' => 40,
'#rows' => 10,
'#description' => t('This message will be displayed above the form. The token [site:name] will be replaced with the site name.'),
);
$form['forward_global']['forward_form']['forward_thankyou'] = array(
'#type' => 'textarea',
'#title' => t('Thank You Message'),
'#default_value' => variable_get('forward_thankyou', 'Thank you for spreading the word about [site:name]. We appreciate your help.'),
'#cols' => 40,
'#rows' => 10,
'#description' => t('This message will be displayed after the user successfully submits the form. The token [site:name] will be replaced with the site name.'),
);
// Forward Form Defaults
$form['forward_email_defaults'] = array(
'#type' => 'fieldset',
'#title' => t('Defaults for Email This Page'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_email_defaults']['forward_email_title'] = array(
'#type' => 'textfield',
'#title' => t('Forward Page Title'),
'#default_value' => variable_get('forward_email_title', t('Forward this page to a friend')),
'#size' => 40,
'#maxlength' => 256,
'#description' => t('Title to display above the Forward page form'),
);
$form['forward_email_defaults']['forward_email_subject'] = array(
'#type' => 'textfield',
'#title' => t('Forward Message Subject'),
'#default_value' => variable_get('forward_email_subject', t('[forward:sender] has forwarded a page to you from [site:name]')),
'#size' => 40,
'#maxlength' => 256,
'#description' => t('Email subject line. Replacement tokens, as found below, may be used'),
);
$form['forward_email_defaults']['forward_email_message'] = array(
'#type' => 'textarea',
'#title' => t('Forward Message Body'),
'#default_value' => variable_get('forward_email_message', t('[forward:sender] thought you would like to see this page from the [site:name] web site.')),
'#cols' => 40,
'#rows' => 10,
'#description' => t('Email message body. Replacement tokens, as found below, may be used. The sender will be able to add their own message after this.'),
);
$form['forward_email_defaults']['forward_full_body'] = array(
'#type' => 'checkbox',
'#title' => t('Include full entity in message body'),
'#return_value' => 1,
'#default_value' => variable_get('forward_full_body', FALSE),
'#description' => t('Include the full body of the entity rather than just the teaser'),
);
$form['forward_email_defaults']['forward_custom_viewmode'] = array(
'#type' => 'checkbox',
'#title' => t('Use custom display to build message body'),
'#return_value' => 1,
'#default_value' => variable_get('forward_custom_viewmode', FALSE),
'#description' => t('Use a custom view mode named "Forward" to build the entity, if available (clear cache twice after enabling this option)'),
);
$form['forward_email_defaults']['forward_theme_content'] = array(
'#type' => 'checkbox',
'#title' => t('Output themed entity when using custom display'),
'#return_value' => 1,
'#default_value' => variable_get('forward_theme_content', FALSE),
'#description' => t('Theme the entity using a template, such as node--forward.tpl.php for nodes. See the README for template suggestions and guidelines. Only applies when a custom display is used.'),
);
// e-PostCard Form Default Values
$form['forward_epostcard_defaults'] = array(
'#type' => 'fieldset',
'#title' => t('Defaults for e-Postcard'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_epostcard_defaults']['forward_epostcard_title'] = array(
'#type' => 'textfield',
'#title' => t('Forward e-Postcard Title'),
'#default_value' => variable_get('forward_epostcard_title', t('Send an e-Postcard')),
'#size' => 40,
'#maxlength' => 256,
'#description' => t('Title to display above the Forward page form'),
);
$form['forward_epostcard_defaults']['forward_epostcard_subject'] = array(
'#type' => 'textfield',
'#title' => t('e-Postcard Message Subject'),
'#default_value' => variable_get('forward_epostcard_subject', t('[forward:sender] has sent you an e-postcard from [site:name]')),
'#size' => 40,
'#maxlength' => 256,
'#description' => t('Postcard subject line. Replacement tokens, as found below, may be used'),
);
$form['forward_epostcard_defaults']['forward_epostcard_message'] = array(
'#type' => 'textarea',
'#title' => t('e-Postcard Message Body'),
'#default_value' => variable_get('forward_epostcard_message', t('[forward:sender] has sent you an e-postcard from the [site:name] web site. Please take a moment to visit our web site.')),
'#cols' => 40,
'#rows' => 10,
'#description' => t('Postcard message body. Replacement tokens, as found below, may be used. The sender will be able to add their own message after this. You can use HTML in this field to add a special postcard image to the email above the sender\'s message.'),
);
$form['forward_epostcard_defaults']['forward_ad_footer'] = array(
'#type' => 'textarea',
'#title' => t('Organization Ad'),
'#default_value' => variable_get('forward_ad_footer', " "),
'#cols' => 40,
'#rows' => 10,
'#description' => t('This message will be just above the footer message in the email.'),
);
$form['forward_epostcard_defaults']['forward_footer'] = array(
'#type' => 'textarea',
'#title' => t('Footer Message'),
'#default_value' => variable_get('forward_footer', " "),
'#cols' => 40,
'#rows' => 4,
'#description' => t('This message will be appended as a footer message to the email.'),
);
$form['forward_epostcard_defaults']['forward_epostcard_return'] = array(
'#type' => 'textfield',
'#title' => t('e-Postcard Return URL'),
'#default_value' => variable_get('forward_epostcard_return', ''),
'#size' => 40,
'#description' => t('URL of path to redirect users to after submitting the epostcard form.'),
);
// Replacement tokens
$form['token_help'] = array(
'#title' => t('Replacement patterns'),
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$token_types = array();
foreach ($entity_types as $type => $info) {
if (!empty($info['view modes']) && !empty($info['token type'])) {
$token_types[] = $info['token type'];
}
}
$token_types[] = 'entity_metadata';
$token_types[] = 'forward';
$form['token_help']['help'] = array(
'#theme' => 'token_tree',
'#token_types' => $token_types,
);
// Colorbox integration
$form['forward_colorbox'] = array(
'#type' => 'fieldset',
'#title' => t('Colorbox Integration'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_colorbox']['forward_colorbox_spacer'] = array(
'#markup' => '<div style="height: 10px; width: 1px"></div>',
);
$form['forward_colorbox']['forward_colorbox_enable'] = array(
'#type' => 'checkbox',
'#title' => t('Generate links so the forward page displays in a colorbox overlay'),
'#description' => t('The Colorbox module must be installed with either the "colorbox load" extra feature enabled or the Colorbox Node module enabled.<br />The Colorbox Node module is recommended. Note: Colorbox integration is not supported for e-Postcard links or links generated by the Service Links module.'),
'#return_value' => 1,
'#default_value' => variable_get('forward_colorbox_enable', FALSE),
);
$form['forward_colorbox']['forward_colorbox_width'] = array(
'#type' => 'textfield',
'#title' => t('Width of colorbox'),
'#size' => 5,
'#maxlength' => 4,
'#default_value' => variable_get('forward_colorbox_width', '600'),
);
$form['forward_colorbox']['forward_colorbox_height'] = array(
'#type' => 'textfield',
'#title' => t('Height of colorbox'),
'#size' => 5,
'#maxlength' => 4,
'#default_value' => variable_get('forward_colorbox_height', '600'),
);
// Dynamic Block settings
$form['forward_dynamic_block_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Dynamic Block Settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('These options control whether sent emails include dynamic block content.'),
);
$dyn_options = array(
'node' => t('Latest Blog Articles'),
'user' => t('Latest Users'),
'comment' => t('Latest Comments'),
'popular' => t('Most Popular Content'),
'none' => t('None'),
);
$form['forward_dynamic_block_settings']['forward_dynamic_block'] = array(
'#type' => 'radios',
'#title' => t('Dynamic Block'),
'#default_value' => variable_get('forward_dynamic_block', 'none'),
'#options' => $dyn_options,
'#description' => t('Choose the dynamic block to send with these emails. The Most Popular Content block requires the Statistics module to be enabled with the "count content views" option selected.'),
'#required' => TRUE,
'#attributes' => NULL,
);
$acl_options = array(
'recipient' => t('If one email address is entered in the Send To field and it corresponds to an active Drupal account, use the permissions of that account. Otherwise use anonymous visitor permissions. <em>(default)</em>'),
'anonymous' => t('Always use the anonymous visitor permissions.'),
'sender' => t('Use the permissions of the person sending the email.'),
'none' => t('Bypass access control. This mimics the behavior prior to release 7.x-1.3. <em>Warning: selecting this option has security implications.</em>'),
);
$form['forward_dynamic_block_settings']['forward_block_access_control'] = array(
'#type' => 'radios',
'#title' => t('Dynamic Block Access Control'),
'#default_value' => variable_get('forward_block_access_control', 'recipient'),
'#options' => $acl_options,
'#description' => t('Select the type of access control to apply to the dynamic block. This determines which content will be included in the block. Most sites should use the default.'),
'#required' => TRUE,
'#attributes' => NULL,
);
// Post processing filters
$filter_options = array();
$filter_options[''] = t('- None - ');
foreach (filter_formats() as $key => $format) {
if (filter_access($format)) {
$filter_options[$key] = $format->name;
}
}
if (count($filter_options) > 1) {
$form['forward_filter_options'] = array(
'#type' => 'fieldset',
'#title' => t('Message body filters'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_filter_options']['forward_filter_format'] = array(
'#type' => 'select',
'#title' => t('Filter format'),
'#default_value' => variable_get('forward_filter_format', ''),
'#options' => $filter_options,
'#description' => t('Select a filter to apply to the forward message body. A filter with <a href="http://drupal.org/project/pathologic">Pathologic</a> assigned to it will convert relative links to absolute links. <a href="http://drupal.org/project/modules">More filters</a>.'),
);
}
// Flood Control
$form['forward_flood_control_options'] = array(
'#type' => 'fieldset',
'#title' => t('Flood Control'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['forward_flood_control_options']['forward_flood_control'] = array(
'#type' => 'select',
'#title' => t('Flood control limit'),
'#default_value' => variable_get('forward_flood_control', 10),
'#options' => array(
'1' => '1',
'5' => '5',
'10' => '10',
'15' => '15',
'20' => '20',
'25' => '25',
'30' => '30',
'35' => '35',
'40' => '40',
'50' => '50',
),
'#description' => t('How many times a user can use the form in a one hour period. This will help prevent the forward module from being used for spamming.'),
);
$form['forward_flood_control_options']['forward_flood_error'] = array(
'#type' => 'textarea',
'#title' => t('Flood control error'),
'#default_value' => variable_get('forward_flood_error', t("You can't send more than !number messages per hour. Please try again later.")),
'#cols' => 40,
'#rows' => 10,
'#description' => t('This text appears if a user exceeds the flood control limit. The value of the flood control limit setting will appear in place of !number in the message presented to users'),
);
$form['forward_flood_control_options']['forward_flood_control_clicks'] = array(
'#type' => 'select',
'#title' => t('Flood control limit for clickthrough tracking'),
'#default_value' => variable_get('forward_flood_control_clicks', 3),
'#options' => array(
'1' => '1',
'2' => '2',
'3' => '3',
'4' => '4',
'5' => '5',
'6' => '6',
'7' => '7',
'8' => '8',
'9' => '9',
'10' => '10',
),
'#description' => t('How many times per minute clickthroughs will be tracked from a single IP address. This will help prevent manipulation of forward clickthrough statistics.'),
);
$form['#submit'][] = 'forward_admin_settings_submit';
return system_settings_form($form);
}
/**
* Additional submit handler for administrative settings to handle entity type settings
*/
function forward_admin_settings_submit($form, &$form_state) {
$entity_types = entity_get_info();
// Entity types and bundles
foreach ($entity_types as $type => $info) {
if (!empty($form_state['values']['forward_entity_types'][$type])) {
variable_set('forward_entity_' . $type, TRUE);
}
else {
variable_set('forward_entity_' . $type, FALSE);
}
foreach ($entity_types[$type]['bundles'] as $bundle => $bundle_info) {
if (!empty($form_state['values']['forward_entity_types'][$type]) && !empty($form_state['values']['forward_' . $type . '_types'][$bundle])) {
variable_set('forward_' . $type . '_' . $bundle, TRUE);
}
else {
variable_set('forward_' . $type . '_' . $bundle, FALSE);
}
// If only one bundle, it gets the same setting as its type
if (count($entity_types[$type]['bundles']) == 1) {
variable_set('forward_' . $type . '_' . $bundle, variable_get('forward_entity_' . $type, FALSE));
}
}
unset($form_state['values']['forward_' . $type . '_types']);
}
unset($form_state['values']['forward_entity_types']);
// View modes
$modes = array(
'full' => t('Full entity'),
'teaser' => t('Teaser'),
);
foreach ($modes as $mode => $info) {
if (!empty($form_state['values']['forward_view_modes'][$mode])) {
variable_set('forward_view_' . $mode, TRUE);
}
else {
variable_set('forward_view_' . $mode, FALSE);
}
}
unset($form_state['values']['forward_view_modes']);
}Functions
Name |
Description |
|---|---|
| forward_admin_settings | Callback function for administration menu item |
| forward_admin_settings_submit | Additional submit handler for administrative settings to handle entity type settings |