You are here

bueditor.admin.inc in BUEditor 6

File

bueditor.admin.inc
View source
<?php

/**
 * Admin main page.
 */
function bueditor_admin() {
  $editors = bueditor_editors('all');
  $header = array(
    t('Editor name'),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  $rows = array();
  foreach ($editors as $eid => $editor) {
    $rows[] = array(
      $editor->name,
      l(t('Edit'), 'admin/settings/bueditor/' . $eid),
      l(t('Delete'), 'admin/settings/bueditor/' . $eid . '/delete'),
    );
  }
  $rows[] = array(
    '',
    array(
      'data' => l(t('Add new editor'), 'admin/settings/bueditor/new'),
      'colspan' => 2,
    ),
  );
  $output = '<h2 class="title">' . t('Available editors') . '</h2>';
  $output .= theme('table', $header, $rows);
  $output .= drupal_get_form('bueditor_admin_form');
  return $output;
}

/**
 * Admin form.
 */
function bueditor_admin_form($form_state) {
  $form['roles'] = array(
    '#tree' => TRUE,
  );
  $roles = bueditor_sorted_roles();
  $form['#weighted'] = count($roles) > 3;

  //user#1
  if ($GLOBALS['user']->uid == 1) {
    $u1 = array(
      'name' => t('user #1'),
      'weight' => t('n/a'),
      'editor' => variable_get('bueditor_user1', 1),
      'alt' => variable_get('bueditor_user1_alt', 0),
    );
    $form['roles']['u1'] = bueditor_role_form($u1, $form['#weighted'], 1);
  }

  //other roles
  foreach ($roles as $rid => $role) {
    $core = $rid == DRUPAL_ANONYMOUS_RID || $rid == DRUPAL_AUTHENTICATED_RID;
    $form['roles'][$rid] = bueditor_role_form($role, $form['#weighted'], $core);
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  $form['#submit'][] = 'bueditor_admin_submit';
  $form['#theme'] = 'bueditor_admin';
  return $form;
}

/**
 * Admin form themed.
 */
function bueditor_admin_theme($form = array()) {
  $header = array(
    t('User role'),
    t('Assigned editor'),
    t('Alternative editor'),
  );
  $keys = array(
    'name',
    'editor',
    'alt',
  );
  $info = '';
  if ($form['#weighted']) {
    $header[] = t('Weight');
    $keys[] = 'weight';
    $info = '<br />' . t('For users who have <strong>multiple roles</strong>, <strong>weight</strong> property will determine the assigned editor. Lighter roles that are placed upper will take the precedence. So, an administrator role should be placed over other roles by having a smaller weight, ie. -10.');
  }
  $rows = array();
  foreach (element_children($form['roles']) as $rid) {
    $cells = array();
    foreach ($keys as $key) {
      $cells[] = drupal_render($form['roles'][$rid][$key]);
    }
    $rows[] = $cells;
  }
  $output = '<h2 class="title">' . t('Role-editor assignments') . '</h2>';
  $output .= theme('table', $header, $rows);
  $output .= '<div class="form-item"><div class="description">' . t('Assign editors to user roles.') . '<br />' . t('Alternative editor makes it possible to use different editors for different textareas or different editors on diffrent pages. You just have to configure visibility settings for each editor.') . $info . '</div></div>';
  $output .= drupal_render($form);
  return $output;
}

/**
 * Admin form submit.
 */
function bueditor_admin_submit($form, &$form_state) {
  $roles = $form_state['values']['roles'];
  $roles[DRUPAL_ANONYMOUS_RID]['weight'] = 12;
  $roles[DRUPAL_AUTHENTICATED_RID]['weight'] = 11;
  if ($GLOBALS['user']->uid == 1 && isset($roles['u1'])) {
    variable_set('bueditor_user1', $roles['u1']['editor']);
    variable_set('bueditor_user1_alt', $roles['u1']['alt']);
    unset($roles['u1']);
  }
  if (count($roles) > 3) {
    uasort($roles, 'bueditor_rolesort');
  }
  variable_set('bueditor_roles', $roles);
  drupal_set_message(t('Changes have been saved.'));
}

/**
 * Role-editor form
 */
function bueditor_role_form($role, $weight = TRUE, $core = TRUE) {
  $form['name'] = array(
    '#type' => 'markup',
    '#value' => $role['name'],
  );
  if ($weight) {
    $form['weight'] = $core ? array(
      '#type' => 'markup',
      '#value' => $role['weight'],
    ) : array(
      '#type' => 'weight',
      '#default_value' => $role['weight'],
    );
  }
  $form['editor'] = array(
    '#type' => 'select',
    '#options' => bueditor_editor_options(),
    '#default_value' => $role['editor'],
  );
  $form['alt'] = array(
    '#type' => 'select',
    '#options' => bueditor_editor_options(),
    '#default_value' => $role['alt'],
  );
  return $form;
}

/**
 * Editor options.
 */
function bueditor_editor_options() {
  static $options;
  if (!isset($options)) {
    $options = array(
      0 => t('none'),
    );
    foreach (bueditor_editors('all') as $eid => $editor) {
      $options[$eid] = $editor->name;
    }
  }
  return $options;
}

/**
 * Template form for buttons
 */
function bueditor_button_form($button = NULL, $icons = array()) {
  $button = (object) ($button ? $button : array(
    'title' => '',
    'content' => '',
    'icon' => '',
    'accesskey' => '',
    'weight' => 0,
  ));
  $form = array();
  $form['title'] = array(
    '#type' => 'textfield',
    '#default_value' => $button->title,
    '#size' => 14,
  );
  $form['content'] = array(
    '#type' => 'textarea',
    '#default_value' => $button->content,
    '#rows' => min(6, max(2, substr_count($button->content, "\n") + 1)),
  );
  $form['icon'] = array(
    '#type' => 'select',
    '#options' => array(
      '' => t('Caption'),
    ) + $icons,
    '#default_value' => $button->icon,
  );
  $form['caption'] = array(
    '#type' => 'textfield',
    '#default_value' => bueditor_isimage($button->icon) ? '' : $button->icon,
    '#size' => 6,
  );
  $form['accesskey'] = array(
    '#type' => 'textfield',
    '#default_value' => $button->accesskey,
    '#size' => 2,
    '#maxlength' => 1,
  );
  $form['weight'] = array(
    '#type' => 'weight',
    '#default_value' => $button->weight ? $button->weight : 0,
  );
  return $form;
}

/**
 * Editor form.
 */
function bueditor_editor_form($form_state, $editor = NULL) {
  $editor = (object) ($editor ? $editor : array(
    'eid' => '',
    'name' => '',
    'pages' => "node/*\ncomment/*",
    'excludes' => 'edit-log',
    'iconpath' => '%BUEDITOR/icons',
    'librarypath' => '%BUEDITOR/library',
  ));
  $form = array(
    '#cache' => TRUE,
    '#tree' => TRUE,
    '#theme' => 'bueditor_editor',
    '#attributes' => array(
      'enctype' => 'multipart/form-data',
    ),
  );
  $form['editor']['eid'] = array(
    '#type' => 'hidden',
    '#value' => $editor->eid,
  );
  $form['editor']['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Editor name'),
    '#maxlength' => 255,
    '#default_value' => $editor->name,
    '#required' => TRUE,
  );
  $form['editor']['pages'] = array(
    '#type' => 'textarea',
    '#title' => t('Show the editor on specific pages'),
    '#default_value' => $editor->pages,
    '#description' => t('Enter one page per line as Drupal paths. The * character is a wildcard.'),
  );
  $form['editor']['excludes'] = array(
    '#type' => 'textarea',
    '#title' => t('Hide the editor for specific textareas'),
    '#default_value' => $editor->excludes,
    '#description' => t('Enter one textarea ID per line. The * character is a wildcard.'),
  );
  $form['editor']['iconpath'] = array(
    '#type' => 'textfield',
    '#title' => t('Directory of editor icons'),
    '#maxlength' => 255,
    '#default_value' => $editor->iconpath,
    '#description' => t('Web accessible directory path where editor icons reside.') . ' ' . t('Placeholders that you can use are; %BUEDITOR (bueditor path), %FILES (drupal files path), and %THEME (current theme\'s path).'),
  );
  $form['editor']['librarypath'] = array(
    '#type' => 'textfield',
    '#title' => t('Directory of editor library'),
    '#maxlength' => 255,
    '#default_value' => $editor->librarypath,
    '#description' => t('Web accessible directory path where external javascript files reside.') . ' ' . t('Placeholders that you can use are; %BUEDITOR (bueditor path), %FILES (drupal files path), and %THEME (current theme\'s path).'),
  );

  //buttons
  $icons = bueditor_icons(bueditor_path_tr($form['editor']['iconpath']['#default_value']));
  foreach (bueditor_buttons($editor->eid) as $bid => $button) {
    $form['buttons'][$bid] = bueditor_button_form($button, $icons);
    $form['checks'][$bid] = array(
      '#type' => 'checkbox',
    );
  }

  //imported buttons are previewed. not saved yet.
  if (isset($_SESSION['buecsv']) && ($csvpath = $_SESSION['buecsv'])) {
    $import = bueditor_import_buttons($csvpath);
    for ($i = 0; $button = $import[$i]; $i++) {
      $form['buttons']['new' . $i] = bueditor_button_form($button, $icons);
    }
    drupal_set_message($i > 0 ? t('New buttons are ready to be saved.') : t('There is no button to be imported.'));
    unset($_SESSION['buecsv']);
  }

  //there is always a new button.
  $form['buttons']['new'] = bueditor_button_form(NULL, $icons);

  //action for selected buttons
  $form['selaction'] = array(
    '#type' => 'select',
    '#options' => array(
      '' => t('... selecteds'),
      'delete' => t('Delete'),
      'export' => t('Export'),
    ),
  );
  $form['go'] = array(
    '#type' => 'submit',
    '#value' => t('Go'),
    '#submit' => array(
      'bueditor_selaction_submit',
    ),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
    '#submit' => array(
      'bueditor_editor_submit',
    ),
  );
  $form['buecsv'] = array(
    '#type' => 'file',
    '#title' => t('CSV file containing the buttons'),
  );
  $form['import'] = array(
    '#type' => 'submit',
    '#value' => t('Import'),
    '#submit' => array(
      'bueditor_csv_submit',
    ),
  );
  return $form;
}

/**
 * Editor form themed.
 */
function bueditor_editor_theme($form = array()) {
  $header = array(
    array(
      'data' => t('Title'),
      'class' => 'btitle',
    ),
    array(
      'data' => t('Content'),
      'class' => 'content',
    ),
    array(
      'data' => t('Icon'),
      'class' => 'icon',
    ),
    array(
      'data' => t('Key'),
      'class' => 'key',
    ),
    array(
      'data' => t('Weight'),
      'class' => 'weight',
    ),
    theme('table_select_header_cell'),
  );
  $rows = array();
  foreach (element_children($form['buttons']) as $bid) {
    $new = !is_numeric($bid);
    $cells = array();
    $cells[] = drupal_render($form['buttons'][$bid]['title']);
    $cells[] = drupal_render($form['buttons'][$bid]['content']);
    $cells[] = drupal_render($form['buttons'][$bid]['icon']) . drupal_render($form['buttons'][$bid]['caption']);
    $cells[] = drupal_render($form['buttons'][$bid]['accesskey']);
    $cells[] = drupal_render($form['buttons'][$bid]['weight']);
    $cells[] = $new ? '<a>' . t('new') . '</a>' : drupal_render($form['checks'][$bid]);
    $rows[] = $new ? array(
      'data' => $cells,
      'class' => 'new-button',
      'title' => t('Add new button'),
    ) : $cells;
  }
  $eid = $form['editor']['eid']['#value'];
  $path = drupal_get_path('module', 'bueditor');
  drupal_add_css($path . '/admin/admin.css', 'media', 'all', FALSE);

  //no preprocessing
  drupal_add_js($path . '/admin/admin.js', 'module', 'header', FALSE, TRUE, FALSE);

  //no preprocessing
  drupal_add_js('var iconPath = "' . base_path() . bueditor_path_tr($form['editor']['iconpath']['#value']) . '"', 'inline');
  $help = '<div class="help">' . t('To add a new button, you can either specify it at the bottom of the button list or import a CSV file which contains previously exported buttons. For more information about buttons and editor API please read !readme.', array(
    '!readme' => '<a href="' . base_path() . $path . '/README.txt">README.txt</a>',
  )) . '</div>';
  $buttons = theme('table', $header, $rows, array(
    'class' => 'button-table',
    'id' => 'button-table',
  ));
  $selaction = '<div class="sel-action">' . drupal_render($form['selaction']) . drupal_render($form['go']) . '</div>';
  $visibility = theme('fieldset', array(
    '#title' => t('Visibility settings'),
    '#children' => drupal_render($form['editor']['pages']) . drupal_render($form['editor']['excludes']),
    '#collapsible' => TRUE,
    '#collapsed' => $eid,
  ));
  $paths = theme('fieldset', array(
    '#title' => t('Editor paths'),
    '#children' => drupal_render($form['editor']['iconpath']) . drupal_render($form['editor']['librarypath']),
    '#collapsible' => TRUE,
    '#collapsed' => $eid,
  ));
  $import = theme('fieldset', array(
    '#title' => t('Import Buttons'),
    '#children' => drupal_render($form['buecsv']) . drupal_render($form['import']),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  ));
  $demo = '';
  if ($eid && bueditor_settle($eid)) {
    drupal_add_js('BUE.preset["editor-demo"] = "e' . $eid . '";', 'inline');
    $demo = '<h2 class="title">' . t('Demo') . '</h2><div class="form-item"><textarea cols="60" rows="20" id="editor-demo" class="form-textarea">DEMO</textarea></div>';
  }
  $output = $help . drupal_render($form['editor']['name']) . ($eid ? '' : $visibility . $paths);
  $output .= '<h2 class="title">' . t('Buttons') . '</h2>' . $buttons . $selaction;
  $output .= drupal_render($form['submit']) . ($eid ? $visibility . $paths : '');
  $output .= $import . drupal_render($form) . $demo;
  return $output;
}

/**
 * Save editor & buttons.
 */
function bueditor_editor_submit($form, &$form_state) {

  //editor
  $editor = (object) $form_state['values']['editor'];
  $update = $editor->eid ? array(
    'eid',
  ) : array();
  if (SAVED_NEW == drupal_write_record('bueditor_editors', $editor, $update)) {
    drupal_set_message(t('New editor has been added.'));
    $form_state['redirect'] = 'admin/settings/bueditor/' . $editor->eid;
  }

  //buttons
  foreach ($form_state['values']['buttons'] as $bid => $button) {
    if ($button['title']) {
      $button = (object) $button;
      $button->bid = is_numeric($bid) ? $bid : NULL;
      $button->eid = $editor->eid;
      $button->content = str_replace("\r\n", "\n", $button->content);
      $button->icon = $button->icon ? $button->icon : $button->caption;
      $update = $button->bid ? array(
        'bid',
      ) : array();
      drupal_write_record('bueditor_buttons', $button, $update);
    }
  }
  drupal_set_message(t('Changes have been saved.'));
}

/**
 * Export or delete selected buttons.
 */
function bueditor_selaction_submit($form, &$form_state) {
  $bids = array_keys(array_filter($form_state['values']['checks']));
  switch ($form_state['values']['selaction']) {
    case 'delete':
      bueditor_delete_buttons($bids);
      break;
    case 'export':
      bueditor_export_buttons($bids);
      break;
  }
}

/**
 * Save CSV file for import operation.
 */
function bueditor_csv_submit($form, &$form_state) {
  if ($file = file_save_upload('buecsv', array(), file_directory_temp())) {
    $_SESSION['buecsv'] = $file->filepath;
  }
}

/**
 * Editor deletion form. Confirm & delete
 */
function bueditor_delete_form($form_state, $editor) {
  return confirm_form(array(), t('Are you sure you want to delete the editor %name?', array(
    '%name' => $editor->name,
  )), 'admin/settings/bueditor', t('All buttons and settings for this editor will be removed.') . ' ' . t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}
function bueditor_delete_form_submit($form, &$form_state) {
  $editor = $form['#parameters'][2];
  bueditor_delete_editor($editor->eid);
  drupal_set_message(t('%name editor has been deleted.', array(
    '%name' => $editor->name,
  )));

  //update roles
  $roles = variable_get('bueditor_roles', array());
  foreach ($roles as $rid => $role) {
    $roles[$rid]['editor'] = $editor->eid == $role['editor'] ? 0 : $role['editor'];
    $roles[$rid]['alt'] = $editor->eid == $role['alt'] ? 0 : $role['alt'];
  }
  variable_set('bueditor_roles', $roles);
  $form_state['redirect'] = 'admin/settings/bueditor';
}

/**
 * Delete buttons.
 */
function bueditor_delete_buttons($bids = array()) {
  if (!empty($bids)) {
    foreach ($bids as $bid) {
      bueditor_delete_button($bid);
    }
    drupal_set_message(t('Selected buttons have been deleted.'));
  }
}
function bueditor_delete_button($bid) {
  db_query("DELETE FROM {bueditor_buttons} WHERE bid = %d", $bid);
}

/**
 * Delete an editor.
 */
function bueditor_delete_editor($eid) {
  db_query("DELETE FROM {bueditor_buttons} WHERE eid = %d", $eid);
  db_query("DELETE FROM {bueditor_editors} WHERE eid = %d", $eid);
}

/**
 * Export buttons as CSV.
 */
function bueditor_export_buttons($bids = array()) {
  if ($n = count($bids)) {
    $result = db_query("SELECT * FROM {bueditor_buttons} WHERE bid IN (" . str_repeat("%d, ", $n - 1) . "%d) ORDER BY weight, title", $bids);
    while ($button = db_fetch_array($result)) {
      unset($button['bid'], $button['eid']);
      if (!isset($output)) {
        $output = '"' . implode('", "', array_keys($button)) . '"' . "\n";
      }
      $output .= '"' . implode('", "', array_map('addslashes', array_values($button))) . '"' . "\n";
    }
  }
  if (isset($output)) {
    header('Content-type: text/csv; charset=utf-8');
    header('Content-Disposition: attachment; filename=bueditor_buttons.csv');
    print $output;
    exit;
  }
  drupal_set_message(t('There is no button to export.'), 'error');
}

/**
 * Import buttons from a CSV file.
 */
function bueditor_import_buttons($file) {
  $buttons = array();
  if (is_file($file) && ($fp = fopen($file, 'r'))) {
    $fields = fgetcsv($fp, 100000);
    if (in_array('title', $fields)) {
      while ($values = fgetcsv($fp, 100000)) {
        $button = array();
        for ($i = 0; isset($fields[$i]); $i++) {
          $button[$fields[$i]] = stripslashes($values[$i]);
        }
        $buttons[] = $button;
      }
    }
  }
  return $buttons;
}

/**
 * Load icons in the path
 */
function bueditor_icons($path) {
  $icons = array();
  if ($path && ($handle = opendir($path))) {
    while (($file = readdir($handle)) !== FALSE) {
      if (bueditor_isimage($file)) {
        $icons[$file] = $file;
      }
    }
    closedir($handle);
  }
  return $icons;
}

/**
 * Sort roles according to their weights.
 */
function bueditor_sorted_roles() {
  static $sorted;
  if (!isset($sorted)) {
    $sorted = array();
    $roles = user_roles();
    $broles = variable_get('bueditor_roles', array());
    $broles[DRUPAL_ANONYMOUS_RID]['weight'] = 12;
    $broles[DRUPAL_AUTHENTICATED_RID]['weight'] = 11;
    foreach ($roles as $rid => $name) {
      $sorted[$rid] = array(
        'name' => $name,
        'weight' => (int) $broles[$rid]['weight'],
        'editor' => (int) $broles[$rid]['editor'],
        'alt' => (int) $broles[$rid]['alt'],
      );
    }
    uasort($sorted, 'bueditor_rolesort');
  }
  return $sorted;
}

/**
 * user sorting function for roles.
 */
function bueditor_rolesort($r1, $r2) {
  return $r1['weight'] - $r2['weight'];
}

/**
 * check if the icon is image.(just a string check, not a file check)
 */
function bueditor_isimage($text) {
  return preg_match('/\\.(png|gif|jpg)$/i', $text);
}

Functions

Namesort descending Description
bueditor_admin Admin main page.
bueditor_admin_form Admin form.
bueditor_admin_submit Admin form submit.
bueditor_admin_theme Admin form themed.
bueditor_button_form Template form for buttons
bueditor_csv_submit Save CSV file for import operation.
bueditor_delete_button
bueditor_delete_buttons Delete buttons.
bueditor_delete_editor Delete an editor.
bueditor_delete_form Editor deletion form. Confirm & delete
bueditor_delete_form_submit
bueditor_editor_form Editor form.
bueditor_editor_options Editor options.
bueditor_editor_submit Save editor & buttons.
bueditor_editor_theme Editor form themed.
bueditor_export_buttons Export buttons as CSV.
bueditor_icons Load icons in the path
bueditor_import_buttons Import buttons from a CSV file.
bueditor_isimage check if the icon is image.(just a string check, not a file check)
bueditor_rolesort user sorting function for roles.
bueditor_role_form Role-editor form
bueditor_selaction_submit Export or delete selected buttons.
bueditor_sorted_roles Sort roles according to their weights.