modules/publishing/publishing.module

<?php

/**
 * @file
 *
 * This module provides support for an article publishing engine. It requires
 * a whole host of tools, and this module itself requires some user customization
 * that can range from very light to Very Serious.
 *
 * This module requires the workflow, views and dashboard modules. 
 */

/**
 * Implementation of hook_help
 */
function publishing_help($section = NULL) {
  if ($section == 'admin/modules#description') {
    return t('Creates a framework to ease content publishing workflow.');
  }
}

/** 
 * Implementation of hook_perm. This module provides a couple of permission
 * flags so that we don't have to actually know much about the roles in
 * use; workflow is mostly roles based, though, so what you need to do
 * here is to add the permission flag to the proper role so that the
 * module can utilize it.
 */
function publishing_perm() {
  return array('publishing author', 'publishing editor');
}

/**
 * Implementation of hook_menu.
 */
function publishing_menu($may_cache) {
  // In the future these pages will be much more user customizable,
  // but that's going to wait for panels 2.
  $items = array();
  if ($may_cache) {
    $items[] = array(
      'path' => 'publishing/author',
      'title' => t('author dashboard'),
      'callback' => 'publishing_author_page',
      'access' => user_access('publishing author'),
    );
    $items[] = array(
      'path' => 'publishing/editor',
      'title' => t('editor dashboard'),
      'callback' => 'publishing_editor_page',
      'access' => user_access('publishing editor'),
    );
  }
  return $items;
}

/**
 * implementation of hook_settings
 */
function publishing_settings() {
  $result = db_query("SELECT s.sid, s.state, w.name FROM {workflow_states} s INNER JOIN {workflows} w ON w.wid = s.wid ORDER BY w.name");
  while ($state = db_fetch_object($result)) {
    $options[$state->name][$state->sid] = $state->state;
  }
  $options[-1] = t('No state');

  $result = db_query("SELECT wid, name FROM {workflows} ORDER BY name");
  while ($workflow = db_fetch_object($result)) {
    $workflows[$workflow->wid] = $workflow->name;
  }
  $workflows[-1] = t('No workflow');

  $result = db_query("SELECT type FROM {workflow_type_map} WHERE wid = %d", variable_get('publishing_workflow_wid', -1));
  while ($workflow = db_fetch_object($result)) {
    $node_types .= ($node_types ? ', ' : '') . $workflow->type;
  }

  $result = db_query("SELECT r.rid, r.name FROM {role} r ORDER BY r.name");
  while ($obj = db_fetch_object($result)) {
    $rids[$obj->rid] = $obj->name;
  }

  $rids[-1] = t('No role');

  $form['markup'] = array(
    '#value' => t('<p>The publishing module needs a workflow with some minimum settings, and at least two roles. If you already have these in your system, simply select them below. Or click the appropriate buttons to have the publishing module create them for you.</p>'),
  );

  $form['roles'] = array(
    '#type' => 'fieldset',
    '#title' => t('Roles'),
  );
  $form['roles']['publishing_role_editor'] = array(
    '#type' => 'select',
    '#title' => t('Editor role'),
    '#description' => t('Select the role to which you have assigned the editor permission.'),
    '#default_value' => variable_get('publishing_role_editor', -1),
    '#options' => $rids,
  );

  $form['roles']['publishing_role_author'] = array(
    '#type' => 'select',
    '#title' => t('Author role'),
    '#description' => t('Select the role to which you have assigned the author permission.'),
    '#default_value' => variable_get('publishing_role_author', -1),
    '#options' => $rids,
  );

  $form['roles']['role_text'] = array(
    '#value' => t('<p>Click here to create roles for this purpose if they do not already exist on your system. Do not click this just to save changes; click save configuration, below, for that.</p>'),
  );

  $form['roles']['role_button'] = array(
    '#type' => 'button',
    '#value' => t('Create roles'),
  );

  if (in_array('article editor', $rids)) {
    $form['roles']['role_button']['#attributes'] = array('disabled' => TRUE);
    $form['roles']['role_explanation'] = array('#value' => t('<p>The create button is disabled because you appear to already have these roles; if this is not true, you will need to remove or rename the "article editor" role that already exists.</p>'));
  }

  $form['workflow'] = array(
    '#type' => 'fieldset',
    '#title' => t('Workflow'),
  );

  $form['workflow']['text'] = array(
    '#value' => t('<p>The basic workflow creates documents along the following path:</p><ol><li><b>Draft</b> -- Drafts are created by users but not submitted to the system. Their primary value is for letting authors start content and continue it later if they need to. When an author is ready, the author can change the state to <b>Review</b></li><li><b>Review</b> -- When an article has been submitted for review, editors are allowed to peruse the document, make changes if necessary, and either send it back for rework or publish it.</li><li><b>Rework</b> -- Articles in rework have been essentially rejected and remain this way until the author once again submits the article for review.</li><li><b>Published</b> -- Published articles are now ready to be given to consumers. You should use Views to ensure that content available on the system respects the workflow published field.</li></ol><p>Please be sure that the roles listed above have been created.'),
  );

  $form['workflow']['publishing_workflow_wid'] = array(
    '#type' => 'select',
    '#title' => t('Publishing workflow'),
    '#description' => t('Select the workflow that the publishing module will use.'),
    '#default_value' => variable_get('publishing_workflow_wid', -1),
    '#options' => $workflows,
  );

  if ($node_types) {
    $form['workflow']['node_types'] = array(
      '#value' => t('This workflow is currently used on the following node types: %nodes', array('%nodes' => $node_types)),
     );
  }
  else {
    $form['workflow']['node_types'] = array(
      '#value' => t('This workflow is currently not used on any node types.'),
    );
  }
  $form['workflow']['publishing_workflow_draft'] = array(
    '#type' => 'select',
    '#title' => t('Draft state'),
    '#description' => t('Select the workflow state that corresponds to the draft state.'),
    '#default_value' => variable_get('publishing_workflow_draft', -1),
    '#options' => $options,
  );

  $form['workflow']['publishing_workflow_review'] = array(
    '#type' => 'select',
    '#title' => t('Review state'),
    '#description' => t('Select the workflow state that corresponds to the review state.'),
    '#default_value' => variable_get('publishing_workflow_review', -1),
    '#options' => $options,
  );
  
  $form['workflow']['publishing_workflow_rework'] = array(
    '#type' => 'select',
    '#title' => t('Rework state'),
    '#description' => t('Select the workflow state that corresponds to the rework state.'),
    '#default_value' => variable_get('publishing_workflow_rework', -1),
    '#options' => $options,
  );

  $form['workflow']['publishing_workflow_published'] = array(
    '#type' => 'select',
    '#title' => t('Published state'),
    '#description' => t('Select the workflow state that corresponds to the published state.'),
    '#default_value' => variable_get('publishing_workflow_published', -1),
    '#options' => $options,
  );

  $form['workflow']['workflow_text'] = array(
    '#value' => t('<p>Click here to create a basic workflow for this purpose it does not already exist on your system. Do not click this just to save changes; click save configuration, below, for that.</p>'),
  );

  $form['workflow']['workflow_button'] = array(
    '#type' => 'button',
    '#value' => t('Create workflow'),
  );

  $wid = db_result(db_query("SELECT wid FROM {workflows} WHERE name = '%s'",  t('Publishing Module Workflow')));
  if ($wid) {
    $form['workflow']['workflow_button']['#attributes'] = array('disabled' => TRUE);
    $form['workflow']['workflow_explanation'] = array('#value' => t('<p>The create button is disabled because you appear to already have the proper workflow; if this is not true, you will need to remove or rename the "Publishing Module Workflow" workflow that already exists.</p>'));

  }
  $form['#process'] = array('publishing_create' => array());

  return $form;
}

function publishing_create($form) {
  if ($_POST['op'] == t('Create roles')) {
    publishing_create_roles();
  }
  elseif ($_POST['op'] == t('Create workflow')) {
    publishing_create_workflow();
  }

  return $form;
}

function publishing_create_roles() {
  $result = db_result(db_query("SELECT MAX(rid) FROM {role}"));
  $editor = ++$result;
  variable_set('publishing_role_editor', $editor);
  $author = ++$result;
  variable_set('publishing_role_author', $author);
  db_query("INSERT INTO {role} (name, rid) VALUES ('%s', %d), ('%s', %d)", t('article editor'), $editor, t('article author'), $author);
  db_query("INSERT INTO {permission} (rid, perm) VALUES (%d, 'publishing editor'), (%d, 'publishing author')", $editor, $author);
  drupal_set_message('New roles created.');
  drupal_goto($_GET['q']);
}

function publishing_create_workflow() {
  // Note: This should just be workflow_create() but workflow_create()
  // does not return the $wid.
  $wid = db_next_id('{workflows}_wid');
  $name = t('Publishing Module Workflow');

  $editor = variable_get('publishing_role_editor', -1);
  $author = variable_get('publishing_role_author', -1);
  if ($editor == -1 || $author == -1) {
    drupal_set_message(t('Please be sure editor and author roles are set up before creating a workflow.'));
  }

  db_query("INSERT INTO {workflows} (wid, name, tab_roles) VALUES (%d, '%s', '%s')", $wid, $name, $author . ',' . $editor);
  db_query("INSERT INTO {workflow_states} (sid, wid, state, sysid) VALUES (%d, %d, '%s', %d)",
    $creation = db_next_id('{workflow_states}_sid'), $wid, t('(creation)'), WORKFLOW_CREATION);

  variable_set('publishing_workflow_wid', $wid);

  variable_set('publishing_workflow_draft', $draft = workflow_state_create($wid, t('Draft')));
  variable_set('publishing_workflow_review', $review = workflow_state_create($wid, t('Review')));
  variable_set('publishing_workflow_rework', $rework = workflow_state_create($wid, t('Rework')));
  variable_set('publishing_workflow_published', $published = workflow_state_create($wid, t('Published')));
  
  workflow_transition_add_role($creation, $draft, $author);
  workflow_transition_add_role($draft, $review, $author);
  workflow_transition_add_role($review, $rework, $editor);
  workflow_transition_add_role($review, $published, $editor);
  workflow_transition_add_role($published, $review, $editor);
  workflow_transition_add_role($rework, $review, $author);

  drupal_set_message('Workflow created');
}

function theme_publishing_box($content, $title = NULL, $id = NULL) {
  if ($id) {
    $id = "id=\"$id\"";
  }
  $output = "<div class=\"publishing-box\" $id>";
  if ($title) {
    $output .= "<h2>$title</h2>";
  }
  $output .= $content;
  $output .= '</div>';
  return $output;
}

/**
 * Help authors and editors out by adding some information to the node
 * views
 */
function publishing_nodeapi(&$node, $op, $teaser, $page) {
  if ($op == 'view' && $page) {
    switch ($node->_workflow) {
      case variable_get('publishing_workflow_draft', -1):
        $node->body = theme('publishing_text_draft', $node) . $node->body;
        break;
      case variable_get('publishing_workflow_review', -1):
        $node->body = theme('publishing_text_review', $node) . $node->body; 
        break;
      case variable_get('publishing_workflow_rework', -1):
        $node->body = theme('publishing_text_rework', $node) . $node->body; 
        break;
    }
  }
}

function theme_publishing_text_draft($node) {
  theme_add_style(drupal_get_path('module', 'publishing') . '/publishing.css');
  $output = '<div class="publishing-node-box">';
  $output .= t('This %type submission is currently a <b>draft</b>. In order to submit this for review, go to the %link tab, set the state to <b>Review</b> and click Submit!', array('%type' => $node->type, '%link' => l('workflow', "node/$node->nid/workflow")));
  $output .= '</div>';

  return $output;
}

function theme_publishing_text_review($node) {
  theme_add_style(drupal_get_path('module', 'publishing') . '/publishing.css');
  $output = '<div class="publishing-node-box">';
  $output .= t('This %type submission is currently up for review. From the %link tab, you may set <b>publish</b> this post or send it back for <b>rework</b>! If you send it back for rework, please provide a comment!', array('%type' => $node->type, '%link' => l('workflow', "node/$node->nid/workflow")));
  $output .= '</div>';

  return $output;
}

function theme_publishing_text_rework($node) {
  theme_add_style(drupal_get_path('module', 'publishing') . '/publishing.css');
  $output = '<div class="publishing-node-box">';
  $output .= t('This %type submission has been sent back for <b>rework</b>. In order to submit this for review, go to the %link tab, set the state to <b>Review</b> and click Submit! From this tab you can also see any comments the editor made when sending this post back for rework', array('%type' => $node->type, '%link' => l('workflow', "node/$node->nid/workflow")));
  $output .= '</div>';

  return $output;
}

/**
 * Provide a page for an author to see a list of drafts, a list of articles
 * back for review. The panel is highly customizable and should be
 * tailored to your individual needs. Task lists are a good one, and
 * links to an author forum for collaboration are another good one.
 */
function publishing_author_page() {
  // get all node types that can be added. You probably want to just
  // tailor this list to things that matter to authors, since this
  // will get crud like project issues and forums and other stuff
  // if you have that.

  $result = db_query("SELECT type FROM {workflow_type_map} WHERE wid = %d", variable_get('publishing_workflow_wid', 0));
  while ($workflow = db_fetch_object($result)) {
    $node_types[$workflow->type] = $workflow->type;
  }
  
  foreach (node_get_types() as $type => $name) {
    if ($node_types[$type] && module_invoke(node_get_base($type), 'access', 'create', $type)) {
      $menu_items[] = l("Submit $name", "node/add/$type", array('title' => t('Add a new %s.', array('%s' => $name))));
    }
  }
  
  $menu = theme('publishing_box', theme('item_list', $menu_items), t('Author Menu'), 'author-menu');
  $drafts = views_build_view('block', views_get_view('publishing_bystate_mine'), array(variable_get('publishing_workflow_draft', -1)), false, 10);

  $rework = views_build_view('block', views_get_view('publishing_bystate_mine'), array(variable_get('publishing_workflow_rework', -1)), false, 10);
  $review = views_build_view('block', views_get_view('publishing_bystate_mine'), array(variable_get('publishing_workflow_review', -1)), false, 10);
  $left = $menu . theme('publishing_box', $drafts, t('My Drafts'), 'drafts');

  $right = theme('publishing_box', $rework, t('Back for Rework'), 'rework');
  $right .= theme('publishing_box', $review, t('Up for Review'), 'review');

  return  panels_print_layout('twocol', array('left' => $left, 'right' => $right));
//  return theme('dashboard', 'author', $left, $right);
}

function publishing_editor_page() {
  $menu = theme('publishing_box', theme('item_list', $menu_items), t('Author Menu'), 'menu');
  $drafts = views_build_view('block', views_get_view('publishing_bystate'), array(variable_get('publishing_workflow_draft', -1)), false, 10);

  $rework = views_build_view('block', views_get_view('publishing_bystate'), array(variable_get('publishing_workflow_rework', 4)), false, 10);
  $review = views_build_view('block', views_get_view('publishing_bystate'), array(variable_get('publishing_workflow_review', 3)), false, 20);

  $right = theme('publishing_box', $drafts, t('All Drafts'), 'drafts');

  $right .= theme('publishing_box', $rework, t('Back for Rework'), 'rework');
  $left = theme('publishing_box', $review, t('Up for Review'), 'review');

  return panels_print_layout('twocol', array('left' => $left, 'right' => $right));
//  return theme('dashboard', 'author', $left, $right);
}

/**
 * hunmonk's module dependency check: see http://drupal.org/node/54463
 */
function publishing_form_alter($form_id, &$form) {
  if ($form_id == 'system_modules' && !$_POST) {
    publishing_system_module_validate($form);
  }
}

/**
 * hunmonk's module dependency check: see http://drupal.org/node/54463
 */
function publishing_system_module_validate(&$form) {
  $module = 'publishing';
  $dependencies = array('views', 'workflow', 'panels');
  foreach ($dependencies as $dependency) {
      if (!in_array($dependency, $form['status']['#default_value'])) {
        $missing_dependency = TRUE;
        $missing_dependency_list[] = $dependency;
      }
  }
  if (in_array($module, $form['status']['#default_value']) && isset($missing_dependency)) {
    db_query("UPDATE {system} SET status = 0 WHERE type = 'module' AND name = '%s'", $module);
    $key = array_search($module, $form['status']['#default_value']);
    unset($form['status']['#default_value'][$key]);
    drupal_set_message(t('The module %module was deactivated--it requires the following disabled/non-existant modules to function properly: %dependencies', array('%module' => $module, '%dependencies' => implode(', ', $missing_dependency_list))), 'error');
  }
}

/**
 * Provide our default views.
 */

function publishing_views_default_views() {
  $view = new stdClass();
  $view->name = 'publishing_bystate_mine';
  $view->description = t('Lists nodes in the given workflow state for the logged in user.');
  $view->page = TRUE;
  $view->page_title = 'Publishing by state';
  $view->page_header = '';
  $view->page_header_format = '1';
  $view->page_empty = t('No articles.');
  $view->page_empty_format = '1';
  $view->page_type = 'teaser';
  $view->url = 'publishing/mine';
  $view->use_pager = TRUE;
  $view->nodes_per_page = '10';
  $view->block = TRUE;
  $view->block_title = t('Workflow states');
  $view->block_header = '';
  $view->block_header_format = '1';
  $view->block_type = 'list';
  $view->nodes_per_block = '10';
  $view->block_more = '1';
  $view->block_use_page_header = FALSE;
  $view->block_use_page_empty = TRUE;
  $view->menu_title = t('My workflows');

  $view->sort = array (
    array (
      'tablename' => 'node',
      'field' => 'created',
      'sortorder' => 'DESC',
      'options' => '',
    ),
  );
  $view->argument = array (
    array (
      'type' => 'workflow_state',
      'argdefault' => '4',
      'title' => t('Publishing: %1'),
      'options' => '',
    ),
  );
  $view->field = array (
    array (
      'tablename' => 'node',
      'field' => 'title',
      'label' => '',
      'handler' => 'views_handler_field_nodelink',
    ),
    array (
      'tablename' => 'node',
      'field' => 'created',
      'label' => '',
      'handler' => 'views_handler_field_date_small',
    ),
  );
  $view->filter = array (
    array (
      'tablename' => 'node',
      'field' => 'currentuid',
      'operator' => '=',
      'options' => '',
      'value' => '***CURRENT_USER***',
    ),
  );
  $view->requires = array(node);
  $views[$view->name] = $view;

  $view = new stdClass();
  $view->name = 'publishing_bystate';
  $view->description = t('Lists nodes in the given workflow state.');
  $view->access = array (
);
  $view->page = TRUE;
  $view->page_title = t('Workflow states');
  $view->page_header = '';
  $view->page_header_format = '1';
  $view->page_empty = t('No articles.');
  $view->page_empty_format = '1';
  $view->page_type = 'teaser';
  $view->url = 'publishing/all';
  $view->use_pager = TRUE;
  $view->nodes_per_page = '10';
  $view->block = TRUE;
  $view->block_title = t('Workflow states');
  $view->block_header = '';
  $view->block_header_format = '1';
  $view->block_type = 'list';
  $view->nodes_per_block = '10';
  $view->block_more = '1';
  $view->block_use_page_header = FALSE;
  $view->block_use_page_empty = TRUE;
  $view->menu_title = t('workflows');
  $view->sort = array (
    array (
      'tablename' => 'node',
      'field' => 'created',
      'sortorder' => 'DESC',
      'options' => '',
    ),
  );
  $view->argument = array (
    array (
      'type' => 'workflow_state',
      'argdefault' => '4',
      'title' => t('Publishing: %1'),
      'options' => '',
    ),
  );
  $view->field = array (
    array (
      'tablename' => 'node',
      'field' => 'title',
      'label' => '',
      'handler' => 'views_handler_field_nodelink',
    ),
    array (
      'tablename' => 'node',
      'field' => 'created',
      'label' => '',
      'handler' => 'views_handler_field_date_small',
    ),
    array (
      'tablename' => 'users',
      'field' => 'name',
      'label' => '',
    ),
  );
  $view->filter = array (
  );
  $view->requires = array(node, users);
  $views[$view->name] = $view;

  return $views;
}