webmaster@1: <?php
webmaster@1: // $Id: forum.admin.inc,v 1.8 2008/01/30 10:14:42 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Administrative page callbacks for the forum module.
webmaster@1:  */
webmaster@1: 
webmaster@1: function forum_form_main($type, $edit = array()) {
webmaster@1:   if ((isset($_POST['op']) && $_POST['op'] == t('Delete')) || !empty($_POST['confirm'])) {
webmaster@1:     return drupal_get_form('forum_confirm_delete', $edit['tid']);
webmaster@1:   }
webmaster@1:   switch ($type) {
webmaster@1:     case 'forum':
webmaster@1:       return drupal_get_form('forum_form_forum', $edit);
webmaster@1:       break;
webmaster@1:     case 'container':
webmaster@1:       return drupal_get_form('forum_form_container', $edit);
webmaster@1:       break;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns a form for adding a forum to the forum vocabulary
webmaster@1:  *
webmaster@1:  * @param $edit Associative array containing a forum term to be added or edited.
webmaster@1:  * @ingroup forms
webmaster@1:  * @see forum_form_submit()
webmaster@1:  */
webmaster@1: function forum_form_forum(&$form_state, $edit = array()) {
webmaster@1:   $edit += array(
webmaster@1:     'name' => '',
webmaster@1:     'description' => '',
webmaster@1:     'tid' => NULL,
webmaster@1:     'weight' => 0,
webmaster@1:   );
webmaster@1:   $form['name'] = array('#type' => 'textfield',
webmaster@1:     '#title' => t('Forum name'),
webmaster@1:     '#default_value' => $edit['name'],
webmaster@1:     '#maxlength' => 255,
webmaster@1:     '#description' => t('Short but meaningful name for this collection of threaded discussions.'),
webmaster@1:     '#required' => TRUE,
webmaster@1:   );
webmaster@1:   $form['description'] = array('#type' => 'textarea',
webmaster@1:     '#title' => t('Description'),
webmaster@1:     '#default_value' => $edit['description'],
webmaster@1:     '#description' => t('Description and guidelines for discussions within this forum.'),
webmaster@1:   );
webmaster@1:   $form['parent']['#tree'] = TRUE;
webmaster@1:   $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
webmaster@1:   $form['weight'] = array('#type' => 'weight',
webmaster@1:     '#title' => t('Weight'),
webmaster@1:     '#default_value' => $edit['weight'],
webmaster@1:     '#description' => t('Forums are displayed in ascending order by weight (forums with equal weights are displayed alphabetically).'),
webmaster@1:   );
webmaster@1: 
webmaster@1:   $form['vid'] = array('#type' => 'hidden', '#value' => variable_get('forum_nav_vocabulary', ''));
webmaster@1:   $form['submit' ] = array('#type' => 'submit', '#value' => t('Save'));
webmaster@1:   if ($edit['tid']) {
webmaster@1:     $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1:     $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
webmaster@1:   }
webmaster@1:   $form['#submit'][] = 'forum_form_submit';
webmaster@1:   $form['#theme'] = 'forum_form';
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Process forum form and container form submissions.
webmaster@1:  */
webmaster@1: function forum_form_submit($form, &$form_state) {
webmaster@1:   if ($form['form_id']['#value'] == 'forum_form_container') {
webmaster@1:     $container = TRUE;
webmaster@1:     $type = t('forum container');
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $container = FALSE;
webmaster@1:     $type = t('forum');
webmaster@1:   }
webmaster@1: 
webmaster@1:   $status = taxonomy_save_term($form_state['values']);
webmaster@1:   switch ($status) {
webmaster@1:     case SAVED_NEW:
webmaster@1:       if ($container) {
webmaster@1:         $containers = variable_get('forum_containers', array());
webmaster@1:         $containers[] = $form_state['values']['tid'];
webmaster@1:         variable_set('forum_containers', $containers);
webmaster@1:       }
webmaster@1:       drupal_set_message(t('Created new @type %term.', array('%term' => $form_state['values']['name'], '@type' => $type)));
webmaster@1:       break;
webmaster@1:     case SAVED_UPDATED:
webmaster@1:       drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_state['values']['name'], '@type' => $type)));
webmaster@1:       break;
webmaster@1:   }
webmaster@1:   $form_state['redirect'] = 'admin/content/forum';
webmaster@1:   return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns a form for adding a container to the forum vocabulary
webmaster@1:  *
webmaster@1:  * @param $edit Associative array containing a container term to be added or edited.
webmaster@1:  * @ingroup forms
webmaster@1:  * @see forum_form_submit()
webmaster@1:  */
webmaster@1: function forum_form_container(&$form_state, $edit = array()) {
webmaster@1:   $edit += array(
webmaster@1:     'name' => '',
webmaster@1:     'description' => '',
webmaster@1:     'tid' => NULL,
webmaster@1:     'weight' => 0,
webmaster@1:   );
webmaster@1:   // Handle a delete operation.
webmaster@1:   $form['name'] = array(
webmaster@1:     '#title' => t('Container name'),
webmaster@1:     '#type' => 'textfield',
webmaster@1:     '#default_value' => $edit['name'],
webmaster@1:     '#maxlength' => 255,
webmaster@1:     '#description' => t('Short but meaningful name for this collection of related forums.'),
webmaster@1:     '#required' => TRUE
webmaster@1:   );
webmaster@1: 
webmaster@1:   $form['description'] = array(
webmaster@1:     '#type' => 'textarea',
webmaster@1:     '#title' => t('Description'),
webmaster@1:     '#default_value' => $edit['description'],
webmaster@1:     '#description' => t('Description and guidelines for forums within this container.')
webmaster@1:   );
webmaster@1:   $form['parent']['#tree'] = TRUE;
webmaster@1:   $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
webmaster@1:   $form['weight'] = array(
webmaster@1:     '#type' => 'weight',
webmaster@1:     '#title' => t('Weight'),
webmaster@1:     '#default_value' => $edit['weight'],
webmaster@1:     '#description' => t('Containers are displayed in ascending order by weight (containers with equal weights are displayed alphabetically).')
webmaster@1:   );
webmaster@1: 
webmaster@1:   $form['vid'] = array(
webmaster@1:     '#type' => 'hidden',
webmaster@1:     '#value' => variable_get('forum_nav_vocabulary', ''),
webmaster@1:   );
webmaster@1:   $form['submit'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => t('Save')
webmaster@1:   );
webmaster@1:   if ($edit['tid']) {
webmaster@1:     $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1:     $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
webmaster@1:   }
webmaster@1:   $form['#submit'][] = 'forum_form_submit';
webmaster@1:   $form['#theme'] = 'forum_form';
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns a confirmation page for deleting a forum taxonomy term.
webmaster@1:  *
webmaster@1:  * @param $tid ID of the term to be deleted
webmaster@1:  */
webmaster@1: function forum_confirm_delete(&$form_state, $tid) {
webmaster@1:   $term = taxonomy_get_term($tid);
webmaster@1: 
webmaster@1:   $form['tid'] = array('#type' => 'value', '#value' => $tid);
webmaster@1:   $form['name'] = array('#type' => 'value', '#value' => $term->name);
webmaster@1: 
webmaster@1:   return confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), 'admin/content/forum', t('Deleting a forum or container will also delete its sub-forums, if any. To delete posts in this forum, visit <a href="@content">content administration</a> first. This action cannot be undone.', array('@content' => url('admin/content/node'))), t('Delete'), t('Cancel'));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Implementation of forms api _submit call. Deletes a forum after confirmation.
webmaster@1:  */
webmaster@1: function forum_confirm_delete_submit($form, &$form_state) {
webmaster@1:   taxonomy_del_term($form_state['values']['tid']);
webmaster@1:   drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_state['values']['name'])));
webmaster@1:   watchdog('content', 'forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_state['values']['name']));
webmaster@1: 
webmaster@1:   $form_state['redirect'] = 'admin/content/forum';
webmaster@1:   return;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Form builder for the forum settings page.
webmaster@1:  *
webmaster@1:  * @see system_settings_form()
webmaster@1:  */
webmaster@1: function forum_admin_settings() {
webmaster@1:   $form = array();
webmaster@1:   $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
webmaster@1:   $form['forum_hot_topic'] = array('#type' => 'select',
webmaster@1:     '#title' => t('Hot topic threshold'),
webmaster@1:     '#default_value' => variable_get('forum_hot_topic', 15),
webmaster@1:     '#options' => $number,
webmaster@1:     '#description' => t('The number of posts a topic must have to be considered "hot".'),
webmaster@1:   );
webmaster@1:   $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
webmaster@1:   $form['forum_per_page'] = array('#type' => 'select',
webmaster@1:     '#title' => t('Topics per page'),
webmaster@1:     '#default_value' => variable_get('forum_per_page', 25),
webmaster@1:     '#options' => $number,
webmaster@1:     '#description' => t('Default number of forum topics displayed per page.'),
webmaster@1:   );
webmaster@1:   $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4 => t('Posts - least active first'));
webmaster@1:   $form['forum_order'] = array('#type' => 'radios',
webmaster@1:     '#title' => t('Default order'),
webmaster@1:     '#default_value' => variable_get('forum_order', '1'),
webmaster@1:     '#options' => $forder,
webmaster@1:     '#description' => t('Default display order for topics.'),
webmaster@1:   );
webmaster@1:   return system_settings_form($form);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns an overview list of existing forums and containers
webmaster@1:  */
webmaster@1: function forum_overview(&$form_state) {
webmaster@1:   module_load_include('inc', 'taxonomy', 'taxonomy.admin');
webmaster@1: 
webmaster@1:   $vid = variable_get('forum_nav_vocabulary', '');
webmaster@1:   $vocabulary = taxonomy_vocabulary_load($vid);
webmaster@1:   $form = taxonomy_overview_terms($form_state, $vocabulary);
webmaster@1:   drupal_set_title('Forums');
webmaster@1: 
webmaster@1:   foreach (element_children($form) as $key) {
webmaster@1:     if (isset($form[$key]['#term'])) {
webmaster@1:       $term = $form[$key]['#term'];
webmaster@1:       $form[$key]['view']['#value'] = l($term['name'], 'forum/'. $term['tid']);
webmaster@1:       if (in_array($form[$key]['#term']['tid'], variable_get('forum_containers', array()))) {
webmaster@1:         $form[$key]['edit']['#value'] = l(t('edit container'), 'admin/content/forum/edit/container/'. $term['tid']);
webmaster@1:       }
webmaster@1:       else {
webmaster@1:         $form[$key]['edit']['#value'] = l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term['tid']);
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Remove the alphabetical reset.
webmaster@1:   unset($form['reset_alphabetical']);
webmaster@1: 
webmaster@1:   // The form needs to have submit and validate handlers set explicitly.
webmaster@1:   $form['#theme'] = 'taxonomy_overview_terms';
webmaster@1:   $form['#submit'] = array('taxonomy_overview_terms_submit'); // Use the existing taxonomy overview submit handler.
webmaster@1:   $form['#validate'] = array('taxonomy_overview_terms_validate');
webmaster@1:   $form['#empty_text'] = '<em>'. t('There are no existing containers or forums. Containers and forums may be added using the <a href="@container">add container</a> and <a href="@forum">add forum</a> pages.', array('@container' => url('admin/content/forum/add/container'), '@forum' => url('admin/content/forum/add/forum'))) .'</em>';
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns a select box for available parent terms
webmaster@1:  *
webmaster@1:  * @param $tid ID of the term which is being added or edited
webmaster@1:  * @param $title Title to display the select box with
webmaster@1:  * @param $child_type Whether the child is forum or container
webmaster@1:  */
webmaster@1: function _forum_parent_select($tid, $title, $child_type) {
webmaster@1: 
webmaster@1:   $parents = taxonomy_get_parents($tid);
webmaster@1:   if ($parents) {
webmaster@1:     $parent = array_shift($parents);
webmaster@1:     $parent = $parent->tid;
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $parent = 0;
webmaster@1:   }
webmaster@1: 
webmaster@1:   $vid = variable_get('forum_nav_vocabulary', '');
webmaster@1:   $children = taxonomy_get_tree($vid, $tid);
webmaster@1: 
webmaster@1:   // A term can't be the child of itself, nor of its children.
webmaster@1:   foreach ($children as $child) {
webmaster@1:     $exclude[] = $child->tid;
webmaster@1:   }
webmaster@1:   $exclude[] = $tid;
webmaster@1: 
webmaster@1:   $tree = taxonomy_get_tree($vid);
webmaster@1:   $options[0] = '<'. t('root') .'>';
webmaster@1:   if ($tree) {
webmaster@1:     foreach ($tree as $term) {
webmaster@1:       if (!in_array($term->tid, $exclude)) {
webmaster@1:         $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
webmaster@1:       }
webmaster@1:     }
webmaster@1:   }
webmaster@1:   if ($child_type == 'container') {
webmaster@1:     $description = t('Containers are usually placed at the top (root) level, but may also be placed inside another container or forum.');
webmaster@1:   }
webmaster@1:   else if ($child_type == 'forum') {
webmaster@1:     $description = t('Forums may be placed at the top (root) level, or inside another container or forum.');
webmaster@1:   }
webmaster@1: 
webmaster@1:   return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
webmaster@1: }