print.inc in Printer, email and PDF versions 7.2

Common functions used by several of the print modules.

File

includes/print.inc

<?php

/**
 * @file
 * Common functions used by several of the print modules.
 *
 * @ingroup print
 */

/**
 * Auxiliary function to scan all module directories for a given library.
 *
 * @param string $lib
 *   The machine name of a library to return the path for.
 * @param string $mask
 *   The preg_match() regular expression of the files to find.
 *
 * @return array
 *   An array of the filenames matching the provided mask.
 */
function _print_scan_libs($lib, $mask) {
  $tools = array_keys(file_scan_directory(drupal_get_path('module', 'print'), $mask));
  $tools = array_merge($tools, array_keys(file_scan_directory(PRINT_LIB_PATH, $mask)));
  if (module_exists('libraries')) {
    $tools = array_merge($tools, array_keys(file_scan_directory(libraries_get_path($lib), $mask)));
  }
  return array_unique($tools);
}

/**
 * Callback function for the preg_replace_callback replacing spaces with %20.
 *
 * Replace spaces in URLs with %20
 *
 * @param array $matches
 *   Array with the matched tag patterns, usually <a...>+text+</a>.
 *
 * @return string
 *   tag with re-written URL
 */
function _print_replace_spaces($matches) {

  // Split the html into the different tag attributes.
  $pattern = '!\\s*(\\w+\\s*=\\s*"(?:\\\\"|[^"])*")\\s*|\\s*(\\w+\\s*=\\s*\'(?:\\\\\'|[^\'])*\')\\s*|\\s*(\\w+\\s*=\\s*\\w+)\\s*|\\s+!';
  $attribs = preg_split($pattern, $matches[1], -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
  foreach ($attribs as $key => $value) {
    $attribs[$key] = preg_replace('!(\\w)\\s*=\\s*(.*)!', '$1=$2', $value);
  }
  $size = count($attribs);
  for ($i = 1; $i < $size; $i++) {

    // If the attribute is href or src, we need to rewrite the URL in the value.
    if (preg_match('!^(?:href|src)\\s*?=(.*)!i', $attribs[$i], $urls) > 0) {
      $url = trim($urls[1], " \t\n\r\0\v\"'");
      $new_url = str_replace(' ', '%20', $url);
      $matches[1] = str_replace($url, $new_url, $matches[1]);
    }
  }
  $ret = '<' . $matches[1] . '>';
  if (count($matches) == 4) {
    $ret .= $matches[2] . $matches[3];
  }
  return $ret;
}

/**
 * Convert image paths to the file:// protocol.
 *
 * In some Drupal setups, the use of the 'private' filesystem or Apache's
 * configuration prevent access to the images of the page. This function
 * tries to circumnvent those problems by accessing files in the local
 * filesystem.
 *
 * @param string $html
 *   Contents of the post-processed template already with the node data.
 * @param bool $images_via_file
 *   If TRUE, convert also files in the 'public' filesystem to local paths.
 *
 * @return string
 *   converted file names
 */
function _print_access_images_via_file($html, $images_via_file) {
  global $base_url, $language;
  $lang = function_exists('language_negotiation_get_any') && language_negotiation_get_any('locale-url') ? $language->language : '';

  // Always convert private to local paths.
  $pattern = "!(<img\\s[^>]*?src\\s*?=\\s*?['\"]?){$base_url}/(?:(?:index.php)?\\?q=)?(?:{$lang}/)?system/files/([^>\\?]*)(?:\\?itok=[a-zA-Z0-9\\-_]{8})?([^>]*?>)!is";
  $replacement = '$1file://' . realpath(variable_get('file_private_path', '')) . '/$2$3';
  $html = preg_replace($pattern, $replacement, $html);
  if ($images_via_file) {
    $pattern = "!(<img\\s[^>]*?src\\s*?=\\s*?['\"]?){$base_url}/(?:(?:index.php)?\\?q=)?(?:{$lang}/)?([^>\\?]*)(?:\\?itok=[a-zA-Z0-9\\-_]{8})?([^>]*?>)!is";
    $replacement = '$1file://' . DRUPAL_ROOT . '/$2$3';
    $html = preg_replace($pattern, $replacement, $html);
  }
  return $html;
}

Related topics

Files

Files used by the print module, grouped by sub-module

Functions

Name	Description
_print_access_images_via_file	Convert image paths to the file:// protocol.
_print_replace_spaces	Callback function for the preg_replace_callback replacing spaces with %20.
_print_scan_libs	Auxiliary function to scan all module directories for a given library.