modules/copyright/copyright.module

<?php
// $Id: copyright.module,v 1.13.4.25 2007/10/05 15:47:40 robrechtj Exp $

/** Copyright (c) 2004 Matthew Schwartz  <matt at mattschwartz dot net>
    Contributors:
      Dries Buytaert - code from taxonomy.module
      Ber Kessels
      Robrecht Jacques
    
    This file is a contributed module of Drupal.

    Drupal and this module are free software; you can redistribute this file
    and/or modify it under the terms of the GNU General Public License as 
    published by the Free Software Foundation; either version 2 of the License,
    or (at your option) any later version.

    This file is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this file; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/**
 * @file
 * Assign copyright licenses to site and nodes.
 *
 * TODO:
 * - does it not make sense to make copyrights nodes?
 * - check all these cache_clear_all() things - do we need them all?
 * - check whether books works as expected
 * - check whether we've put 'administer copyright' everywhere where needed
 * - proofread and maybe extend documentation (hook_help())
 * - figure out the right way to do 'view license' - this get_local_paths() looks a bit funny
 * - does it makes sense to have a 'admin/configure/view/$cpyid' page for all copyrights?
 * - node copyright block, to be displayed in 'content' region for 'node' pages
 * - are there other content types (eg the 'container' from category.module) that actually warrant the
 *   same treatment as book pages?
 * - document all functions
 */

/**
 * Implementation of hook_help().
 */
function copyright_help($path, $args) {
  switch ($path) {
    case 'admin/content/copyright':
      return t('The copyright module allows you to select a copyright for display on the site and each node.  Some common copyright options are built in.  You also have the option to create your own copyright(s).');

    case 'admin/content/copyright/add':
      return t('Create a new copyright to associate to the site and/or nodes.  Create your own custom license or paste information from common licenses, like those offered by <a href="@commons">Creative Commons</a>.', array('@commons' => 'http://www.creativecommons.org'));

    case 'admin/help#copyright':
      return t('<h3>Copyright and licenses</h3>
<p>All works created in the United States and some other countries are considered to have an exclusive copyright by default, even without a copyright notice present.  But it\'s generally good practice to assign a copyright to a web site by displaying a notice.  You have the option to reserve all rights, put it into the public domain, or provide a variety of licenses which fall between.  For many web sites it\'s often desirable to have different pages licensed in different ways, especially when the content is provided by more than one person or collected from other sources.</p>
<h4>Copyright notices</h4>
<p>When creating notices for the site and pages, the following variables can be inserted (and will be replaced automatcially for display):</p><dl>
<dt>@year</dt><dd>For a node it\'s the year of its creation, for the site it\'s the current year</dd>
<dt>@author</dt><dd>Applicable only to node notices, this is the author of the node or an alternate if specified</dd>
<dt>@site</dt><dd>Name of this Drupal site (currently: %site_name)</dd>
<dt>@source_url</dt><dd>URL to the full license text</dd></dl>', array('%site_name' => variable_get('site_name', 'Drupal')));
  }
}

/**
 * Implementation of hook_perm().
 */
function copyright_perm() {
  return array('administer copyright');
}

/**
 * Implementation of hook_menu().
 */
function copyright_menu() {
  $items = array();

  $items['admin/content/copyright'] = array(
    'title' => 'Copyright',
    'description' => 'Create and manage different copyrights and licenses that users can use.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('copyright_list'),
    'access callback' => 'user_access',
    'access arguments' => array('administer copyright'),
    'file' => 'copyright.admin.inc',
  );

  $items['admin/content/copyright/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

  $items['admin/content/copyright/add'] = array(
    'title' => 'Add copyright',
    'type' => MENU_LOCAL_TASK,
    'weight' => 0,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('copyright_add'),
    'access callback' => 'user_access',
    'access arguments' => array('administer copyright'),
    'file' => 'copyright.admin.inc',
  );

  $items['admin/content/copyright/%copyright/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('copyright_edit', 3),
    'access callback' => 'user_access',
    'access arguments' => array('administer copyright'),
    'file' => 'copyright.admin.inc',
  );

  $items['admin/content/copyright/%copyright/delete'] = array(
    'title' => 'Delete',
    'type' => MENU_CALLBACK,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('copyright_delete', 3),
    'access callback' => 'user_access',
    'access arguments' => array('administer copyright'),
    'file' => 'copyright.admin.inc',
  );

  return $items;
}

/**
 * Implementation of hook_block().
 *
 * NOTE: Maybe in the future have this check if the currently displayed node is using
 * a license other than the site default and display that in its place. The trick would
 * then be to *not* also display the text at the bottom of the node. It needs to be an admin setting.
 */
function copyright_block($op = 'list', $delta = 0) {
  if ($op == 'list') {
    return array(
      'site' => array('info' => t('Site copyright'), 'status' => 1, 'region' => 'footer'),
    );
  }
  else if ($op == 'view') {
    switch ($delta) {
      case 'site':
        $license = copyright_get_license(variable_get('copyright-default', 1));
        break;
    }

    if ($license) {
      drupal_add_css(drupal_get_path('module', 'copyright') .'/copyright.css');
      return array(
        'subject' => t('Copyright'),
        'content' => theme('copyright_block', copyright_notice($license)),
      );
    }
  }
}

/**
 * Implementation of hook_theme().
 */
function copyright_theme() {
  return array(
    'copyright_footer' => array(
      'arguments' => array(
        'license' => NULL,
      ),
    ),
    'copyright_block' => array(
      'arguments' => array(
        'license' => NULL,
      ),
    ),
  );
}

/**
 * Implementation of hook_user().
 */
function copyright_user($op, &$edit, &$account, $category = NULL) {
  switch ($op) {
    case 'categories':
      $items = array();
      $items[] = array(
        'name' => 'copyright',
        'title' => t('License'),
        'weight' => 5,
      );
      return $items;

    case 'form':
      $form = array();
      if ($category == 'copyright') {
        $default = copyright_user_get_default($account->uid);
        $licenses = copyright_get_license_names();

        $form['copyright_user_default'] = array(
          '#type' => 'radios',
          '#title' => t('Default license'),
          '#options' => $licenses,
          '#default_value' => $default,
        );
      }
      return $form;

    case 'delete':
      copyright_user_del_default($account->uid);
      break;

    case 'insert':
    case 'update':
      copyright_user_set_default($account->uid, $edit['copyright_user_default']);
      $edit['copyright_user_default'] = NULL;
      break;
  }
}

/**
 * Implementation of hook_node_operations().
 */
function copyright_node_operations() {
  $operations = array();
  foreach (copyright_get_license_names() as $cpyid => $license) {
    $operations[] = array(
      'label' => t('Assign @name license', array('@name' => $license)),
      'callback' => 'copyright_assign_license',
      'callback arguments' => array($cpyid),
    );
  }
  return $operations;
}

/**
 * Implementation of hook_node_type().
 */
function copyright_node_type($op, $info) {
  switch ($op) {
    case 'delete':
      variable_del('copyright-enable_'. $info->type);
      break;

    case 'update':
      if (!empty($info->old_type) && $info->old_type != $info->type) {
        $setting = variable_get('copyright-enable_'. $info->old_type, 0);
        variable_del('copyright-enable_'. $info->old_type);
        variable_set('copyright-enable_'. $info->type, $setting);
      }
      break;
  }
}

/**
 * Implementation of hook_nodeapi().
 */
function copyright_nodeapi(&$node, $op, $arg = 0) {
  if (variable_get('copyright-enable_'. $node->type, 0)) {
    switch ($op) {
      case 'view':
        $node_license = copyright_get_node_license($node->nid);
        if (!$node_license && $node->parent) {
          // $node->parent set at node load time by book.module
          $node_license = copyright_parent_node($node->parent);
        }
        if ($node_license && $node_license->cpyid != variable_get('copyright-default', 1)) {
          // The node has a license other than the site's default
          $license = copyright_get_license($node_license->cpyid);
          $node->content['copyright'] = array(
            '#value' => theme('copyright_footer', copyright_notice($license, $node, $node_license)),
            '#weight' => 10,
          );
          drupal_add_css(drupal_get_path('module', 'copyright') .'/copyright.css');
        }
        break;

      case 'insert':
      case 'update':
        if (isset($node->cpyid)) {
          copyright_node_save($node->nid, $node->cpyid, $node->copyright_show_children, $node->original_author, $node->copyright_children_allow_set);
        }
        break;

      case 'delete':
        copyright_node_delete($node->nid);
        break;

      case 'load':
        $node_license = (array) copyright_get_node_license($node->nid);
        foreach ($node_license as $key => $value) {
          $node->$key = $value;
        }
        break;
    }
  }
}

/**
 * Implementation of hook_form_alter().
 *
 * - add copyright select box to node edit forms if enabled,
 * - add enable/disable copyright to node workflow settings.
 */
function copyright_form_alter(&$form, $form_state, $form_id) {
  if ($form_id == 'node_type_form' && isset($form['identity']['type'])) {
    $type = $form['#node_type']->type;
    $form['workflow']['copyright-enable'] = array(
      '#type' => 'radios',
      '#title' => t('Allow copyright selection'),
      '#default_value' => variable_get('copyright-enable_'. $type, 0),
      '#options' => array(t('Disabled'), t('Enabled')),
      '#description' => t('Enable the copyright selection for individual nodes of this content type.'),
    );
  }

  if (isset($form['type'])) {
    $node = $form['#node'];
    $type = $node->type;

    // Extending node edit forms.
    if ($form_id == $type .'_node_form' && variable_get('copyright-enable_'. $type, FALSE)) {
      global $user;

      if (($user->uid == $node->uid || user_access('administer copyright')) &&
          (!$node->parent || copyright_parent_allow($node->parent))) {
        $licenses = copyright_get_license_names();
        $site_default = variable_get('copyright-default', 1);
        $user_default = copyright_user_get_default($user->uid);

        foreach ($licenses as $cpyid => $license) {
          $notices = array();
          if ($cpyid == $site_default) {
            $notices[] = t('site default');
          }
          if ($cpyid == $user_default) {
            $notices[] = t('your default');
          }
          if (isset($node->cpyid) && $cpyid == $node->cpyid) {
            $notices[] = t('current license');
          }

          if (count($notices) > 0) {
            $licenses[$cpyid] .= ' ('. implode(', ', $notices) .')';
          }
        }
    
        if ($node->cpyid) {
          $selected_cpyid = $node->cpyid;
          $author = $node->original_author;
        }
        else if ($node_license = copyright_get_node_license($node->nid)) {
          $selected_cpyid = $node_license->cpyid;
          $author = $node_license->original_author;
        }
        else if ($user_default) {
          $selected_cpyid = $user_default;
          $author = '';
        }
        else {
          $selected_cpyid = $site_default;
          $author = '';
        }

        $form['copyright'] = array(
          '#type' => 'fieldset',
          '#title' => t('Copyright'),
          '#collapsible' => TRUE,
          '#collapsed' => TRUE, //TODO: only collapse if there is nothing filled in
        );
        $form['copyright']['cpyid'] = array(
          '#type' => 'select',
          '#title' => t('Copyright'),
          '#default_value' => $selected_cpyid,
          '#options' => $licenses,
          '#description' => t('Select the copyright to use for this node.'),
        );
        $form['copyright']['original_author'] = array(
          '#type' => 'textfield',
          '#title' => t('Original author'),
          '#default_value' => $author,
          '#maxlength' => 255,
          '#description' => t('Copyright owner of this post if other than the poster.'),
        );

        if ($node->type == 'book') {
          $form['copyright']['copyright_show_children'] = array(
            '#type' => 'checkbox',
            '#title' => t('Show this copyright for children (if different than site default).'),
            '#default_value' => ($node_license ? $node_license->children_show_notice : $node->children_show_notice),
          );
          $form['copyright']['copyright_children_allow_set'] = array(
            '#type' => 'checkbox',
            '#title' => t('Allow children to set different copyright or license.'),
            '#default_value' => ($node_license ? $node_license->children_allow_set : $node->children_allow_set),
          );
        }
      }
    }
  }
  return $form;
}

/**
 * Save copyright associated with a given node.
 */
function copyright_node_save($nid, $cpyid, $children_show_notice = 1, $original_author = NULL, $children_allow_set = 1) {
  // If the new copyright setting is being set to the default, delete the association if it exists
  if ($cpyid == variable_get('copyright-default', 1) && !$original_author && $children_allow_set) {
    copyright_node_delete($nid);
  }
  else {
    $license = copyright_get_node_license($nid);
    $original_author = trim($original_author);
    if ($license->cpyid) {
      db_query("UPDATE {copyright_node} SET cpyid = %d, children_show_notice = %d, children_allow_set = %d, original_author = '%s' WHERE nid = %d", $cpyid, $children_show_notice, $children_allow_set, $original_author, $nid);
    }
    else {
      db_query("INSERT INTO {copyright_node} (nid, cpyid, children_show_notice, children_allow_set, original_author) VALUES (%d, %d, %d, %d, '%s')", $nid, $cpyid, $children_show_notice, $children_allow_set, $original_author);
    }
  }
}

/**
 * Assign the same copyright to several nodes.
 */
function copyright_assign_license($nids, $cpyid) {
  foreach ($nids as $nid) {
    copyright_node_save($nid, $cpyid);
  }
}

/**
 * Remove associations of a node to its copyright.
 */
function copyright_node_delete($nid) {
  db_query("DELETE FROM {copyright_node} WHERE nid = %d", $nid);
}

/******************************************************************
 * Database access functions (public).
 ******************************************************************/

/**
 * Return an array of all copyrights/licenses (cpyid and name only)
 */
function copyright_get_license_names() {
  static $licenses;
  if (!isset($licenses)) {
    $result = db_query("SELECT cpyid, name FROM {copyrights} ORDER BY name");
    $licenses = array();
    while ($license = db_fetch_object($result)) {
      $licenses[$license->cpyid] = $license->name;
    }
  }
  return $licenses;
}

/**
 * Return a single copyright/license object
 */
function copyright_get_license($cpyid) {
  $result = db_query("SELECT * FROM {copyrights} WHERE cpyid = %d", $cpyid);
  return db_fetch_object($result);
}

/**
 * Returns an array of all copyright/license objects
 */
function copyright_get_licenses() {
  $result = db_query("SELECT * FROM {copyrights} ORDER BY name");
  $licenses = array();
  while ($license = db_fetch_object($result)) {
    $licenses[$license->cpyid] = $license;
  }
  return $licenses;
}

/**
 * Return details of license and rules associated with a node
 */
function copyright_get_node_license($nid) {
  $result = db_query("SELECT * FROM {copyright_node} WHERE nid = %d", $nid);
  return db_fetch_object($result);
}

/**
 * Return an array of all local paths which will have license pages created by this module
 */
function copyright_get_license_local_paths() {
  //TODO: what is this source_url NOT LIKE '\%' ??
  $result = db_query("SELECT cpyid, name, source_url FROM {copyrights} WHERE source_url NOT LIKE 'http:%' AND source_url NOT LIKE '\%'");
  $licenses = array();
  while ($license = db_fetch_object($result)) {
    $licenses[$license->cpyid] = $license;
  }
  return $licenses;
}

/**
 * Return the copyright_node info of the nearest ancestor book page; NULL if none
 *
 * NOTE: This function relies on the book table (from the book module) existing and working as it has.
 * It's unlikely that a change to the book module would break this, but it's possible.  This function
 * won't be called unless a node to display is of type book, so we don't need to check for the book module's existence.
 * I was going to use the book_location function from book.module but that would double the number of
 * queries executed (after each of its queries I'd have to perform my own).  This is more efficient.
 * Also note we don't check node security because even if the user doesn't
 * have the right to access a parent we still want to show the parent's copyright on this page.
 */
function copyright_from_book_parent($nid_parent) {
  $parent = db_fetch_object(db_query("SELECT n.nid, b.parent, c.cpyid, c.children_show_notice, c.original_author, c.children_allow_set FROM {node} n INNER JOIN {book} b ON n.nid = b.nid LEFT OUTER JOIN {copyright_node} c ON n.nid = c.nid WHERE n.nid = %d", $nid_parent));
  if ($parent->nid) {
    if ($parent->cpyid) {
      // Parent has its own copyright
      return $parent;
    }
    else if ($parent->parent) {
      // Parent doesn't have its own cpyid set, but parent does exist, so look deeper
      return copyright_from_book_parent($parent->parent);
    }
  }
  // If we got here there is no parent, so stop looking
  return NULL;
}

/**
 * Return the copyright_node info of a parent requiring its children show notice; NULL if none
 */
function copyright_parent_node($nid_parent) {
  $parent = copyright_from_book_parent($nid_parent);
  if ($parent->children_show_notice) {
    return $parent;
  }
  else if ($parent->parent) {
    return copyright_parent_node($parent->parent);
  }
  return NULL;
}

/**
 * Return TRUE if ancestors allow setting of copyright
 */
function copyright_parent_allow($nid_parent) {
  $parent = copyright_from_book_parent($nid_parent);
  if ($parent && !$parent->children_allow_set) {
    return FALSE;
  }
  else if ($parent->parent) {
    return copyright_parent_allow($parent->parent);
  }
  // No parent dis-allows, so allow
  return TRUE;
}

/**
 * Save a default copyright for a given user.
 */
function copyright_user_set_default($uid, $cpyid) {
  $default = copyright_user_get_default($uid);
  if ($default !== FALSE) {
    return db_query("UPDATE {copyright_user} SET cpyid = %d WHERE uid = %d", $cpyid, $uid);
  }
  return db_query("INSERT {copyright_user} (cpyid, uid) VALUES (%d, %d)", $cpyid, $uid);
}

/**
 * Delete a default copyright for a given user.
 */
function copyright_user_del_default($uid) {
  return db_query("DELETE FROM {copyright_user} WHERE uid = %d", $uid);
}

/**
 * Get a default copyright for a given user.
 */
function copyright_user_get_default($uid) {
  return db_result(db_query("SELECT cpyid FROM {copyright_user} WHERE uid = %d", $uid));
}

/******************************************************************
 * Display functions (output text and themes).
 ******************************************************************/

/**
 * Return HTML for display of a copyright notice.
 */
function copyright_notice($license, $node = NULL, $node_license = NULL) {
  if (isset($node)) {
    $notice = $license->node_notice;
    $author = ($node_license->original_author ? $node_license->original_author : $node->original_author);
    if (!$author) {
      $user = user_load(array('uid' => $node->uid));
      $author = $user->name;
    }
    $year = format_date($node->created, 'custom', 'Y');
  }
  else {
    $notice = $license->site_notice;
    $today = getdate();
    $year = $today['year'];
    $author = '';
  }

  $placeholders = array(
    '@year' => $year,
    '@author' => $author,
    '@site' => variable_get('site_name', 'Drupal'),
    '@source_url' => $license->source_url,
  );

  $img = '';
  if ($license->image_url) {
    $img = theme('image', $license->image_url, $alt = '', $title = $license->description, $attr = '', $getsize = false);
    if ($license->source_url) {
      $img = l($img, $license->source_url, array(), NULL, NULL, FALSE, TRUE);
    }
    $img = '<div class="copyright-image">'. $img .'</div>';
  }

  return $img . t($notice, $placeholders);
}

/**
 * Generate a complete license for display
 */
function copyright_show_license($cpyid) {
  $license = copyright_get_license($cpyid);
  return $license->license;
}

/**
 * Theming function for displaying a themed copyright notice
 * in all page footers and the bottom of all nodes.
 *
 * The default is to center and dull the text.
 */
function theme_copyright_footer($notice) {
  return '<div class="copyright-footer">' . $notice . '</div>';
}

/**
 * Theming function for displaying a themed copyright notice
 * in a block.
 *
 * The default is to simply center.
 */
function theme_copyright_block($notice) {
  return $notice;
}

/******************************************************************
 * Database access functions (private).
 ******************************************************************/

function _copyright_db_insert_copyright($edit) {
  return db_query("INSERT INTO {copyrights} (cpyid, name, description, site_notice, node_notice, image_url, source_url, license) VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s', '%s')", $edit['cpyid'], $edit['name'], $edit['description'], $edit['site_notice'], $edit['node_notice'], $edit['image_url'], $edit['source_url'], $edit['license']);
}

function _copyright_db_update_copyright($edit) {
  return db_query("UPDATE {copyrights} SET name = '%s', description = '%s', site_notice = '%s', node_notice = '%s', image_url = '%s', source_url = '%s', license = '%s' WHERE cpyid = %d", $edit['name'], $edit['description'], $edit['site_notice'], $edit['node_notice'], $edit['image_url'], $edit['source_url'], $edit['license'], $edit['cpyid']);
}

/******************************************************************
 * Support for views module.
 ******************************************************************/

/**
 * Implementation of hook_views_table().
 *
 * See: http://drupal.org/handbook/modules/views/api
 */
function copyright_views_tables() {
  $tables = array();
  $tables['copyright_node'] = array(
    'name' => 'copyright_node',
    'join' => array(
      'left' => array(
        'table' => 'node',
        'field' => 'nid'
      ),
      'right' => array(
        'field' => 'nid'
      )
    ),
    'fields' => array(
      'cpyid' => array(
        'name' => t('Node: Copyright'),
        'sortable' => TRUE,
        'handler' => 'views_handler_field_copyright',
        'help' => t('This will display the nodes license.'),
      ),
    ),
    'filters' => array(
      'cpyid' => array(
        'name' => t('Node: Copyright'),
        'list' => 'views_handler_filter_copyright',
        'list-type' => 'list',
        'operator' => 'views_handler_operator_or',
        'value-type' => 'array',
        'help' => t('Include or exclude nodes of the selected license.'),
      ),
    ),
  );
  return $tables;
}

/*
 * Views handler for copyright field.
 *
 * @return
 *   String. License name.
 */
function views_handler_field_copyright($fieldinfo, $fielddata, $value, $data) {
  $licenses = copyright_get_license_names();
  return $licenses[$value];
}

/*
 * Views handler for copyright filter.
 *
 * @return
 *   Array of ($cpyid => $license->name).
 */
function views_handler_filter_copyright($op) {
  return copyright_get_license_names();
}
