Newer
Older
/**
* @file
* Contains the functions to generate Printer-friendly pages.
*
* This file is included by the core PF module, and includes all the
* functions necessary to generate a PF version of the original page
* in HTML format.
/**
* Generate an HTML version of the printer-friendly page
*
* @see print_controller()
* @see _print_get_template()
*/
function print_controller_html() {
$cid = isset($_GET['comment']) ? (int)$_GET['comment'] : NULL;
$print = print_controller($path, $cid, PRINT_HTML_FORMAT);
if ($print !== FALSE) {
$node = $print['node'];
ob_start();
include_once(_print_get_template(PRINT_HTML_FORMAT, $print['type']));
$html = ob_get_contents();
ob_end_clean();
$html = drupal_final_markup($html);
print $html;
$nodepath = (isset($node->path)) ? drupal_get_normal_path($node->path) : $path;
db_query("UPDATE {print_page_counter} SET totalcount = totalcount + 1, timestamp = %d WHERE path = '%s'", time(), $nodepath);
// If we affected 0 rows, this is the first time viewing the node.
if (!db_affected_rows()) {
// We must create a new row to store counters for the new node.
db_query("INSERT INTO {print_page_counter} (path, totalcount, timestamp) VALUES ('%s', 1, %d)", $nodepath, time());
}
* Select the print generator function based on the page type
*
* Depending on the type of node, this functions chooses the appropriate
* generator function.
*
* @param $path
* path of the original page
* @param $cid
* comment ID of the individual comment to be rendered
* @param $format
* format of the page being generated
* @param $teaser
* if set to TRUE, outputs only the node's teaser
* @param $message
* optional sender's message (used by the send e-mail module)
* @return
* array with the fields to be used in the template
* @see _print_generate_node()
* @see _print_generate_path()
* @see _print_generate_book()
function print_controller($path, $cid = NULL, $format = PRINT_HTML_FORMAT, $teaser = FALSE, $message = NULL) {
if (empty($path)) {
// If no path was provided, let's try to generate a page for the referer
global $base_url;
$ref = referer_uri();
$path = preg_replace("!^$base_url/!", '', $ref);
if ($path === $ref) {
$path = '';
}
}
// Indirect call with print/alias
// If there is a path alias with these arguments, generate a printer-friendly version for it
if (is_numeric($parts[0]) && (count($parts) == 1)) {
$print = _print_generate_node($path, $cid, $format, $teaser, $message);
$ret = preg_match('!^book/export/html/(.*)!i', $path, $matches);
if ($ret == 1) {
// This is a book PF page link, handle trough the book handling functions
$print = _print_generate_book($matches[1], $format, $teaser, $message);
}
else {
// If no content node was found, handle the page printing with the 'printable' engine
$print = _print_generate_path($path, $format, $teaser, $message);
}
}
return $print;
}
/**
* Generates a robots meta tag to tell them what they may index
*/
function _print_robots_meta_generator() {
$print_robots_noindex = variable_get('print_robots_noindex', PRINT_ROBOTS_NOINDEX_DEFAULT);
$print_robots_nofollow = variable_get('print_robots_nofollow', PRINT_ROBOTS_NOFOLLOW_DEFAULT);
$print_robots_noarchive = variable_get('print_robots_noarchive', PRINT_ROBOTS_NOARCHIVE_DEFAULT);
$robots_meta[] = 'noindex';
}
$robots_meta[] = 'nofollow';
}
$robots_meta[] = 'noarchive';
}
if (count($robots_meta) > 0) {
$robots_meta = implode(', ', $robots_meta);
$robots_meta = "<meta name='robots' content='$robots_meta' />\n";
}
else {
$robots_meta = '';
}
return $robots_meta;
}
/**
* Post-processor that fills the array for the template with common details
* @param $node
* generated node with a printer-friendly node body
* @param $message
* optional sender's message (used by the send e-mail module)
* id of current comment being generated (NULL when not generating
* an individual comment)
* @return
* array with the fields to be used in the template
function _print_var_generator($node, $message = NULL, $cid = NULL) {
$path = empty($node->nid) ? $node->path : "node/$node->nid";
// print module settings
$print_css = variable_get('print_css', PRINT_CSS_DEFAULT);
$print_logo_options = variable_get('print_logo_options', PRINT_LOGO_OPTIONS_DEFAULT);
$print_logo_url = variable_get('print_logo_url', PRINT_LOGO_URL_DEFAULT);
$print_html_sendtoprinter = variable_get('print_html_sendtoprinter', PRINT_HTML_SENDTOPRINTER_DEFAULT);
$print_sourceurl_enabled = variable_get('print_sourceurl_enabled', PRINT_SOURCEURL_ENABLED_DEFAULT);
$print_sourceurl_forcenode = variable_get('print_sourceurl_forcenode', PRINT_SOURCEURL_FORCENODE_DEFAULT);
$print_sourceurl_date = variable_get('print_sourceurl_date', PRINT_SOURCEURL_DATE_DEFAULT);
$print_footer_options = variable_get('print_footer_options', PRINT_FOOTER_OPTIONS_DEFAULT);
$print_footer_user = variable_get('print_footer_user', PRINT_FOOTER_USER_DEFAULT);
$print['title'] = check_plain($node->title);
$print['head'] = drupal_get_html_head();
$print['scripts'] = drupal_get_js();
$print['robots_meta'] = _print_robots_meta_generator();
$print['url'] = url($path, NULL, NULL, TRUE);
$print['base_href'] = "<base href='". $print['url'] ."' />\n";
$print['favicon'] = theme_get_setting('toggle_favicon') ? "<link rel='shortcut icon' href='". theme_get_setting('favicon') ."' type='image/x-icon' />\n" : '';
$replace_pairs = array('%b' => base_path(), '%t' => path_to_theme());
$user_css = check_url(strtr($print_css, $replace_pairs));
drupal_add_css(drupal_get_path('module', 'print') .'/css/print.css');
$drupal_css = drupal_add_css();
foreach ($drupal_css as $key => $types) {
// Unset the theme's CSS
$drupal_css[$key]['theme'] = array();
}
// If we are sending a message via e-mail, the CSS must be embedded
if (!empty($message)) {
$style = '';
$css_files = array();
foreach ($drupal_css as $types) {
foreach ($types as $values) {
$css_files = array_merge($css_files, array_keys($values));
}
}
if (!empty($print_css)) {
$pattern = '!^'. base_path() .'!';
$css_files[] = preg_replace($pattern, '', $user_css);
}
foreach ($css_files as $filename) {
$res = file_exists($filename) ? file_get_contents($filename, TRUE) : FALSE;
if ($res != FALSE) {
$style .= $res;
}
}
$print['css'] = "<style type='text/css' media='all'>$style</style>\n";
$print['css'] = drupal_get_css($drupal_css);
if (!empty($print_css)) {
$print['css'] .= "<link type='text/css' rel='stylesheet' media='all' href='$user_css' />\n";
$print['sendtoprinter'] = $print_html_sendtoprinter ? ' onload="window.print();"' : '';
switch ($print_logo_options) {
case 0: // none
$logo_url = 0;
break;
case 1: // theme's
$logo_url = theme_get_setting('logo');
break;
case 2: // user-specifed
$logo_url = strip_tags($print_logo_url);
break;
}
$print['logo'] = $logo_url ? "<img class='print-logo' src='". check_url($logo_url) ."' alt='' />\n" : '';
switch ($print_footer_options) {
case 0: // none
$footer = '';
break;
case 1: // theme's
$footer = variable_get('site_footer', FALSE) ."\n". theme('blocks', 'footer');
break;
case 2: // user-specifed
$footer = $print_footer_user;
break;
}
$print['footer_message'] = filter_xss_admin($footer);
$published_site = variable_get('site_name', 0);
if ($published_site) {
$print_text_published = filter_xss(variable_get('print_text_published', t('Published on %site_name')));
João Ventura
committed
$published = t($print_text_published, array('%site_name' => $published_site));
$print['site_name'] = $published .' ('. l($base_url, $base_url) .')';
/* Grab and format the src URL */
if (empty($print_sourceurl_forcenode)) {
$url = $print['url'];
$url = $base_url .'/'. (((bool)variable_get('clean_url', '0')) ? '' : '?q=') . $path;
$retrieved_date = format_date(time(), 'small');
$print_text_retrieved = filter_xss(variable_get('print_text_retrieved', t('retrieved on %date')));
João Ventura
committed
$retrieved = t($print_text_retrieved, array('%date' => $retrieved_date));
$print['printdate'] = $print_sourceurl_date ? " ($retrieved)" : '';
$source_url = filter_xss(variable_get('print_text_source_url', t('Source URL')));
$print['source_url'] = '<strong>'. $source_url . $print['printdate'] .':</strong> '. l($url, $url);
}
if (isset($node->type)) {
$node_type = $node->type;
if (theme_get_setting("toggle_node_info_$node_type")) {
$print_text_by = filter_xss(variable_get('print_text_by', t('By %author')));
$by_author = ($node->name ? $node->name : variable_get('anonymous', t('Anonymous')));
João Ventura
committed
$print['submitted'] = t($print_text_by, array('%author' => $by_author));
$print_text_created = filter_xss(variable_get('print_text_created', t('Created %date')));
$created_datetime = format_date($node->created, 'small');
João Ventura
committed
$print['created'] = t($print_text_created, array('%date' => $created_datetime));
$print['submitted'] = '';
$print['created'] = '';
$print['type'] = '';
}
menu_set_active_item($path);
$breadcrumb = drupal_get_breadcrumb();
if (!empty($breadcrumb)) {
$breadcrumb[] = menu_get_active_title();
$print['breadcrumb'] = filter_xss(implode(' > ', $breadcrumb));
}
// Display the collected links at the bottom of the page. Code once taken from Kjartan Mannes' project.module
$urls = _print_friendly_urls();
$max = count($urls);
if ($max) {
for ($i = 0; $i < $max; $i++) {
$pfp_links .= '['. ($i + 1) .'] '. $urls[$i] ."<br />\n";
$links = filter_xss(variable_get('print_text_links', t('Links')));
$print['pfp_links'] = "<p><strong>$links:</strong><br />$pfp_links</p>";
}
}
if (module_exists('taxonomy')) {
$terms = taxonomy_link('taxonomy terms', $node);
$print['content'] = $node->body;
$print['node'] = $node;
$print['message'] = $message;
return $print;
}
/**
* Callback function for the preg_replace_callback for URL-capable patterns
* Manipulate URLs to make them absolute in the URLs list, and to add a
* @param $matches
* array with the matched tag patterns, usually <a...>+text+</a>
* @return
* tag with re-written URL and when appropriate the [n] index to the
*/
function _print_rewrite_urls($matches) {
global $base_url, $base_root, $_print_urls;
// first, 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 may need to rewrite the URL in the value
if (preg_match('!^(?:href|src)\s*?=(.*)!i', $attribs[$i], $urls) > 0) {
if (strpos($url, '://') || preg_match('!^mailto:.*?@.*?\..*?$!iu', $url)) {
// URL is absolute, do nothing
$newurl = urldecode($url);
}
else {
$path = explode('/', $_GET['q']);
unset($path[0]);
$path = implode('/', $path);
if (is_numeric($path)) {
$path = "node/$path";
}
// Printer-friendly URLs is on, so we need to make it absolute
$newurl = url($path, NULL, substr(urldecode($url), 1), TRUE);
}
// Because base href is the original page, change the link to
// still be usable inside the print page
$matches[1] = str_replace($url, $_GET['q'] . $url, $matches[1]);
}
else {
// URL is relative, convert it into absolute URL
// If it starts with '/' just append it to the server name
elseif (preg_match('!^(?:index.php)?\?q=!i', $url)) {
// If it starts with ?q=, just prepend with the base URL
$newurl = url(trim(urldecode($url), '/'), NULL, NULL, TRUE);
}
$matches[1] = str_replace($url, $newurl, $matches[1]);
}
}
}
}
$ret = '<'. $matches[1] .'>';
if (count($matches) == 4) {
$ret .= $matches[2] . $matches[3];
if ((!empty($_print_urls)) && (isset($newurl))) {
$ret .= ' <span class="print-footnote">['. _print_friendly_urls(trim(stripslashes($newurl))) .']</span>';
}
}
return $ret;
}
/**
* Auxiliary function to store the Printer-friendly URLs list as static.
*
* @param $url
* absolute URL to be inserted in the list
* @return
* list of URLs previously stored if $url is 0, or the current count
*/
function _print_friendly_urls($url = 0) {
static $urls = array();
if ($url) {
$url_idx = array_search($url, $urls);
if ($url_idx !== FALSE) {
return ($url_idx + 1);
}
else {
$urls[] = $url;
return count($urls);
}
}
* Auxiliary function to resolve the most appropriate template trying to find
* a content specific template in the theme or module dir before falling back
* on a generic template also in those dirs.
*
* @param format
* format of the PF page being rendered (html, pdf, etc.)
* @param $type
* name of the node type being rendered in a PF page
* @return
* filename of the most suitable template
function _print_get_template($format = NULL, $type = NULL) {
// First try to find a template defined both for the format and then the type
if (!empty($format) && !empty($type)) {
$filenames[] = "print_$format.node-$type.tpl.php";
}
// Then only for the format
if (!empty($format)) {
$filenames[] = "print_$format.tpl.php";
}
// If the node type is known, then try to find that type's template file
if (!empty($type)) {
$filenames[] = "print.node-$type.tpl.php";
$filenames[] = "print.$type.tpl.php";
}
// Finally search for a generic template file
// First in the theme directory
$file = drupal_get_path('theme', $GLOBALS['theme_key']) .'/'. $value;
if (file_exists($file)) {
return $file;
}
// Then in the module directory
if (file_exists($file)) {
return $file;
/**
* Check URL list settings for this node
*
* @param node
* node object
* @param $format
* format of the page being generated
* @return
* TRUE if URL list should be displayed, FALSE otherwise
*/
function _print_url_list_enabled($node, $format = PRINT_HTML_FORMAT) {
switch ($format) {
case PRINT_HTML_FORMAT:
$node_urllist = isset($node->print_display_urllist) ? $node->print_display_urllist : TRUE;
$fmt = '';
break;
case PRINT_MAIL_FORMAT:
$node_urllist = isset($node->print_mail_display_urllist) ? $node->print_mail_display_urllist : TRUE;
$fmt = $format .'_';
break;
case PRINT_PDF_FORMAT:
$node_urllist = isset($node->print_pdf_display_urllist) ? $node->print_pdf_display_urllist : TRUE;
$fmt = $format .'_';
break;
}
if (!isset($node_urllist)) $node_urllist = TRUE;
// Get value of Printer-friendly URLs setting
return (variable_get('print_urls', PRINT_URLS_DEFAULT) && ($node_urllist) &&
(isset($node->type) ? variable_get('print_'. $fmt .'display_urllist_'. $node->type, PRINT_TYPE_URLLIST_DEFAULT) : PRINT_TYPE_URLLIST_DEFAULT));
* Prepare a Printer-friendly-ready node body for content nodes
* @param $nid
* node ID of the node to be rendered into a printer-friendly page
* @param $cid
* comment ID of the individual comment to be rendered
* @param $format
* format of the page being generated
* @param $teaser
* if set to TRUE, outputs only the node's teaser
* @param $message
* optional sender's message (used by the send e-mail module)
* @return
* filled array ready to be used in the template
function _print_generate_node($nid, $cid = NULL, $format = PRINT_HTML_FORMAT, $teaser = FALSE, $message = NULL) {
global $_print_urls;
$node = node_load($nid);
João Ventura
committed
if (!$node) {
// Node not found
drupal_not_found();
João Ventura
committed
}
elseif (!node_access('view', $node)) {
João Ventura
committed
drupal_access_denied();
drupal_set_title(check_plain($node->title));
//alert other modules that we are generating a printer-friendly page, so they can choose to show/hide info
$node->printing = TRUE;
// Turn off Pagination by the Paging module
unset($node->pages);
unset($node->pages_count);
unset($node->page_count);
João Ventura
committed
// Make this page a member of the original page's organic group
if (function_exists('og_set_group_context') && isset($node->og_groups)) {
og_set_group_context($node->og_groups);
}
João Ventura
committed
// Adapted (simplified) version of node_view
// Disable fivestar widget output
// Disable service links module output
João Ventura
committed
$content = drupal_render($node->content);
// Disable the AdSense module ads
$content = preg_replace('!<div class=[\'"]adsense[\'"].*?</div>!sim', '', $content);
João Ventura
committed
if ($teaser) {
$node->teaser = $content;
unset($node->body);
}
else {
$node->body = $content;
unset($node->teaser);
}
$print_comments = variable_get('print_comments', PRINT_COMMENTS_DEFAULT);
if (function_exists('comment_render') && (($cid != NULL) || ($print_comments))) {
//Print only the requested comment (or if $cid is NULL, all of them)
$comments = comment_render($node, $cid);
$comments = preg_replace('!<form.*?id="comment-.*?">.*?</form>!sim', '', $comments);
//Remove the 'Post new comment' title
$comments = preg_replace('!<h2.*?>'. t('Post new comment') .'</h2>!', '', $comments);
//Remove the comment title hyperlink
$comments = preg_replace('!(<h3.*?>.*?)<a.*?>(.*?)</a>(.*?</h3>)!i', '$1$2$3', $comments);
//Remove the comment author link
$pattern = '!(<(?:span|div) class="submitted">.*?)<a.*?>(.*?)</a>(.*?</(?:span|div)>)!sim';
if (preg_match($pattern, $comments)) {
$comments = preg_replace($pattern , '$1$2$3', $comments);
}
//Remove the comment links
$comments = preg_replace('!\s*<ul class="links">.*?</ul>!sim', '', $comments);
if ($cid != NULL) {
// Single comment requested, output only the comment
unset($node->body);
}
$node->body .= $comments;
}
João Ventura
committed
node_invoke_nodeapi($node, 'alter', $teaser, TRUE);
if ($teaser) {
$node->body = $node->teaser;
unset($node->teaser);
}
//Check URL list settings
$_print_urls = _print_url_list_enabled($node, $format);
$pattern = '!<(a\s[^>]*?)>(.*?)(</a>)!is';
$node->body = preg_replace_callback($pattern, '_print_rewrite_urls', $node->body);
return $print;
}
/**
* Prepare a Printer-friendly-ready node body for non-content pages
* @param $path
* path of the node to be rendered into a printer-friendly page
* @param $format
* format of the page being generated
* @param $teaser
* if set to TRUE, outputs only the node's teaser
* @param $message
* optional sender's message (used by the send e-mail module)
* @return
* filled array ready to be used in the template
function _print_generate_path($path, $format = PRINT_HTML_FORMAT, $teaser = FALSE, $message = NULL) {
global $_print_urls;
// Handle node tabs
$parts = explode('/', $path);
if (is_numeric($parts[0]) && (count($parts) > 1)) {
$path = 'node/'. $path;
}
$path = drupal_get_normal_path($path);
$_GET['q'] = $path;
_menu_append_contextual_items();
menu_set_active_item($path);
// Adapted from index.php.
$node = new stdClass();
$node->body = menu_execute_active_handler();
// It may happen that a drupal_not_found is called in the above call
if (preg_match('/404 Not Found/', drupal_get_headers()) == 1) {
if (is_int($node->body)) {
switch ($node->body) {
case MENU_NOT_FOUND:
João Ventura
committed
drupal_not_found();
João Ventura
committed
drupal_access_denied();
João Ventura
committed
$node->title = drupal_get_title();
$node->path = $path;
$node->body = preg_replace('!\s*<div class="links">.*?</div>!sim', '', $node->body);
//Check URL list settings
$_print_urls = _print_url_list_enabled($node, $format);
$pattern = '!<(a\s[^>]*?)>(.*?)(</a>)!is';
$node->body = preg_replace_callback($pattern, '_print_rewrite_urls', $node->body);
return $print;
}
/**
* Prepare a Printer-friendly-ready node body for book pages
* @param $nid
* node ID of the node to be rendered into a printer-friendly page
* @param $format
* format of the page being generated
* @param $teaser
* if set to TRUE, outputs only the node's teaser
* @param $message
* optional sender's message (used by the send e-mail module)
* @return
* filled array ready to be used in the template
function _print_generate_book($nid, $format = PRINT_HTML_FORMAT, $teaser = FALSE, $message = NULL) {
global $_print_urls;
$node = node_load($nid);
João Ventura
committed
if (!$node) {
// Node not found
drupal_not_found();
João Ventura
committed
}
elseif (!node_access('view', $node) || (!user_access('see printer-friendly version'))) {
João Ventura
committed
drupal_access_denied();
}
$depth = count(book_location($node)) + 1;
$node->body = book_recurse($nid, $depth, '_print_node_visitor_html_pre', 'book_node_visitor_html_post');
//Check URL list settings
$_print_urls = _print_url_list_enabled($node, $format);
$pattern = '!<(a\s[^>]*?)>(.*?)(</a>)!is';
$node->body = preg_replace_callback($pattern, '_print_rewrite_urls', $node->body);
// The title is already displayed by the book_recurse, so avoid duplication
return $print;
}
/**
* Generates printer-friendly HTML for a node. This function is a 'pre-node' visitor function for book_recurse()
* My own version of book_node_visitor_html_pre so that CCK pages in book nodes
* come out right
*
* @param $node
* the node to generate output for.
* @param $depth
* the depth of the given node in the hierarchy. This is used only for
* the node id (nid) of the given node. This is used only for generating
* output.
* @return
* the HTML generated for the given node.
*/
function _print_node_visitor_html_pre($node, $depth, $nid) {
$node = node_build_content($node, FALSE, TRUE);
$output .= "<div id='node-$node->nid' class='section-$depth'>\n";
$output .= "<h1 class='book-heading'>". check_plain($node->title) ."</h1>\n";
$output .= drupal_render($node->content);
return $output;
}