<?php

/**

 * @file

 * Tests for aggregator.module.

 */

/**

 * Defines a base class for testing the Aggregator module.

 */

class AggregatorTestCase extends DrupalWebTestCase {

  function setUp() {

    parent::setUp('aggregator', 'aggregator_test');

    $web_user = $this->drupalCreateUser(array('administer news feeds', 'access news feeds', 'create article content'));

    $this->drupalLogin($web_user);

  }

  /**

   * Creates an aggregator feed.

   *

   * This method simulates the form submission on path

   * admin/config/services/aggregator/add/feed.

   *

   * @param $feed_url

   *   (optional) If given, feed will be created with this URL, otherwise

   *   /rss.xml will be used. Defaults to NULL.

   *

   * @return $feed

   *   Full feed object if possible.

   *

   * @see getFeedEditArray()

   */

  function createFeed($feed_url = NULL) {

    $edit = $this->getFeedEditArray($feed_url);

    $this->drupalPost('admin/config/services/aggregator/add/feed', $edit, t('Save'));

    $this->assertRaw(t('The feed %name has been added.', array('%name' => $edit['title'])), format_string('The feed !name has been added.', array('!name' => $edit['title'])));

    $feed = db_query("SELECT *  FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $edit['title'], ':url' => $edit['url']))->fetch();

    $this->assertTrue(!empty($feed), 'The feed found in database.');

    return $feed;

  }

  /**

   * Deletes an aggregator feed.

   *

   * @param $feed

   *   Feed object representing the feed.

   */

  function deleteFeed($feed) {

    $this->drupalPost('admin/config/services/aggregator/edit/feed/' . $feed->fid, array(), t('Delete'));

    $this->assertRaw(t('The feed %title has been deleted.', array('%title' => $feed->title)), 'Feed deleted successfully.');

  }

  /**

   * Returns a randomly generated feed edit array.

   *

   * @param $feed_url

   *   (optional) If given, feed will be created with this URL, otherwise

   *   /rss.xml will be used. Defaults to NULL.

   * @return

   *   A feed array.

   */

  function getFeedEditArray($feed_url = NULL) {

    $feed_name = $this->randomName(10);

    if (!$feed_url) {

      $feed_url = url('rss.xml', array(

        'query' => array('feed' => $feed_name),

        'absolute' => TRUE,

      ));

    }

    $edit = array(

      'title' => $feed_name,

      'url' => $feed_url,

      'refresh' => '900',

    );

    return $edit;

  }

  /**

   * Returns the count of the randomly created feed array.

   *

   * @return

   *   Number of feed items on default feed created by createFeed().

   */

  function getDefaultFeedItemCount() {

    // Our tests are based off of rss.xml, so let's find out how many elements should be related.

    $feed_count = db_query_range('SELECT COUNT(*) FROM {node} n WHERE n.promote = 1 AND n.status = 1', 0, variable_get('feed_default_items', 10))->fetchField();

    return $feed_count > 10 ? 10 : $feed_count;

  }

  /**

   * Updates the feed items.

   *

   * This method simulates a click to

   * admin/config/services/aggregator/update/$fid.

   *

   * @param $feed

   *   Feed object representing the feed, passed by reference.

   * @param $expected_count

   *   Expected number of feed items.

   */

  function updateFeedItems(&$feed, $expected_count) {

    // First, let's ensure we can get to the rss xml.

    $this->drupalGet($feed->url);

    $this->assertResponse(200, format_string('!url is reachable.', array('!url' => $feed->url)));

    // Attempt to access the update link directly without an access token.

    $this->drupalGet('admin/config/services/aggregator/update/' . $feed->fid);

    $this->assertResponse(403);

    // Refresh the feed (simulated link click).

    $this->drupalGet('admin/config/services/aggregator');

    $this->clickLink('update items');

    // Ensure we have the right number of items.

    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid));

    $items = array();

    $feed->items = array();

    foreach ($result as $item) {

      $feed->items[] = $item->iid;

    }

    $feed->item_count = count($feed->items);

    $this->assertEqual($expected_count, $feed->item_count, format_string('Total items in feed equal to the total items in database (!val1 != !val2)', array('!val1' => $expected_count, '!val2' => $feed->item_count)));

  }

  /**

   * Confirms an item removal from a feed.

   *

   * @param $feed

   *   Feed object representing the feed.

   */

  function removeFeedItems($feed) {

    $this->drupalPost('admin/config/services/aggregator/remove/' . $feed->fid, array(), t('Remove items'));

    $this->assertRaw(t('The news items from %title have been removed.', array('%title' => $feed->title)), 'Feed items removed.');

  }

  /**

   * Adds and removes feed items and ensure that the count is zero.

   *

   * @param $feed

   *   Feed object representing the feed.

   * @param $expected_count

   *   Expected number of feed items.

   */

  function updateAndRemove($feed, $expected_count) {

    $this->updateFeedItems($feed, $expected_count);

    $count = db_query('SELECT COUNT(*) FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid))->fetchField();

    $this->assertTrue($count);

    $this->removeFeedItems($feed);

    $count = db_query('SELECT COUNT(*) FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed->fid))->fetchField();

    $this->assertTrue($count == 0);

  }

  /**

   * Pulls feed categories from {aggregator_category_feed} table.

   *

   * @param $feed

   *   Feed object representing the feed.

   */

  function getFeedCategories($feed) {

    // add the categories to the feed so we can use them

    $result = db_query('SELECT cid FROM {aggregator_category_feed} WHERE fid = :fid', array(':fid' => $feed->fid));

    foreach ($result as $category) {

      $feed->categories[] = $category->cid;

    }

  }

  /**

   * Pulls categories from {aggregator_category} table.

   *

   * @return

   *   An associative array keyed by category ID and values are set to the

   *   category names.

   */

  function getCategories() {

    $categories = array();

    $result = db_query('SELECT * FROM {aggregator_category}');

    foreach ($result as $category) {

      $categories[$category->cid] = $category;

    }

    return $categories;

  }

  /**

   * Checks whether the feed name and URL are unique.

   *

   * @param $feed_name

   *   String containing the feed name to check.

   * @param $feed_url

   *   String containing the feed URL to check.

   *

   * @return

   *   TRUE if feed is unique.

   */

  function uniqueFeed($feed_name, $feed_url) {

    $result = db_query("SELECT COUNT(*) FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $feed_name, ':url' => $feed_url))->fetchField();

    return (1 == $result);

  }

  /**

   * Creates a valid OPML file from an array of feeds.

   *

   * @param $feeds

   *   An array of feeds.

   *

   * @return

   *   Path to valid OPML file.

   */

  function getValidOpml($feeds) {

    // Properly escape URLs so that XML parsers don't choke on them.

    foreach ($feeds as &$feed) {

      $feed['url'] = htmlspecialchars($feed['url']);

    }

    /**

     * Does not have an XML declaration, must pass the parser.

     */

    $opml = <<<EOF

<opml version="1.0">

  <head></head>

  <body>

    <!-- First feed to be imported. -->

    <outline text="{$feeds[0]['title']}" xmlurl="{$feeds[0]['url']}" />

    <!-- Second feed. Test string delimitation and attribute order. -->

    <outline xmlurl='{$feeds[1]['url']}' text='{$feeds[1]['title']}'/>

    <!-- Test for duplicate URL and title. -->

    <outline xmlurl="{$feeds[0]['url']}" text="Duplicate URL"/>

    <outline xmlurl="http://duplicate.title" text="{$feeds[1]['title']}"/>

    <!-- Test that feeds are only added with required attributes. -->

    <outline text="{$feeds[2]['title']}" />

    <outline xmlurl="{$feeds[2]['url']}" />

  </body>

</opml>

EOF;

    $path = 'public://valid-opml.xml';

    return file_unmanaged_save_data($opml, $path);

  }

  /**

   * Creates an invalid OPML file.

   *

   * @return

   *   Path to invalid OPML file.

   */

  function getInvalidOpml() {

    $opml = <<<EOF

<opml>

  <invalid>

</opml>

EOF;

    $path = 'public://invalid-opml.xml';

    return file_unmanaged_save_data($opml, $path);

  }

  /**

   * Creates a valid but empty OPML file.

   *

   * @return

   *   Path to empty OPML file.

   */

  function getEmptyOpml() {

    $opml = <<<EOF

<?xml version="1.0" encoding="utf-8"?>

<opml version="1.0">

  <head></head>

  <body>

    <outline text="Sample text" />

    <outline text="Sample text" url="Sample URL" />

  </body>

</opml>

EOF;

    $path = 'public://empty-opml.xml';

    return file_unmanaged_save_data($opml, $path);

  }

  function getRSS091Sample() {

    return $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'aggregator') . '/tests/aggregator_test_rss091.xml';

  }

  function getAtomSample() {

    // The content of this sample ATOM feed is based directly off of the

    // example provided in RFC 4287.

    return $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'aggregator') . '/tests/aggregator_test_atom.xml';

  }

  function getHtmlEntitiesSample() {

    return $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'aggregator') . '/tests/aggregator_test_title_entities.xml';

  }

  /**

   * Creates sample article nodes.

   *

   * @param $count

   *   (optional) The number of nodes to generate. Defaults to five.

   */

  function createSampleNodes($count = 5) {

    $langcode = LANGUAGE_NONE;

    // Post $count article nodes.

    for ($i = 0; $i < $count; $i++) {

      $edit = array();

      $edit['title'] = $this->randomName();

      $edit["body[$langcode][0][value]"] = $this->randomName();

      $this->drupalPost('node/add/article', $edit, t('Save'));

    }

  }

}

/**

 * Tests functionality of the configuration settings in the Aggregator module.

 */

class AggregatorConfigurationTestCase extends AggregatorTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Aggregator configuration',

      'description' => 'Test aggregator settings page.',

      'group' => 'Aggregator',

    );

  }

  /**

   * Tests the settings form to ensure the correct default values are used.

   */

  function testSettingsPage() {

    $edit = array(

      'aggregator_allowed_html_tags' => '<a>',

      'aggregator_summary_items' => 10,

      'aggregator_clear' => 3600,

      'aggregator_category_selector' => 'select',

      'aggregator_teaser_length' => 200,

    );

    $this->drupalPost('admin/config/services/aggregator/settings', $edit, t('Save configuration'));

    $this->assertText(t('The configuration options have been saved.'));

    foreach ($edit as $name => $value) {

      $this->assertFieldByName($name, $value, format_string('"@name" has correct default value.', array('@name' => $name)));

    }

  }

}

/**

 * Tests adding aggregator feeds.

 */

class AddFeedTestCase extends AggregatorTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Add feed functionality',

      'description' => 'Add feed test.',

      'group' => 'Aggregator'

    );

  }

  /**

   * Creates and ensures that a feed is unique, checks source, and deletes feed.

   */

  function testAddFeed() {

    $feed = $this->createFeed();

    // Check feed data.

    $this->assertEqual($this->getUrl(), url('admin/config/services/aggregator/add/feed', array('absolute' => TRUE)), 'Directed to correct url.');

    $this->assertTrue($this->uniqueFeed($feed->title, $feed->url), 'The feed is unique.');

    // Check feed source.

    $this->drupalGet('aggregator/sources/' . $feed->fid);

    $this->assertResponse(200, 'Feed source exists.');

    $this->assertText($feed->title, 'Page title');

    $this->drupalGet('aggregator/sources/' . $feed->fid . '/categorize');

    $this->assertResponse(200, 'Feed categorization page exists.');

    // Delete feed.

    $this->deleteFeed($feed);

  }

  /**

   * Tests feeds with very long URLs.

   */

  function testAddLongFeed() {

    // Create a feed with a URL of > 255 characters.

    $long_url = "https://www.google.com/search?ix=heb&sourceid=chrome&ie=UTF-8&q=angie+byron#sclient=psy-ab&hl=en&safe=off&source=hp&q=angie+byron&pbx=1&oq=angie+byron&aq=f&aqi=&aql=&gs_sm=3&gs_upl=0l0l0l10534l0l0l0l0l0l0l0l0ll0l0&bav=on.2,or.r_gc.r_pw.r_cp.,cf.osb&fp=a70b6b1f0abe28d8&biw=1629&bih=889&ix=heb";

    $feed = $this->createFeed($long_url);

    // Create a second feed of > 255 characters, where the only difference is

    // after the 255th character.

    $long_url_2 = "https://www.google.com/search?ix=heb&sourceid=chrome&ie=UTF-8&q=angie+byron#sclient=psy-ab&hl=en&safe=off&source=hp&q=angie+byron&pbx=1&oq=angie+byron&aq=f&aqi=&aql=&gs_sm=3&gs_upl=0l0l0l10534l0l0l0l0l0l0l0l0ll0l0&bav=on.2,or.r_gc.r_pw.r_cp.,cf.osb&fp=a70b6b1f0abe28d8&biw=1629&bih=889";

    $feed_2 = $this->createFeed($long_url_2);

    // Check feed data.

    $this->assertTrue($this->uniqueFeed($feed->title, $feed->url), 'The first long URL feed is unique.');

    $this->assertTrue($this->uniqueFeed($feed_2->title, $feed_2->url), 'The second long URL feed is unique.');

    // Check feed source.

    $this->drupalGet('aggregator/sources/' . $feed->fid);

    $this->assertResponse(200, 'Long URL feed source exists.');

    $this->assertText($feed->title, 'Page title');

    $this->drupalGet('aggregator/sources/' . $feed->fid . '/categorize');

    $this->assertResponse(200, 'Long URL feed categorization page exists.');

    // Delete feeds.

    $this->deleteFeed($feed);

    $this->deleteFeed($feed_2);

  }

}

/**

 * Tests the categorize feed functionality in the Aggregator module.

 */

class CategorizeFeedTestCase extends AggregatorTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Categorize feed functionality',

      'description' => 'Categorize feed test.',

      'group' => 'Aggregator'

    );

  }

  /**

   * Creates a feed and makes sure you can add/delete categories to it.

   */

  function testCategorizeFeed() {

    // Create 2 categories.

    $category_1 = array('title' => $this->randomName(10), 'description' => '');

    $this->drupalPost('admin/config/services/aggregator/add/category', $category_1, t('Save'));

    $this->assertRaw(t('The category %title has been added.', array('%title' => $category_1['title'])), format_string('The category %title has been added.', array('%title' => $category_1['title'])));

    $category_2 = array('title' => $this->randomName(10), 'description' => '');

    $this->drupalPost('admin/config/services/aggregator/add/category', $category_2, t('Save'));

    $this->assertRaw(t('The category %title has been added.', array('%title' => $category_2['title'])), format_string('The category %title has been added.', array('%title' => $category_2['title'])));

    // Get categories from database.

    $categories = $this->getCategories();

    // Create a feed and assign 2 categories to it.

    $feed = $this->getFeedEditArray();

    $feed['block'] = 5;

    foreach ($categories as $cid => $category) {

      $feed['category'][$cid] = $cid;

    }

    // Use aggregator_save_feed() function to save the feed.

    aggregator_save_feed($feed);

    $db_feed = db_query("SELECT *  FROM {aggregator_feed} WHERE title = :title AND url = :url", array(':title' => $feed['title'], ':url' => $feed['url']))->fetch();

    // Assert the feed has two categories.

    $this->getFeedCategories($db_feed);

    $this->assertEqual(count($db_feed->categories), 2, 'Feed has 2 categories');

    // Use aggregator_save_feed() to delete a category.

    $category = reset($categories);

    aggregator_save_category(array('cid' => $category->cid));

    // Assert that category is deleted.

    $db_category = db_query("SELECT COUNT(*) FROM {aggregator_category} WHERE cid = :cid", array(':cid' => $category->cid))->fetchField();

    $this->assertFalse($db_category, format_string('The category %title has been deleted.', array('%title' => $category->title)));

    // Assert that category has been removed from feed.

    $categorized_feeds = db_query("SELECT COUNT(*) FROM {aggregator_category_feed} WHERE cid = :cid", array(':cid' => $category->cid))->fetchField();

    $this->assertFalse($categorized_feeds, format_string('The category %title has been removed from feed %feed_title.', array('%title' => $category->title, '%feed_title' => $feed['title'])));

    // Assert that no broken links (associated with the deleted category)

    // appear on one of the other category pages.

    $this->createSampleNodes();

    $this->drupalGet('admin/config/services/aggregator');

    $this->clickLink('update items');

    $categories = $this->getCategories();

    $category = reset($categories);

    $this->drupalGet('aggregator/categories/' . $category->cid);

    global $base_path;

    $this->assertNoRaw('<a href="' . $base_path . 'aggregator/categories/"></a>,');

  }

}

/**

 * Tests functionality of updating the feed in the Aggregator module.

 */

class UpdateFeedTestCase extends AggregatorTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Update feed functionality',

      'description' => 'Update feed test.',

      'group' => 'Aggregator'

    );

  }

  /**

   * Creates a feed and attempts to update it.

   */

  function testUpdateFeed() {

    $remamining_fields = array('title', 'url', '');

    foreach ($remamining_fields as $same_field) {

      $feed = $this->createFeed();

      // Get new feed data array and modify newly created feed.

      $edit = $this->getFeedEditArray();

      $edit['refresh'] =  1800; // Change refresh value.

      if (isset($feed->{$same_field})) {

        $edit[$same_field] = $feed->{$same_field};

      }

      $this->drupalPost('admin/config/services/aggregator/edit/feed/' . $feed->fid, $edit, t('Save'));

      $this->assertRaw(t('The feed %name has been updated.', array('%name' => $edit['title'])), format_string('The feed %name has been updated.', array('%name' => $edit['title'])));

      // Check feed data.

      $this->assertEqual($this->getUrl(), url('admin/config/services/aggregator/', array('absolute' => TRUE)));

      $this->assertTrue($this->uniqueFeed($edit['title'], $edit['url']), 'The feed is unique.');

      // Check feed source.

      $this->drupalGet('aggregator/sources/' . $feed->fid);

      $this->assertResponse(200, 'Feed source exists.');

      $this->assertText($edit['title'], 'Page title');

      // Delete feed.

      $feed->title = $edit['title']; // Set correct title so deleteFeed() will work.

      $this->deleteFeed($feed);

    }

  }

}

/**

 * Tests functionality for removing feeds in the Aggregator module.

 */

class RemoveFeedTestCase extends AggregatorTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Remove feed functionality',