Planet Node Type support
[All Implemented Hooks]

Defines a drupal node dedicated to planet feed items. More...

Collaboration diagram for Planet Node Type support:

Functions
	planet_node_info ()
	Implementation of hook_node_info.
	planet_view ($node, $teaser=FALSE, $page=FALSE)
	Implementation of hook_view() - Displays a planet node.
	planet_access ($op, $node, $account)
	Implementation of hook_access() - Define access permissions for planet nodes (aka CRUD) .
	planet_form (&$node, &$form_state)
	Implementation of hook_form - Display a node editing form.
	planet_item_feed_parse ($process_feed, $feed)
	Turn each feed item into a node.

---

Detailed Description

Defines a drupal node dedicated to planet feed items.

See also:

node_example

Note:

This group may not be easy to identify because our node type has the same name as the module: "planet".

---

Function Documentation

planet_access	(	$	op,
		$	node,
		$	account
	)

Implementation of hook_access() - Define access permissions for planet nodes (aka CRUD) .

Parameters:

	$op	The operation to be performed: 'create', 'view', 'update', 'delete'
	$node	The node on which the operation is to be performed, or, if it does not yet exist, the type of node to be created.
	$account	A user object representing the user for whom the operation is to be performed.

Returns:

true if the user is allowed to perform operation, false otherwise.

                                             {
  // @DIFFINFO using planet-dedicated permissions
  // Planet administrator has all permissions related to planet module
  if (user_access('administer planet', $account)) 
    return TRUE;
  // Users allowed to edit their own planet nodes, are also allowed to create them, others are not.
  $author = user_access('edit own planet feeds', $account);
  if ($op == 'create') {
    return $author;
  }
 
  // Does current user own requested node ?
  $own = $account->uid == $node->uid;
  if ($op == 'view')
    return $own || user_access('view all planet nodes');
  if ($op == 'update' || $op == 'delete') {
    return $author && $own;    // ok if $author owns the node
  }
  trigger_error("Unknown operation requested: $op");
  return FALSE;
}

Here is the call graph for this function:

planet_form	(	&$	node,
		&$	form_state
	)

Implementation of hook_form - Display a node editing form.

Parameters:

	&$node	The node being added or edited.
	$form_state	The form state array (unused).

Returns:

An array containing the form elements to be displayed in the node edit form.

                                           {
  $form = array();
  $form['title'] = array('#type' => 'textfield', '#title' => 'Title', '#value' => $node->title, '#size' => 30, '#maxlength' => 80);
  $form['body'] = array('#type' => 'textarea', '#title' => 'Body', '#value' => $node->body);
  return $form;
}

planet_item_feed_parse	(	$	process_feed,
		$	feed
	)

Turn each feed item into a node.

Parameters:

	$process_feed	Feed node object
	$feed	SimplePie feed object instantiated.

                                                      {
  // loop through all of the items in the feed, faster than foreach
  $max = $feed->get_item_quantity();
  $count = 0;
  module_load_include('inc', 'node', 'node.pages');
  module_load_include('inc', 'node', 'content_types');
  $node = node_get_types('type', 'feed_item');

  for ($i = 0; $i < $max; $i++) {
    $item = $feed->get_item($i);

    // we don't use $item->get_id(true) from SimplePie because it is slightly buggy
    // and requires a lot of overhead to compute each time (since it uses a gigantic array structure)
    // instead we opt for a much lighter weight comparison of just the title and body, eliminating the
    // possibility of any date changes or other tiny changes causing duplicate nodes that otherwise
    // appear to be the same
    // that is why the body and title processing appears out here, so we can check for duplicates
    // it is fast enough to not make much of a difference otherwise
    $body = $item->get_content();
    // this strips out any tags that may appear as <b> in the title, and makes sure &quot; -> " for display
    $title = strip_tags(decode_entities($item->get_title()));

    // some feeds don't provide titles so we construct one with the first 72 characters of the body
    if (!$title) {
      // remove any HTML or line breaks so these don't appear in the title
      $title = trim(str_replace(array("\n", "\r"), ' ', strip_tags($body)));
      $title = trim(substr($title, 0, 72));
      $lastchar = substr($title, -1, 1);
      // check to see if the last character in the title is a non-alphanumeric character, except for ? or !
      // if it is strip it off so you don't get strange looking titles
      if (preg_match('/[^0-9A-Za-z\!\?]/', $lastchar)) {
        $title = substr($title, 0, -1);
      }
      // ? and ! are ok to end a title with since they make sense
      if ($lastchar != '!' and $lastchar != '?') {
        $title .= '...';
      }
    }

    // unique id for each feed item, try and use item permalink, otherwise use feed permalink
    if (!$link = $item->get_permalink()) {
      $link = $feed->get_permalink();
    }
    // we don't need serialize() since we already have strings
    $iid = md5($title . $link);
    $guid = md5("$title - . " . $process_feed->fid);
    // make sure we don't already have this feed item
    $duplicate = db_result(db_query("SELECT COUNT(iid) FROM {planet_items} WHERE iid = '%s'", $iid));

    if (!$duplicate) {


    $entry = NULL;
    if ($guid && strlen($guid) > 0) {
      $entry = db_fetch_object(db_query("SELECT nid FROM {planet_items} WHERE guid = '%s' AND fid = %d", $guid, $process_feed->fid));
    }
    else if ($link && $link != $feed->link && $link != $feed->url) {
      $entry = db_fetch_object(db_query("SELECT nid FROM {planet_items} WHERE guid = '%s' AND fid = %d", $link, $process_feed->fid));
    }
    else {
      $entry = db_fetch_object(db_query("SELECT ai.nid AS nid FROM {node} n, {planet_items} ai WHERE ai.fid = %d AND ai.nid = n.nid AND n.title = '%s'", $process_feed->fid, $title));
    }

      $link = $item->get_permalink();
      // this is node created date format for Drupal
      $date = $item->get_date('Y-m-d H:i:s O');

      $entry->changed = $date;
      $entry->title = $title;
      $entry->body = $body;
      $entry->body = planet_convert_relative_urls($body, $link);
      $entry->teaser = node_teaser($entry->body);    
      $entry->revision = true;

      if (!isset($entry->nid)) {            
        //print "Planet item " . $entry->title . "<br />";
        $entry->type = 'planet';
 
        $options = variable_get('node_options_planet', array());

        $entry->uid = $process_feed->uid;
        $entry->status = 1;
        $entry->moderate = 0;
        $entry->promote = in_array('promote', $options) ? 1 : 0;
        $entry->sticky = in_array('sticky', $options) ? 1 : 0;
        $entry->comment = in_array('comment', $options) ? 2 : 0;
        $entry->format = variable_get('planet_filter_formats', 1);
        $entry->created = $date;
        $entry->revision = true;
   
      }  

      node_save($entry);
      $item_record = array('fid' => $process_feed->fid,
                           'nid' => $entry->nid,
                           'iid' => $iid,
                           'guid'=> $guid,
                           'link' =>$link,
                           'created' => time());
      drupal_write_record('planet_items', $item_record);            
      watchdog('planet', 'Adding '. $title);
      drupal_set_message('Adding '. $title);
    }

    // we unset $item each time to prevent any pass by reference memory leaks that PHP encounters with objects in foreach loops
    unset($item);
  }
  
}

Here is the call graph for this function:

Here is the caller graph for this function:

planet_node_info

(

)

Implementation of hook_node_info.

Returns:

An array of information on the module's node types.

                            {
  return array(
    'planet' => array(
      'name' => t('Planet Entry'),
      'module' => 'planet',
      'description' => t('Node to contain posts aggregated from various blogs.'),
    )
  );
}

Here is the call graph for this function:

planet_view	(	$	node,
		$	teaser = FALSE,
		$	page = FALSE
	)

Implementation of hook_view() - Displays a planet node.

Parameters:

	$node	The node to be displayed.
	$teaser	Whether to generate only a summary ("teaser") of the node.
	$page	Whether the node is being displayed as a standalone page.

Returns:

The modified $node parameter, properly presented for output.

DB @CRUD: variables[R]

DB @CRUD: planet_items[R]

                                                            {
  // @DIFFINFO removed $link param to match D6 hook definition
  if ($page === true && variable_get('planet_redirect_page', 0) == 1) {
    // @DIFFINFO only 'link' field is used, so I restricted the query 
    $obj = db_fetch_object(db_query('SELECT link FROM {planet_items} WHERE nid = %d', $node->nid));
    // @DIFFINFO if the query succeeds, $obj->nid == $node->nid , otherwise, $obj==FALSE,
    if ($obj && $obj->link != '') {
      header('Location: '. $obj->link);
      exit;
    }
  }
  else {
    return node_prepare($node, $teaser);
  }
}

Here is the call graph for this function: