intlinks.module in Internal Links 6

Input filters which rewrite internal links and/or unlink unpublished nodes.

This module contains two input filters. The main one is involved in adding link titles to links which don't have a title attribute and rewriting the HREF atttribute for normal Drupal paths (node/123) as URL aliases, if an alias exists. This is a requested back-port of the D7 version.

Links to other nodes on a site are identified, node titles are accessed, and included as HTML "title" attribute in the link, only if no title already exists. HREF paths are also re-written if the value is a "normal" Drupal (node/123 -type) path; if there is a path alias, it is used instead. This makes for more user/SEO -friendly links and streamlines the editorial workflow. Note: Best to use on low-traffic sites without too many links, or on sites with page caching, since this module adds a significant additional load in terms of database queries on pages with many internal links.

It also includes a "hide bad" links filter, which removes links (leaving behind whatever was between the <a> tagset, if the link was to unpublished content. It may not fit all use cases, so be a bit cautious with the use of this filter.

@author Lowell Montgomery | Cocomore AG

See also

http://drupal.org/user/628196

File

intlinks.module

<?php

// $Id$

/**
 * @file
 * Input filters which rewrite internal links and/or unlink unpublished nodes.
 *
 * This module contains two input filters. The main one is involved in adding
 * link titles to links which don't have a title attribute and rewriting the
 * HREF atttribute for normal Drupal paths (node/123) as URL aliases,
 * if an alias exists. This is a requested back-port of the D7 version.
 *
 * Links to other nodes on a site are identified, node titles are accessed, and
 * included as HTML "title" attribute in the link, only if no title already
 * exists. HREF paths are also re-written if the value is a "normal" Drupal
 * (node/123 -type) path; if there is a path alias, it is used instead. This
 * makes for more user/SEO -friendly links and streamlines the editorial
 * workflow. Note: Best to use on low-traffic sites without too many links, or
 * on sites with page caching, since this module adds a significant additional
 * load in terms of database queries on pages with many internal links.
 *
 * It also includes a "hide bad" links filter, which removes links (leaving
 * behind whatever was between the <a> tagset, if the link was to unpublished
 * content. It may not fit all use cases, so be a bit cautious with the use of
 * this filter.
 *
 * @author Lowell Montgomery | Cocomore AG
 *   @see http://drupal.org/user/628196
 */

/**
 * Implements hook_help().
 */
function intlinks_help($path, $arg) {
  switch ($path) {
    case 'admin/help#intlinks':
      $output = '<p>' . t('To use the Internal links filter, simply enable the Internal links title filter for one or more of your <a href="@text_formats">input formats</a>.', array(
        '@text_formats' => url('admin/settings/filters/list'),
      )) . '</p><p>';
      $output .= t('If you like, you can also enable the Internal links "hide bad" filter, which hides internal links to pages not yet published or to bad internal paths, rather than displaying links which would simply yield a "page not found" error.') . '</p><p>';
      $output .= t('If you enable both filters, be sure to move the action of the "hide bad" filter before the "title" filter. There would not be much use in wasting queries on getting titles and re-writing links to unpublished content, only to remove the links with the "hide bad" filter, before display output.') . '</p><p>';
      $output .= t('Note: For best performance, sites which uses these filters should cache the output. Use of these filters on each page load will add significant additional load in terms of database queries and processing. Caching output is especially recommended for high-volume sites with a lot of cross-linking between articles.') . '</p>';
      return $output;
  }
}

/**
 * Implementation of hook_filter().
 *
 * The bulk of filtering work is done here. This hook is quite complicated, so
 * we'll discuss each operation it defines.
 */
function intlinks_filter($op, $delta = 0, $format = -1, $text = '') {

  //
  if ($op == 'list') {
    return array(
      0 => t('Internal links title filter'),
      1 => t('Internal links hide bad filter'),
    );
  }
  switch ($delta) {

    // This is the internal links "title" filter which adds node titles for
    // root relative links (if no title already exists), and replaces node/123
    // -type paths with URL aliases (if an alias exists).
    case 0:
      switch ($op) {

        // This description is shown in the administrative interface, unlike the
        // filter tips which are shown in the content editing interface.
        case 'description':
          return t('Identifies internal links in content and adds an HTML "title" attribute (if none already exists), using the linked  node\'s node title. Also re-writes links to "normal Drupal paths" (e.g. node/123) as path alias if an alias exists.');

        // We don't need the "prepare" operation for this filter.
        case 'prepare':
          return $text;

        // Process internal links to add title elements (using the "title" of
        // the linked node in the HTML title element). Also replace "normal"
        // Drupal paths (e.g. node/123) with a path alias, if one exists.
        case 'process':
          include_once 'intlinks_title_filter.inc';
          return preg_replace_callback('%<a([^>]*?href="([^"]+?)"[^>]*?)>%i', "_intlinks_title_process_link", $text);
      }
      break;

    // This is the "hide bad" internal links filter.
    case 1:
      switch ($op) {

        // This description is shown in the administrative interface.
        case 'description':
          return t('Identifies internal links in content and adds an HTML "title" attribute (if none already exists), using the linked node\'s node title. Also re-writes links to "normal Drupal paths" (e.g. node/123) as path alias if an alias exists.');
        case 'prepare':
          return $text;

        // Process internal links to unpublished or non-existent content,
        // replacing linked text with the same text, unlinked.
        // Internal links to bad paths are removed, leaving just the unlinked
        // text (what was between the <a> tagset).
        // If all is well, it simply returns the unchanged link. Allows
        // editorial staff to link unpublished articles and not have links
        // show up till the linked content is published.
        case 'process':
          include_once 'intlinks_hide_bad_links.inc';
          return preg_replace_callback('%<a[^>]*?href="([^"]+?)"[^>]*?>(.*?)</a>%i', "_intlinks_process_bad_link", $text);
      }
      break;
  }
}

///**

// * Implements hook_filter_info().
// */

//function intlinks_filter_info() {

//  $filters['intlinks title'] = array(
//    'title' => t('Internal links title filter'),
//    'description' => t('Identifies internal links in content and adds an HTML'
//    . ' "title" attribute (if none already exists), using the linked node\'s'
//    . ' node title. Also re-writes links to "normal Drupal paths" (e.g. node/123)'
//    . ' as path alias if an alias exists.'),
//    'process callback' => 'intlinks_title_filter_process',

////    'settings callback' => 'intlinks_title_filter_settings',

//    'default settings' => array(
//      'intlinks_title_display_tip' => 1,
//    ),
//    'tips callback' => 'intlinks_title_filter_tips',
//  );
//  $filters['intlinks hide bad'] = array(
//    'title' => t('Internal links hide bad filter'),
//    'description' => t('Identifies bad internal links in content (unpublished'
//    . ' or non-existent) and suppresses their output'),
//    'process callback' => 'intlinks_hide_bad_filter_process',

////    'settings callback' => 'intlinks_hide_bad_filter_settings',

//    'default settings' => array(
//      'intlinks_hide_bad_display_tip' => 1,
//    ),
//    'tips callback' => 'intlinks_hide_bad_filter_tips',
//  );
//  return $filters;

//}

/**
 * Implementation of hook_filter_tips().
 */
function intlinks_filter_tips($delta, $format, $long = FALSE) {
  switch ($delta) {
    case 0:
      if ($long) {
        return t('Adds node titles to internal links found in content (node titles are put in the HTML "title" attribute, if no title attribute already exists). It also replaces "normal" Drupal paths (e.g. node/123) with a path alias, if one exists. All links *must* be root-relative. It ignores document-relative and absolute links.');
      }
      else {
        return t('Adds node titles to internal links found in content (as HTML "title" attribute).');
      }
      break;
    case 1:
      if ($long) {
        return t('Any root-relative links in filtered content which lead to unpublished content or which do not exist are unlinked. Use with caution as it *should* recognize Views paths (and other special paths), but could possibly remove valid links if all does not go as planned. No known issues here (yet), but beware; this *is* experimental.');
      }
      else {
        return t('Strips broken/unpublished internal links from output.');
      }
      break;
  }
}

Functions

Name	Description
intlinks_filter	Implementation of hook_filter().
intlinks_filter_tips	Implementation of hook_filter_tips().
intlinks_help	Implements hook_help().