Index: paging.module
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/paging/paging.module,v
retrieving revision 1.16
diff -u -p -r1.16 paging.module
--- paging.module	5 Jul 2008 06:09:49 -0000	1.16
+++ paging.module	17 Jul 2008 20:00:59 -0000
@@ -11,12 +11,12 @@
 function paging_help($path, $arg) {
   switch ($path) {
     case 'admin/help#paging':
-      return '<p>' . t('Break long pages into smaller ones by means of a page tag (e.g. %separator):</p>
+      return '<p>' . t('Break long pages into smaller ones by means of a page break tag (e.g. %separator):</p>
 <pre>First page here.
 %separator
 Second page here.
 %separator
-More pages here.', array('%separator' => '<!--pagebreak-->')) . '</p>';
+More pages here.', array('%separator' => '<!--pagebreak-->')) .'</pre><p>'. t('Automatic page breaking based on character or word count is also supported.') .'</p>';
       break;
   }
 }
@@ -26,88 +26,88 @@ More pages here.', array('%separator' =>
  */
 function paging_form_alter(&$form, $form_state, $form_id) {
   if ($form_id == 'node_type_form' && isset($form['identity']['type'])) {
-  $form['paging_config'] = array(
-    '#type' => 'fieldset',
-    '#title' => t('Paging'),
-    '#collapsible' => TRUE,
-    '#collapsed' => FALSE,
-  );
-  $form['paging_config']['paging_enabled'] = array(
-    '#type' => 'radios',
-    '#title' => t('Paging'),
-    '#default_value' => variable_get('paging_enabled_' . $form['#node_type']->type, 0),
-    '#options' => array(t('Disabled'), t('Enabled')),
-  );
-  $form['paging_config']['paging_separator'] = array(
-    '#type' => 'textfield',
-    '#title' => t('Separator'),
-    '#size' => 20,
-    '#maxlength' => 255,
-    '#required' => TRUE,
-    '#default_value' => variable_get('paging_separator_' . $form['#node_type']->type, '<!--pagebreak-->'),
-    '#description' => t('Page separator string. You should use an HTML tag that will render reasonably when paging is not enabled, such as %pagebreak or %hr.', array('%pagebreak' => '<!--pagebreak-->', '%hr' => '<hr />')),
-  );
-  $form['paging_config']['paging_read_more_enabled'] = array(
-    '#type' => 'checkbox',
-    '#title' => t('Link "Read more" to the second page'),
-    '#description' => t('If enabled, the "Read more" link under teasers will link to the 2nd page of the node. Implemented only when the teaser and the first page content is same.'),
-    '#default_value' => variable_get('paging_read_more_enabled_' . $form['#node_type']->type, 0),
-  );
-
-  $form['paging_config']['paging_automatic'] = array(
-    '#type' => 'fieldset',
-    '#title' => t('Automatic Paging'),
-    '#collapsible' => TRUE,
-    '#collapsed' => TRUE,
-    '#description' => t('Automatic paging is disabled when both methods below are disabled, or when the node already contains the page break separator. Automatic paging by line break is preferred over the method of automatic paging by words.'),
-  );
-
-  $form['paging_config']['paging_automatic']['paging_paragraph'] = array(
-    '#type' => 'fieldset',
-    '#title' => t('By line break'),
-    '#collapsed' => FALSE,
-    '#prefix' => '<div class="container-inline">',
-  );
-  $form['paging_config']['paging_automatic']['paging_paragraph']['paging_automatic_chars'] = array(
-    '#type' => 'select',
-    '#title' => t('Length of each page'),
-    '#options' => array(0 => t('Disabled'),
-      500 => t('500 characters'), 750 => t('750 characters'),
-      1000 => t('1000 characters'), 1500 => t('1500 characters'),
-      2000 => t('2000 characters'), 2500 => t('2500 characters'),
-      3000 => t('3000 characters'), 3500 => t('3500 characters'),
-      4000 => t('4000 characters'), 4500 => t('4500 characters'),
-      5000 => t('5000 characters'), 5500 => t('5500 characters'),
-      6000 => t('6000 characters'), 6500 => t('6500 characters'),
-      7000 => t('7000 characters'), 7500 => t('7500 characters'),
-    ),
-    '#required' => TRUE,
-    '#description' => '<br />' . t('Set the number of characters that should be displayed per page. <strong>This is the recommended method</strong> for automatic paging.'),
-    '#default_value' => variable_get('paging_automatic_chars_' . $form['#node_type']->type, 0),
-  );
-
-  $form['paging_config']['paging_automatic']['paging_words'] = array(
-    '#type' => 'fieldset',
-    '#title' => t('By words'),
-    '#collapsed' => FALSE,
-  );
-  $form['paging_config']['paging_automatic']['paging_words']['paging_automatic_words'] = array(
-    '#type' => 'select',
-    '#title' => t('Length of each page'),
-    '#options' => array(0 => t('Disabled'),
-      50 => t('100 words'), 150 => t('150 words'),
-      200 => t('200 words'), 250 => t('250 words'),
-      300 => t('300 words'), 350 => t('350 words'),
-      400 => t('400 words'), 450 => t('450 words'),
-      500 => t('500 words'), 550 => t('550 words'),
-      600 => t('600 words'), 650 => t('650 words'),
-      700 => t('700 words'), 750 => t('750 words'),
-    ),
-    '#required' => TRUE,
-    '#description' => '<br />' . t('Set the number of words that should be displayed per page. This may break your sentences at page breaks.'),
-    '#default_value' => variable_get('paging_automatic_words_' . $form['#node_type']->type, 0),
-    '#suffix' => '</div>',
-  );
+    $form['paging_config'] = array(
+      '#type' => 'fieldset',
+      '#title' => t('Paging'),
+      '#collapsible' => TRUE,
+      '#collapsed' => FALSE,
+    );
+    $form['paging_config']['paging_enabled'] = array(
+      '#type' => 'radios',
+      '#title' => t('Paging'),
+      '#default_value' => variable_get('paging_enabled_' . $form['#node_type']->type, 0),
+      '#options' => array(t('Disabled'), t('Enabled')),
+    );
+    $form['paging_config']['paging_separator'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Separator'),
+      '#size' => 20,
+      '#maxlength' => 255,
+      '#required' => TRUE,
+      '#default_value' => variable_get('paging_separator_' . $form['#node_type']->type, '<!--pagebreak-->'),
+      '#description' => t('Page separator string. You should use an HTML tag that will render reasonably when paging is not enabled, such as %pagebreak or %hr.', array('%pagebreak' => '<!--pagebreak-->', '%hr' => '<hr />')),
+    );
+    $form['paging_config']['paging_read_more_enabled'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Link "Read more" to the second page'),
+      '#description' => t('If enabled, the "Read more" link under teasers will link to the 2nd page of the node. Implemented only when the teaser and the first page content is same.'),
+      '#default_value' => variable_get('paging_read_more_enabled_' . $form['#node_type']->type, 0),
+    );
+
+    $form['paging_config']['paging_automatic'] = array(
+      '#type' => 'fieldset',
+      '#title' => t('Automatic Paging'),
+      '#collapsible' => TRUE,
+      '#collapsed' => TRUE,
+      '#description' => t('Automatic paging is disabled when both methods below are disabled, or when the node already contains the page break separator. Automatic paging by line break is preferred over the method of automatic paging by words.'),
+    );
+
+    $form['paging_config']['paging_automatic']['paging_paragraph'] = array(
+      '#type' => 'fieldset',
+      '#title' => t('By line break'),
+      '#collapsed' => FALSE,
+      '#prefix' => '<div class="container-inline">',
+    );
+    $form['paging_config']['paging_automatic']['paging_paragraph']['paging_automatic_chars'] = array(
+      '#type' => 'select',
+      '#title' => t('Length of each page'),
+      '#options' => array(0 => t('Disabled'),
+        500 => t('500 characters'), 750 => t('750 characters'),
+        1000 => t('1000 characters'), 1500 => t('1500 characters'),
+        2000 => t('2000 characters'), 2500 => t('2500 characters'),
+        3000 => t('3000 characters'), 3500 => t('3500 characters'),
+        4000 => t('4000 characters'), 4500 => t('4500 characters'),
+        5000 => t('5000 characters'), 5500 => t('5500 characters'),
+        6000 => t('6000 characters'), 6500 => t('6500 characters'),
+        7000 => t('7000 characters'), 7500 => t('7500 characters'),
+      ),
+      '#required' => TRUE,
+      '#description' => '<br />' . t('Set the number of characters that should be displayed per page. <strong>This is the recommended method</strong> for automatic paging.'),
+      '#default_value' => variable_get('paging_automatic_chars_' . $form['#node_type']->type, 0),
+    );
+
+    $form['paging_config']['paging_automatic']['paging_words'] = array(
+      '#type' => 'fieldset',
+      '#title' => t('By words'),
+      '#collapsed' => FALSE,
+    );
+    $form['paging_config']['paging_automatic']['paging_words']['paging_automatic_words'] = array(
+      '#type' => 'select',
+      '#title' => t('Length of each page'),
+      '#options' => array(0 => t('Disabled'),
+        50 => t('100 words'), 150 => t('150 words'),
+        200 => t('200 words'), 250 => t('250 words'),
+        300 => t('300 words'), 350 => t('350 words'),
+        400 => t('400 words'), 450 => t('450 words'),
+        500 => t('500 words'), 550 => t('550 words'),
+        600 => t('600 words'), 650 => t('650 words'),
+        700 => t('700 words'), 750 => t('750 words'),
+      ),
+      '#required' => TRUE,
+      '#description' => '<br />' . t('Set the number of words that should be displayed per page. This may break your sentences at page breaks.'),
+      '#default_value' => variable_get('paging_automatic_words_' . $form['#node_type']->type, 0),
+      '#suffix' => '</div>',
+    );
   }
 }
 
@@ -120,13 +120,15 @@ function paging_nodeapi(&$node, $op, $te
       case 'load':
       case 'view':
       case 'alter':
-        if (isset($node->field_body[0]['view'])) { // support for CCK
+        // Support for CCK.
+        if (isset($node->field_body[0]['view'])) {
           _paging_nodeapi($node,
                           $node->field_body[0]['view'],
                           $node->field_teaser[0]['view'],
                           $op, $teaser, $page);
         }
-        elseif (isset($node->field_body[0]['value'])) { // support for CCK
+        elseif (isset($node->field_body[0]['value'])) { 
+          // Support for CCK.
           _paging_nodeapi($node,
                           $node->field_body[0]['value'],
                           $node->field_teaser[0]['value'],
@@ -147,20 +149,22 @@ function paging_nodeapi(&$node, $op, $te
 /**
  * Helper function for paging_nodeapi().
  */
-function _paging_nodeapi(&$node, &$nodebody, &$nodeteaser, $op, $teaser, $page) {
+function _paging_nodeapi(&$node, &$node_body, &$node_teaser, $op, $teaser, $page) {
   switch ($op) {
     case 'load':
       $paging_separator = variable_get('paging_separator_' . $node->type, '<!--pagebreak-->');
-      if (strpos($teaser ? $nodeteaser : $nodebody, $paging_separator) !== FALSE) {
-        $node->pages = explode($paging_separator, $nodebody);
+      if (strpos($teaser ? $node_teaser : $node_body, $paging_separator) !== FALSE) {
+        // Manual page separators were used.
+        $node->pages = explode($paging_separator, $node_body);
         $node->page_count = count($node->pages);
       }
       else {
-        $body_parts = $nodebody;
+        $body_parts = $node_body;
         if (($max_chars = variable_get('paging_automatic_chars_' . $node->type, 0)) != 0) {
-          $total_chars = strlen($nodebody);
+          // Automatic paging based on character count.
+          $total_chars = strlen($node_body);
           if ($total_chars > $max_chars) {
-            $body = $nodebody;
+            $body = $node_body;
             $breaks = (int)($total_chars / $max_chars);
             $bodypart = array();
             for ($i = 0; $i <= $breaks; $i++) {
@@ -172,7 +176,8 @@ function _paging_nodeapi(&$node, &$nodeb
           }
         }
         elseif (($max_words = variable_get('paging_automatic_words_' . $node->type, 0)) != 0) {
-          $words = explode(' ', $nodebody);
+          // Automatic paging based on word count.
+          $words = explode(' ', $node_body);
           $total_words = count($words);
           if ($total_words > $max_words) {
             $breaks = (int)($total_words / $max_words);
@@ -188,7 +193,7 @@ function _paging_nodeapi(&$node, &$nodeb
       }
       break;
     case 'view':
-      if ($teaser && !$node->in_preview && strpos($nodeteaser, '<!--paging_filter-->') !== FALSE) {
+      if ($teaser && !($node->build_mode == NODE_BUILD_PREVIEW) && strpos($node_teaser, '<!--paging_filter-->') !== FALSE) {
         // Check to see if the teaser is longer than our first page.
         if ($node->page_count > 1 && strlen($node->teaser) > strlen($node->pages[0])) {
           $node->content['body']['#value'] = check_markup($node->pages[0], $node->format, false);
@@ -197,9 +202,12 @@ function _paging_nodeapi(&$node, &$nodeb
       }
       break;
     case 'alter':
-      if (!$node->in_preview && strpos($teaser ? $nodeteaser : $nodebody, '<!--paging_filter-->') !== FALSE) {
+      if (!($node->build_mode == NODE_BUILD_PREVIEW) && strpos($teaser ? $node_teaser : $node_body, '<!--paging_filter-->') !== FALSE) {
         $element = 1;
         $page = isset($_GET['page']) ? $_GET['page'] : '';
+        // Only do paging if not in teaser mode, if there is more than one page,
+        // if a printable version is not being requested and if a nonpaged version
+        // is not being explicitly requested, e.g. http://example.com/node/1?page=full
         if (!$teaser && $node->page_count > 1 && arg(2) != 'print' && arg(2) != 'full' && $page != 'full') {
           global $pager_page_array, $pager_total;
           $pager_page_array = explode(',', $page);
@@ -213,7 +221,7 @@ function _paging_nodeapi(&$node, &$nodeb
         }
         else if ($teaser) {
           // Remove internal <!--paging_filter--> tag from final output.
-          $nodeteaser = str_replace('<!--paging_filter-->', '', $nodeteaser);
+          $node_teaser = str_replace('<!--paging_filter-->', '', $node_teaser);
         }
       }
       break;
@@ -223,22 +231,16 @@ function _paging_nodeapi(&$node, &$nodeb
 /**
  * Implementation of hook_link().
  */
-function paging_link($type, $node = 0, $main = 0) {
+function paging_link($type, $node = NULL, $teaser = FALSE) {
   $links = array();
 
-  if ($type == 'node') {
-    if (array_key_exists('links', $node)) {
-      $links = $node->links;
-    }
-
-    if ($main == 1 && $node->teaser && $node->pagemore && variable_get('paging_read_more_enabled_' . $node->type, 0)) {
-      $links['paging_read_more'] = array(
-        'title' => t('Read more'),
-        'href' => drupal_get_path_alias("node/$node->nid"),
-        'attributes' => array('title' => t('Read the rest of this posting.'), 'class' => 'read-more-paging'),
-        'query' => 'page=0,1'
-      );
-    }
+  if ($type == 'node' && $teaser && $node->teaser && $node->pagemore && variable_get('paging_read_more_enabled_' . $node->type, 0)) {
+    $links['paging_read_more'] = array(
+      'title' => t('Read more'),
+      'href' => drupal_get_path_alias("node/$node->nid"),
+      'attributes' => array('title' => t('Read the rest of this posting.'), 'class' => 'read-more-paging'),
+      'query' => 'page=0,1'
+    ); 
   }
 
   return $links;
@@ -248,7 +250,7 @@ function paging_link($type, $node = 0, $
  * Implementation of hook_link_alter().
  */
 function paging_link_alter(&$links, $node) {
-  if ($node->teaser && $node->pagemore && variable_get('paging_read_more_enabled_' . $node->type, 0)) {
+  if (!empty($node->teaser) && $node->pagemore && variable_get('paging_read_more_enabled_' . $node->type, 0)) {
     unset($links['node_read_more']);
   }
 }
@@ -262,11 +264,11 @@ function paging_filter($in_op, $in_delta
       return array(t('Paging'));
       break;
     case 'description':
-      return t('Allows content to be broken up into pages, using a separator tag (e.g. %separator), configurable <a href="!url">here</a>.', array('%separator' => '<!--pagebreak-->', '!url' => url('admin/settings/paging')));
+      return t('Allows content to be broken up into pages, using a separator tag (e.g. %separator), configurable on the <a href="!url">settings page</a> for each content type.', array('%separator' => '<!--pagebreak-->', '!url' => url('admin/content/types')));
       break;
     case 'process':
-      // the filter gets called before the nodeapi 'view' so,
-      // add a comment to the body to inform the nodapi to apply the filter
+      // The filter gets called before the nodeapi 'view' so,
+      // add a comment to the body to inform the nodeapi hook to apply the filter.
       return '<!--paging_filter-->' . $in_text;
       break;
     default:
@@ -278,15 +280,11 @@ function paging_filter($in_op, $in_delta
 /**
  * Implementation of hook_filter_tips().
  */
-function paging_filter_tips($in_delta, $in_format, $in_is_long = FALSE) {
-  if ($in_is_long) {
+function paging_filter_tips($delta, $format, $long = FALSE) {
+  if ($long) {
     return '<h1>' . t('Paging Help') . '</h1>' . paging_help('admin/help#paging');
   }
   else {
     return t('Use %separator to create page breaks.', array('%separator' => $GLOBALS['paging_sep']));
   }
-}
-
-function d($msg) {
-  drupal_set_message('<pre>' . print_r($msg, TRUE) . '</pre>');
-}
+}
\ No newline at end of file