Newer
Older
Matt Westgate
committed
<?php
Matt Westgate
committed
/**
* @file
* Displays Printer-friendly versions of Drupal pages.
*
* This is the core module of the PF package, with the Drupal hooks
* and other administrative functions.
define('PRINT_PATH', 'print');
define('PRINT_LOGO_OPTIONS_DEFAULT', 1);
define('PRINT_LOGO_URL_DEFAULT', '');
define('PRINT_FOOTER_OPTIONS_DEFAULT', 1);
define('PRINT_FOOTER_USER_DEFAULT', '');
define('PRINT_CSS_DEFAULT', '');
define('PRINT_URLS_DEFAULT', 1);
define('PRINT_COMMENTS_DEFAULT', 0);
define('PRINT_NEWWINDOW_DEFAULT', 1);
define('PRINT_HTML_LINK_POS_DEFAULT', 'link');
define('PRINT_HTML_SHOW_LINK_DEFAULT', 1);
define('PRINT_HTML_NODE_LINK_VISIBILITY_DEFAULT', 0);
define('PRINT_HTML_NODE_LINK_PAGES_DEFAULT', '');
define('PRINT_HTML_LINK_CLASS_DEFAULT', 'print-page');
define('PRINT_HTML_SYS_LINK_VISIBILITY_DEFAULT', 1);
define('PRINT_HTML_SYS_LINK_PAGES_DEFAULT', '');
define('PRINT_HTML_LINK_USE_ALIAS_DEFAULT', 0);
define('PRINT_HTML_BOOK_LINK_DEFAULT', 1);
define('PRINT_HTML_NEW_WINDOW_DEFAULT', 0);
define('PRINT_HTML_SENDTOPRINTER_DEFAULT', 0);
define('PRINT_SOURCEURL_ENABLED_DEFAULT', 1);
define('PRINT_SOURCEURL_DATE_DEFAULT', 0);
define('PRINT_SOURCEURL_FORCENODE_DEFAULT', 0);
define('PRINT_ROBOTS_NOINDEX_DEFAULT', 1);
define('PRINT_ROBOTS_NOFOLLOW_DEFAULT', 1);
define('PRINT_ROBOTS_NOARCHIVE_DEFAULT', 0);
define('PRINT_TYPE_SHOW_LINK_DEFAULT', 1);
define('PRINT_TYPE_COMMENT_LINK_DEFAULT', 0);
define('PRINT_TYPE_URLLIST_DEFAULT', 1);
define('PRINT_ALLOW_NORMAL_LINK', 1);
define('PRINT_ALLOW_BOOK_LINK', 2);
Matt Westgate
committed
/**
João Ventura
committed
* Implementation of hook_perm().
'access print' => array(
'title' => t('Access the printer-friendly page'),
'description' => t('View the printer-friendly pages and the links to them in the original pages.'),
),
'administer print' => array(
'title' => t('Administer the module'),
'description' => t('Perform maintenance tasks for the print module.'),
),
'node-specific print configuration' => array(
'title' => t('Node-specific configuration'),
'description' => t('Enable access to the per-node settings.'),
),
'use PHP for link visibility' => array(
'title' => t('Use PHP for link visibility'),
'description' => t('Enables the use of PHP code to configure the link visibility.'),
),
João Ventura
committed
* Implementation of hook_theme().
*/
function print_theme() {
return array(
'print_format_link' => array(
'arguments' => array(),
),
);
}
João Ventura
committed
* Implementation of hook_menu().
Matt Westgate
committed
*/
Matt Westgate
committed
$items = array();
$items[PRINT_PATH] = array(
'title' => 'Printer-friendly',
'access arguments' => array('access print'),
);
$items['admin/settings/print'] = array(
'title' => 'Printer, e-mail and PDF versions',
João Ventura
committed
'description' => 'Adds a printer-friendly version link to content and administrative pages.',
'page callback' => 'drupal_get_form',
'page arguments' => array('print_html_settings'),
'access arguments' => array('administer print'),
);
$items['admin/settings/print/html'] = array(
'title' => 'Web page',
$items['admin/settings/print/html/options'] = array(
'title' => 'Options',
'weight' => 1,
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/settings/print/html/strings'] = array(
'title' => 'Text strings',
'page callback' => 'drupal_get_form',
'page arguments' => array('print_html_strings_settings'),
'access arguments' => array('administer print'),
'weight' => 2,
'type' => MENU_LOCAL_TASK,
);
$items['admin/settings/print/common'] = array(
'title' => 'Settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('print_main_settings'),
'access arguments' => array('administer print'),
$items['admin/settings/print/common/options'] = array(
'title' => 'Options',
'weight' => 1,
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/settings/print/common/strings'] = array(
'title' => 'Text strings',
'page callback' => 'drupal_get_form',
'page arguments' => array('print_main_strings_settings'),
'access arguments' => array('administer print'),
'weight' => 2,
'type' => MENU_LOCAL_TASK,
);
Matt Westgate
committed
return $items;
}
$block[0]['info'] = t('Printer, e-mail and PDF versions');
$block[1]['info'] = t('Most printed');
}
/**
* Implementation of hook_block_view().
*/
function print_block_view($delta = 0) {
$nid = preg_replace('!^node/!', '', $_GET['q']);
if (is_numeric($nid)) {
}
else {
$node = NULL;
}
$funcs = get_defined_functions();
$block['content'] = '';
foreach ($funcs['user'] as $func) {
if (preg_match('!^print.*?_insert_link$!', $func)) {
$link = $func(NULL, $node);
if (!empty($link)) {
$block['content'] .= $link .'<br />';
}
}
}
break;
case 1:
$block['subject'] = t('Most printed');
$result = db_query_range("SELECT path FROM {print_page_counter} ORDER BY totalcount DESC", 0, 3)
->fetchAll();
if (count($result)) {
$block['content'] = '<div class="item-list"><ul>';
foreach ($result as $obj) {
$block['content'] .= '<li>'. l(_print_get_title($obj->path), $obj->path) .'</li>';
}
$block['content'] .= '</ul></div>';
}
break;
/**
* Implementation of hook_link_alter().
*/
function print_link_alter(&$links, $node) {
João Ventura
committed
foreach ($links as $module => $link) {
if (strpos($module, 'book_printer') !== FALSE) {
$print_html_book_link = variable_get('print_html_book_link', PRINT_HTML_BOOK_LINK_DEFAULT);
if ($print_html_book_link) {
switch ($print_html_book_link) {
case 1:
$path = $link['href'];
break;
case 2:
$print_html_link_use_alias = variable_get('print_html_link_use_alias', PRINT_HTML_LINK_USE_ALIAS_DEFAULT);
$path = $print_html_link_use_alias ? $node->path : $node->nid;
break;
}
$links[$module] = array(
'href' => PRINT_PATH .'/'. $path,
'title' => $format['text'],
'attributes' => $format['attributes'],
'html' => $format['html'],
);
João Ventura
committed
* Implementation of hook_help().
*/
function print_help($path, $arg) {
switch ($path) {
case 'admin/help#print':
// Return a line-break version of the module README
return filter_filter('process', 1, NULL, file_get_contents(drupal_get_path('module', 'print') .'/README.txt') );
$print_html_link_pos = variable_get('print_html_link_pos', array(PRINT_HTML_LINK_POS_DEFAULT => PRINT_HTML_LINK_POS_DEFAULT));
if ((preg_match('!^node/!i', $path) == 0) &&
!(empty($print_html_link_pos['link']) && empty($print_html_link_pos['corner']))) {
static $output = FALSE;
if ($output === FALSE) {
$output = TRUE;
$link = print_insert_link();
if ($link) {
return "<span class='print-syslink'>$link</span>";
}
Matt Westgate
committed
}
Matt Westgate
committed
João Ventura
committed
/**
* Implementation of hook_nodeapi_view().
João Ventura
committed
*/
João Ventura
committed
function print_nodeapi_view($node, $teaser) {
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
$print_html_link_pos = variable_get('print_html_link_pos', array(PRINT_HTML_LINK_POS_DEFAULT => PRINT_HTML_LINK_POS_DEFAULT));
$print_html_link_use_alias = variable_get('print_html_link_use_alias', PRINT_HTML_LINK_USE_ALIAS_DEFAULT);
$allowed_type = print_link_allowed(array('type' => 'node', 'node' => $node, 'teaser' => $teaser));
if (($allowed_type === PRINT_ALLOW_NORMAL_LINK) && !isset($node->book) && !empty($print_html_link_pos['link'])) {
drupal_add_css(drupal_get_path('module', 'print') .'/css/printlinks.css');
$links = array();
$format = theme('print_format_link');
$query_arr = $_GET;
if ('node' == 'comment') {
$query_arr['comment'] = $node->cid;
}
$query = print_query_string_encode($query_arr, array('q'));
if (empty($query)) $query = NULL;
if ($print_html_link_use_alias) {
$path = drupal_get_path_alias('node/'. $node->nid);
}
else {
$path = $node->nid;
}
$links['print_html'] = array(
'href' => PRINT_PATH .'/'. $path,
'title' => $format['text'],
'attributes' => $format['attributes'],
'html' => $format['html'],
'query' => $query,
);
$node->content['links']['print_html'] = array(
'#type' => 'node_links',
'#value' => $links,
);
}
// Insert content corner links
if (($teaser === FALSE) && !empty($print_html_link_pos['corner']) &&
(preg_match('!^print!i', $_GET['q']) == 0)) {
$link = print_insert_link(NULL, $node);
if ($link) {
$node->content['print_link'] = array(
'#markup' => "<span class='print-link'>$link</span>",
João Ventura
committed
'#weight' => -101,
João Ventura
committed
}
}
João Ventura
committed
* Implementation of hook_nodeapi_load().
João Ventura
committed
function print_nodeapi_load($nodes, $types) {
foreach ($nodes as $node) {
_print_set_node_fields($node);
}
}
/**
* Implementation of hook_nodeapi_update().
*/
João Ventura
committed
function print_nodeapi_update($node) {
_print_node_conf_modify($node->nid, $node->print_display, $node->print_display_comment, $node->print_display_urllist);
}
/**
* Implementation of hook_nodeapi_delete().
*/
João Ventura
committed
function print_nodeapi_delete($node) {
db_delete('print_node_conf')
->condition('nid', $node->nid)
->execute();
db_delete('print_page_counter')
->condition('path', $node->path)
->execute();
}
João Ventura
committed
* Implementation of hook_form_alter().
*/
function print_form_alter(&$form, $form_state, $form_id) {
// Add the node-type settings option to activate the printer-friendly version link
if ((user_access('administer print') || user_access('node-specific print configuration')) &&
(($form_id == 'node_type_form') || !empty($form['#node_edit_form']))) {
João Ventura
committed
$form['print'] = array(
'#type' => 'fieldset',
'#title' => t('Printer, e-mail and PDF versions'),
João Ventura
committed
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['print']['label'] = array(
'#type' => 'markup',
'#markup' => '<p><strong>'. t('Printer-friendly version') .'</strong></p>',
);
João Ventura
committed
$form['print']['print_display'] = array(
João Ventura
committed
$form['print']['print_display_comment'] = array(
'#title' => t('Show link in individual comments'),
);
$form['print']['print_display_urllist'] = array(
'#type' => 'checkbox',
'#title' => t('Show Printer-friendly URLs list'),
if ($form_id == 'node_type_form') {
$form['print']['print_display']['#default_value'] = variable_get('print_display_'. $form['#node_type']->type, PRINT_TYPE_SHOW_LINK_DEFAULT);
$form['print']['print_display_comment']['#default_value'] = variable_get('print_display_comment_'. $form['#node_type']->type, PRINT_TYPE_COMMENT_LINK_DEFAULT);
$form['print']['print_display_urllist']['#default_value'] = variable_get('print_display_urllist_'. $form['#node_type']->type, PRINT_TYPE_URLLIST_DEFAULT);
}
else {
$node = $form['#node'];
$form['print']['print_display']['#default_value'] = isset($node->print_display) ? $node->print_display : PRINT_TYPE_SHOW_LINK_DEFAULT;
$form['print']['print_display_comment']['#default_value'] = isset($node->print_display_comment) ? $node->print_display_comment : PRINT_TYPE_COMMENT_LINK_DEFAULT;
$form['print']['print_display_urllist']['#default_value'] = isset($node->print_display_urllist) ? $node->print_display_urllist : PRINT_TYPE_URLLIST_DEFAULT;
$form['print']['label']['#markup'] = '<p><em>'. t('The settings below only apply in case the corresponding type-specific setting is also enabled (except for the "Show link in individual comments").') .'</em></p>'. $form['print']['label']['#markup'];
}
}
}
/**
* Auxiliary function to assign the per-node settings to the node object fields
*
* @param $node
* node to be modified
*/
function _print_set_node_fields(&$node) {
if (isset($node->nid)) {
$res = db_query("SELECT link, comments, url_list FROM {print_node_conf} WHERE nid = :nid", array(':nid' => $node->nid))
->fetch();
}
else {
$res = FALSE;
}
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
$node->print_display = $res ? intval($res->link) : PRINT_TYPE_SHOW_LINK_DEFAULT;
$node->print_display_comment = $res ? intval($res->comments) : PRINT_TYPE_COMMENT_LINK_DEFAULT;
$node->print_display_urllist = $res ? intval($res->url_list) : PRINT_TYPE_URLLIST_DEFAULT;
}
/**
* Auxiliary function to discover a given page's title
*
* @param $path
* path of the page being identified
* @return
* string with the page's title
*/
function _print_get_title($path) {
$path = drupal_get_normal_path($path);
$nid = preg_replace('!^node/!', '', $path);
if (is_numeric($nid)) {
$res = db_query("SELECT title FROM {node} WHERE nid = :nid", array(':nid' => $nid))
->fetchField();
}
else {
$res = db_query("SELECT link_title FROM {menu_links} WHERE link_path = :link_path", array(':link_path' => $path))
->fetchField();
}
return $res;
}
/**
* Update the print_node_conf table to reflect the given attributes
* If updating to the default values, delete the record.
*
* @param $nid
* value of the nid field (primary key)
* @param $link
* value of the link field (0 or 1)
* @param $comments
* value of the comments field (0 or 1)
* @param $url_list
* value of the url_list field (0 or 1)
*/
function _print_node_conf_modify($nid, $link, $comments, $url_list) {
if (($link == PRINT_TYPE_SHOW_LINK_DEFAULT) && ($comments == PRINT_TYPE_COMMENT_LINK_DEFAULT) &&
($url_list == PRINT_TYPE_URLLIST_DEFAULT)) {
db_delete('print_node_conf')
->condition('nid', $nid)
->execute();
}
else {
db_merge('print_node_conf')
->key(array('nid' => $nid))
->fields(array(
'link' => $link,
'comments' => $comments,
'url_list' => $url_list,
))
->execute();
Matt Westgate
committed
}
* Auxiliary function to fill the Printer-friendly link attributes
* @param $title
* text to displayed by the link when hovering over it with the mouse
* @param $class
* class attribute to be used in the link
* @param $new_window
* if TRUE opens the target page in a new window
João Ventura
committed
function print_fill_attributes($title = '', $class = '', $new_window = FALSE) {
$print_newwindow = variable_get('print_newwindow', PRINT_NEWWINDOW_DEFAULT);
$print_robots_noindex = variable_get('print_robots_noindex', PRINT_ROBOTS_NOINDEX_DEFAULT);
$attributes = array();
$attributes['title'] = $title;
if (!empty($class)) {
$attributes['class'] = $class;
}
João Ventura
committed
if ($new_window) {
switch ($print_newwindow) {
João Ventura
committed
case 0:
$attributes['target'] = '_blank';
break;
case 1:
$attributes['onclick'] = 'window.open(this.href); return false';
break;
}
if (!empty($print_robots_noindex)) {
/**
* Auxiliary function to set the link text and html flag
*
* @param $type
* type of link: 0 or 1 for a text-only link, 2 for icon-only and 3 for
* both text and icon
* @param $text
* text to be displayed on the link to the printer-friendly page
* @param $img
* path to the icon file
* @return
* array with the link text and html flag
*/
function _print_format_link_aux($type = 0, $text = '', $img = '') {
if ($type >= 2) {
$html = TRUE;
switch ($type) {
case 2:
$text = theme('image', $img, $text, $text, array('class' => 'print-icon'));
$text = theme('image', $img, $text, $text, array('class' => 'print-icon print-icon-margin')) . $text;
break;
}
}
else {
$html = FALSE;
}
return array('text' => $text,
'html' => $html,
João Ventura
committed
);
/**
* Format the Printer-friendly link
*
* @return
* array of formatted attributes
* @ingroup themeable
*/
$print_html_link_class = variable_get('print_html_link_class', PRINT_HTML_LINK_CLASS_DEFAULT);
$print_html_new_window = variable_get('print_html_new_window', PRINT_HTML_NEW_WINDOW_DEFAULT);
$print_html_show_link = variable_get('print_html_show_link', PRINT_HTML_SHOW_LINK_DEFAULT);
$print_html_link_text = variable_get('print_html_link_text', t('Printer-friendly version'));
$img = drupal_get_path('module', 'print') .'/icons/print_icon.gif';
$title = t('Display a printer-friendly version of this page.');
$class = strip_tags($print_html_link_class);
$new_window = $print_html_new_window;
$format = _print_format_link_aux($print_html_show_link, $print_html_link_text, $img);
return array('text' => $format['text'],
'html' => $format['html'],
João Ventura
committed
'attributes' => print_fill_attributes($title, $class, $new_window),
João Ventura
committed
);
* Auxiliary function to display a formatted Printer-friendly link
*
* Function made available so that developers may call this function from
* their defined pages/blocks.
*
* @param $path
* path of the original page (optional). If not specified, the current URL
* @param $node
* an optional node object, to be used in defining the path, if used, the
* path argument is irrelevant
* @return
* string with the HTML link to the printer-friendly page
function print_insert_link($path = NULL, $node = NULL) {
if ($node !== NULL) {
$nid = $node->nid;
$path = 'node/'. $nid;
$allowed_type = print_link_allowed(array('node' => $node));
}
else {
$nid = preg_replace('!^node/!', '', $_GET['q']);
$path = $_GET['q'];
}
else {
$nid = NULL;
}
$allowed_type = print_link_allowed(array('path' => $path));
}
if ($allowed_type) {
if ($nid !== NULL) {
if ($allowed_type === PRINT_ALLOW_BOOK_LINK) {
$path = 'book/export/html/'. $nid;
if (variable_get('print_html_link_use_alias', PRINT_HTML_LINK_USE_ALIAS_DEFAULT)) {
$path = drupal_get_path_alias($path);
}
else {
$path = $nid;
}
}
$path = PRINT_PATH .'/'. $path;
$query = print_query_string_encode($_GET, array('q'));
drupal_add_css(drupal_get_path('module', 'print') .'/css/printlinks.css');
return '<span class="print_html">'. l($format['text'], $path, array('attributes' => $format['attributes'], 'query' => $query, 'absolute' => TRUE, 'html' => $format['html'])) .'</span>';
else {
return FALSE;
}
Matt Westgate
committed
}
/**
* Determine if the current page is enabled according to the visibility settings
*
* @param $visibility
* current visibility settings:
* 0 for show on every page except the listed pages
* 1 for show on only the listed pages
* @param $pages
* list of pages
* @return
* TRUE if it is enabled, FALSE otherwise
*/
function _print_page_match($visibility, $pages) {
if ($pages) {
if ($visibility == 2) {
return drupal_eval($pages);
}
$path = drupal_get_path_alias($_GET['q']);
$page_match = drupal_match_path($path, $pages);
if ($path != $_GET['q']) {
$page_match = $page_match || drupal_match_path($_GET['q'], $pages);
}
return !($visibility xor $page_match);
}
else {
return !$visibility;
}
}
/**
* Determine a the link to the PF version is allowed depending on all possible settings
*
* @param $args
* array containing the possible parameters:
* teaser, node, type, path
* @return
* FALSE if not allowed
* PRINT_ALLOW_NORMAL_LINK if a normal link is allowed
* PRINT_ALLOW_BOOK_LINK if a link is allowed in a book node
*/
function print_link_allowed($args) {
if (!empty($args['teaser']) || !user_access('access print')) {
// If showing only the teaser or the user is not allowed or link is disabled
return FALSE;
}
if (!empty($args['path'])) {
$nid = preg_replace('!^node/!', '', drupal_get_normal_path($args['path']));
if (is_numeric($nid)) {
if ($node_type === FALSE) {
if (isset($node->type)) {
$node_type = $node->type;
}
else {
$node_type = '';
}
}
// Node
$print_html_node_link_visibility = variable_get('print_html_node_link_visibility', PRINT_HTML_NODE_LINK_VISIBILITY_DEFAULT);
$print_html_node_link_pages = variable_get('print_html_node_link_pages', PRINT_HTML_NODE_LINK_PAGES_DEFAULT);
if (!empty($node->printing) ||
!_print_page_match($print_html_node_link_visibility, $print_html_node_link_pages)) {
// Page not in visibility list or we are working!
return FALSE;
}
elseif (isset($args['type']) && ($args['type'] == 'comment') && isset($node_type)) {
// Link is for a comment, return the configured setting
$res = db_query("SELECT comments FROM {print_node_conf} WHERE nid = :nid", array(':nid' => $node->nid))
->fetch();
$print_display_comment = $res ? intval($res->comments) : PRINT_TYPE_COMMENT_LINK_DEFAULT;
if (($print_display_comment) ||
variable_get('print_display_comment_'. $node_type, PRINT_TYPE_COMMENT_LINK_DEFAULT)) {
return PRINT_ALLOW_NORMAL_LINK;
}
if ((!$node->print_display) || (isset($node_type) &&
!variable_get('print_display_'. $node_type, PRINT_TYPE_SHOW_LINK_DEFAULT))) {
// Link for this node type is disabled
return FALSE;
}
elseif (isset($node->book)) {
// Node is a book;
$print_html_book_link = variable_get('print_html_book_link', PRINT_HTML_BOOK_LINK_DEFAULT);
switch ($print_html_book_link) {
case 1:
if (user_access('access printer-friendly version')) {
return PRINT_ALLOW_BOOK_LINK;
}
break;
case 2:
return PRINT_ALLOW_NORMAL_LINK;
}
}
else {
return PRINT_ALLOW_NORMAL_LINK;
}
}
}
else {
// 'System' page
$print_html_sys_link_visibility = variable_get('print_html_sys_link_visibility', PRINT_HTML_SYS_LINK_VISIBILITY_DEFAULT);
$print_html_sys_link_pages = variable_get('print_html_sys_link_pages', PRINT_HTML_SYS_LINK_PAGES_DEFAULT);
return _print_page_match($print_html_sys_link_visibility, $print_html_sys_link_pages);
}
/**
* Parse an array into a valid urlencoded query string.
* Modified from drupal_query_string_encode to prevent re-encoding of
* encoded original.
*
* @param $query
* The array to be processed e.g. $_GET
* @param $exclude
* The array filled with keys to be excluded.
* @return
* urlencoded string which can be appended to/as the URL query string
*/
function print_query_string_encode($query, $exclude = array(), $parent = '') {
$params = array();
foreach ($query as $key => $value) {
if ($parent) {
$key = $parent .'['. $key .']';
}
if (in_array($key, $exclude)) {
continue;
}
if (is_array($value)) {
João Ventura
committed
$params[] = print_query_string_encode($value, $exclude, $key);
}
else {
$params[] = $key .'='. rawurlencode($value);
}
return implode('&', $params);
}