Extension:MarketResearch

<?php /**

* MarketResearch extensionTemplate:Php

These are the MediaWiki extensions we're using and/or developing. Please refer to the information on the mediawiki.org wiki for installation and usage details. Extensions here which have no corresponding mediawiki article are either not ready for use or have been superseded. You can also browse our extension code in our local Subversion repository or our GitHub mirror.

*
* Version 0.0.1 started 2008-07-12
* 
* @package MediaWiki
* @subpackage Extensions
* @licence GNU General Public Licence 2.0 or later
*/

if (!defined('MEDIAWIKI')) die('Not an entry point.');

define('MARKETRESEARCH_VERSION', '0.2.5, 2008-08-31');

$wgMarketResearchPartner = 'partnerid-not-set'; $wgMarketResearchSearch = 'http://www.marketresearch.com/feed/search_results.asp?bquery=$2&partnerid=$1'; $wgMarketResearchCart = 'http://www.marketresearch.com/feed/cart/addtocart.asp?partnerid=$1&ReturnURL=$2&productid=$3'; $wgMarketResearchExpiry = 600; # Number of seconds a cached entry should live for $wgMarketResearchDescSize = 500; # Max characters to render of a description $wgMarketResearchLink = 'http://www.govitwiki.com'; $wgMarketResearchName = 'GovITwiki Research Report Store'; $wgMarketResearchImages = preg_replace('|^.+(?=[/\\\\]extensions)|', $wgScriptPath, dirname(__FILE__).'/images');

1. Extension credits that show up on Special:Version

$wgExtensionCredits['parserhook'][] = array( 'name' => 'MarketResearch', 'author' => 'Nad for WikiExpert', 'url' => 'http://www.organicdesign.co.nz/Extension:MarketResearch', 'description' => 'Display market research information' );

$wgSpecialPages['MarketResearch'] = 'SpecialMarketResearch'; $wgExtensionFunctions[] = "wfSetupMarketResearch";

require_once "$IP/includes/SpecialPage.php";

/**

* The callback function for converting the input text to HTML output
*/

function wfMarketResearchTag($input) { global $wgTitle, $wgMarketResearchPartner, $wgMarketResearchSearch, $wgMarketResearchDescSize, $wgMarketResearchCart, $wgMarketResearchTable, $wgMarketResearchExpiry, $wgMarketResearchImages;

# Add keywords and product id into feed URL $keywords = preg_split('/[\x00-\x1f+,]+/', strtolower(trim($input))); $search = str_replace('$1', $wgMarketResearchPartner, $wgMarketResearchSearch); $search = str_replace('$2', join('+', $keywords), $search); $keywords = join(',', $keywords); $ts = time(); $db = &wfGetDB(DB_MASTER); $return = urlencode($wgTitle->getFullURL()); $html = "";

# Remove expired items & attempt to read current item $xml = false; if ($wgMarketResearchTable) { $db->delete($wgMarketResearchTable, array("mrc_time < ".($ts-$wgMarketResearchExpiry)), __FUNCTION__); if ($row = $db->selectRow($wgMarketResearchTable, 'mrc_xml', "mrc_keywords = '$keywords'", __FUNCTION__)) $xml = $row->mrc_xml; }

# If no XML yet, read from feed and store in cache if ($xml === false) { $xml = file_get_contents($search); if ($wgMarketResearchTable) { $row = array( 'mrc_keywords' => $keywords, 'mrc_time' => $ts, 'mrc_xml' => $xml ); $db->insert($wgMarketResearchTable, $row, __FUNCTION__); } }

# Read the feed into a DOM object $doc = new DOMDocument(); $doc->loadXML($xml); if (is_object($doc)) {

$jump = Title::makeTitle(NS_SPECIAL, 'MarketResearch'); $buy = "<img src=\"$wgMarketResearchImages/more-info.gif\" />";

# Loop through results foreach ($doc->getElementsByTagName('RESULT') as $result) {

# Title, description, vendor foreach ($result->getElementsByTagName('TITLE') as $i) $title = $i->textContent; foreach ($result->getElementsByTagName('VENDOR') as $i) $vendor = $i->textContent; foreach ($result->getElementsByTagName('DESCRIPTION') as $i) $desc = $i->textContent; if (strlen($desc) > $wgMarketResearchDescSize) $desc = substr($desc, 0, $wgMarketResearchDescSize).'...';

# Cart links $products = ""; foreach ($result->getElementsByTagName('BUY') as $i) { $id = $i->getAttribute('id'); $products .= "<a href=\"".$jump->getLocalURL("k=$keywords&p=$id&r=$return")."\">$buy</a>\n"; }

# render this item

$html .= "

\n

$title by $vendor

\n

$desc

\n$products\n

";

} } else $html = 'no valid XML returned';

return "

$html

";

}

/**

* An unlisted special page used as the "jump page" to a product
*/

class SpecialMarketResearch extends SpecialPage {

function __construct() { SpecialPage::SpecialPage('MarketResearch', , false, false, false, false); }

public function execute($param) { global $wgOut, $wgParser, $wgRequest, $wgMarketResearchTable, $wgMarketResearchPartner, $wgMarketResearchCart, $wgMarketResearchLink, $wgMarketResearchName;

$this->setHeaders(); $title = Title::makeTitle(NS_SPECIAL, 'MarketResearch'); $keywords = $wgRequest->getText('k'); $product = $wgRequest->getText('p'); $return = $wgRequest->getText('r');

# Read product from cache if ($product) { $db = &wfGetDB(DB_SLAVE);

if ($row = $db->selectRow($wgMarketResearchTable, 'mrc_xml', "mrc_keywords = '$keywords'", __FUNCTION__)) { $doc = new DOMDocument(); $xml = $row->mrc_xml; $doc->loadXML($xml); } else $doc = false;

if (is_object($doc)) {

$cart = str_replace('$1', $wgMarketResearchPartner, $wgMarketResearchCart); $cart = str_replace('$2', $return, $cart);

# Loop through results foreach ($doc->getElementsByTagName('RESULT') as $result) { foreach ($result->getElementsByTagName('BUY') as $i) { $id = $i->getAttribute('id'); if ($id === $product) {

# This is our product (should have selected it with an XPath query)

foreach ($result->getElementsByTagName('TITLE') as $i) $title = $i->textContent; foreach ($result->getElementsByTagName('VENDOR') as $i) $vendor = $i->textContent; foreach ($result->getElementsByTagName('DESCRIPTION') as $i) $desc = $i->textContent;

$wgOut->addWikiText("== $title by $vendor ==\n"); $wgOut->addHTML($desc);

# Add to cart $buy = str_replace('$3', $id, $cart); $wgOut->addHTML("
<a href=\"$buy\">View cart</a>"); $wgOut->addHTML(" | <a href=\"$wgMarketResearchLink\">$wgMarketResearchName</a>");

$wgOut->addHTML(' | <a href="javascript:history.go(-1)">Back</a>'); } } } } else $wgOut->addWikiText('no valid XML returned'); } else $wgOut->addWikiText('no product specified!');

} }

/**

* Install the hook and special page
*/

function wfSetupMarketResearch() { global $wgParser, $wgRequest, $wgOut, $egSelenium, $wgLanguageCode, $wgMessageCache, $wgMarketResearchTable; $wgParser->setHook("marketresearch", "wfMarketResearchTag");

# Create cache DB table if it doesn't exist $db = &wfGetDB(DB_MASTER); $wgMarketResearchTable = $db->tableName('MarketResearchCache'); if (!$db->tableExists($wgMarketResearchTable)) { $query = "CREATE TABLE $wgMarketResearchTable (mrc_keywords TINYBLOB, mrc_time INTEGER NOT NULL, mrc_xml MEDIUMBLOB);"; $result = $db->query($query); }

# If the table couldn't be created, disable IPN and add error to site notice if (!$db->tableExists($wgMarketResearchTable)) { global $wgSiteNotice; $wgMarketResearchTable = false;

$wgSiteNotice = "

MarketResearch extension problem! Could not create database table, caching functionality is disabled.
Please ensure the wiki database user has CREATE permission, or add the table manually with the following query:
$query

";

}

# Add any messages if ($wgLanguageCode == 'en') { $wgMessageCache->addMessages(array( 'marketresearch' => "Details on This Report" )); }

SpecialPage::addPage(new SpecialMarketResearch()); }