Version 0.1: Initial version, auto-subscription works already, but sub/unsub...

Version 0.1: Initial version, auto-subscription works already, but sub/unsub buttons are not properly implemented, thouth

.gitignore

+.svn
+*~
+cache
+*.kate-swp
+logs
+tmp

Makefile

+BASE=downloads_for_sale
+PLUGINTYPE=vmcustom
+VERSION=1.1
+
+PLUGINFILES=$(BASE).php $(BASE).script.php $(BASE).xml index.html
+
+TRANSLATIONS=$(call wildcard,*.plg_$(PLUGINTYPE)_$(BASE).*ini) 
+INDEXFILES=$(BASE)/index.html
+TMPLFILES=$(call wildcard,$(BASE)/tmpl/*.php) $(BASE)/index.html $(BASE)/tmpl/index.html
+ASSETS=$(call wildcard,assets/*.png) $(call wildcard,assets/*.css) assets/index.html
+ZIPFILE=plg_$(PLUGINTYPE)_$(BASE)_v$(VERSION).zip
+
+
+zip: $(PLUGINFILES) $(TRANSLATIONS) $(ELEMENTS) $(TMPLFILES)
+	@echo "Packing all files into distribution file $(ZIPFILE):"
+	@zip -r $(ZIPFILE) $(PLUGINFILES) $(TRANSLATIONS) $(ELEMENTS) $(INDEXFILES) $(TMPLFILES) $(ASSETS)
+
+clean:
+	rm -f $(ZIPFILE)

acy_subscribe_buyer.php

+<?php
+defined('_JEXEC') or 	die( 'Direct Access to ' . basename( __FILE__ ) . ' is not allowed.' ) ;
+/**
+ * A custom field plugin to automatically subscribe buyers to AcyMailing lists
+ * @author Reinhold Kainhofer
+ * @package VirtueMart
+ * @subpackage vmcustom
+ * @copyright Copyright (C) 2013 Reinhold Kainhofer
+ * Some ideas are taken from the Acy VM Assign plugin by Nordmograph
+ * @copyright Copyright (C) 2003-2012 Nordmograph
+ * Some ideas are taken from the AcyMailing module by ACYBA
+ * @copyright Copyright (C) 2009-2013 ACYBA S.A.R.L. All right reserved.
+ * @license GNU/GPLv3, http://www.gnu.org/copyleft/gpl-3.0.html 
+ *
+ * http://kainhofer.com
+ */
+if (!class_exists('vmCustomPlugin')) require(JPATH_VM_PLUGINS . DS . 'vmcustomplugin.php');
+
+class plgVmCustomAcy_subscribe_Buyer extends vmCustomPlugin {
+
+	function __construct(& $subject, $config) {
+		parent::__construct($subject, $config);
+		$varsToPush = array(
+			'lists'=>array(array(), 'array'),
+			'subscribe_buyers'=>array(1, 'int'),
+			'allow_subscribe'=>array(1, 'int'),
+		);
+		$this->setConfigParameterable('custom_params',$varsToPush);
+	}
+	function plgVmOnSelfCallFE($type,$name,&$render) {
+		if ($name != $this->_name || $type != 'vmcustom') return false;
+		vmDebug('plgVmOnSelfCallFE');
+	}
+	function plgVmOnSelfCallBE($type, $name, &$output) {
+		if ($name != $this->_name || $type != 'vmcustom') return false;
+		vmDebug('plgVmOnSelfCallBE');
+	}
+
+	function getAcyMailinglists() {
+		$q ="SELECT `listid`, `name` FROM `#__acymailing_list` ORDER BY `name` DESC ";
+		$db =& JFactory::getDBO();	
+		$db->setQuery($q);
+		return $db->loadAssocList('listid', 'name');
+	}
+	function getAcyListname($listid) {
+		$q ="SELECT `name` FROM `#__acymailing_list` WHERE `listid`=".(int)$listid;
+		$db =& JFactory::getDBO();	
+		$db->setQuery($q);
+		return $db->loadResult();
+	}
+	
+	function getAcyUidFromUser ($userid) {
+		if (!($userid>0)) return null;
+		$q = "SELECT `subid` FROM `#__acymailing_subscriber` WHERE `userid`='".(int)$userid."'";
+		$db = &JFactory::getDBO();
+		$db->setQuery($q);
+		return $db->loadResult();
+	}
+	function getAcyUidFromEmail ($email) {
+		if (empty($email)) return null;
+		$db = &JFactory::getDBO();
+		$q = "SELECT `subid` FROM `#__acymailing_subscriber` WHERE `email` COLLATE utf8_general_ci = '".$db->escape($email)."'";
+		$db->setQuery($q);
+		return $db->loadResult();
+	}
+	/** Returns all listid, to which the AcyMailing user is subscribed */
+	function getUserSubscriptions ($uid) {
+		if (!($uid>0)) return array();
+		$db = &JFactory::getDBO();
+		$q = "SELECT `listid` FROM `#__acymailing_listsub` WHERE `subid` = '".(int)$uid."'";
+		$db->setQuery($q);
+		$subscribed = $db->loadColumn();
+		return $subscribed;
+	}
+	/** Creates a new AcyMailing user for the given name/email/uid */
+	function addAcyUser ($name, $email, $uid) {
+		$db = &JFactory::getDBO();
+		if ($uid>0) {
+			$q = "SELECT `id`, `name`, `email` FROM `#__users` WHERE `id`=".(int)$uid;
+			$db->setQuery($q);
+			$userinfo = $db->loadObject();
+// print("<pre>addAcyUser ($name, $email, $uid): loaded user data <br>(SQL: $q) <br/>".print_r($userinfo,1)."</pre>");
+			if (empty($email)) 
+				$email = $userinfo->email;
+			if (empty($name))
+				$name = $userinfo->name;
+		}
+		$q = "INSERT IGNORE INTO `#__acymailing_subscriber` (`email`, `userid`, `name`, `created`, `confirmed`, `enabled`, `accept`, `html`) 
+		      VALUES ('".$db->escape($email)."', ".(int)$uid.", '".$db->escape($name)."', ".time().", 1, 1, 1, 1)";
+		$db->setQuery($q);
+		$db->query();
+		$err = $db->getErrorMsg();
+		if (!empty($err)) {
+			JFactory::getApplication()->enqueueMessage(JText::sprintf('VMCUSTOM_ACYBUYER_SQL_ERROR', $err), 'error');
+			print("<pre>SQL error: sql=$q, <br/>error: ".$err."</pre>");
+			return 0;
+		}
+		return $db->insertid();
+	}
+	/** Adds the acy user to all the given lists (the subscriber has already been created).*/
+	function subscribeUser ($acyuid, $lists) {
+		$db = &JFactory::getDBO();
+		foreach ($lists as $l) {
+			$q = "INSERT IGNORE INTO `#__acymailing_listsub` 
+			      (`listid`, `subid`, `subdate`, `status`)
+			      VALUES
+			      (".(int)$l.", ".(int)$acyuid.", ".time().", 1)";
+			$db->setQuery($q);
+			$db->query();
+		}
+	}
+	/** Removes the user from all the given lists */
+	function unsubscribeUser ($acyuid, $lists) {
+		// TODO
+	}
+
+	/**
+	 * @see Form displayed in the product edit page in the BE, configure the download file
+	 * @author Reinhold Kainhofer
+	 */
+	function plgVmOnProductEdit($field, $product_id, &$row,&$retValue) {
+		if ($field->custom_element != $this->_name) return '';
+		
+		$this->parseCustomParams($field);
+		$html = '';
+		$html .='<fieldset>
+			<legend>'. JText::_('VMCUSTOM_ACYBUYER') .'</legend>
+			<table class="admintable">
+			';
+		
+		$lists = $this->getAcyMailinglists();
+		if ($lists) {
+			$html .= VmHTML::row ('select','VMCUSTOM_ACYBUYER_LIST', 'custom_param['.$row.'][lists][]', $lists, $field->lists, ' multiple', 'listid', 'name', '');
+			$html .= VmHTML::row ('checkbox','VMCUSTOM_ACYBUYER_AUTO_SUBSCRIBE', 'custom_param['.$row.'][subscribe_buyers]', $field->subscribe_buyers);
+			$html .= VmHTML::row ('checkbox','VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE', 'custom_param['.$row.'][allow_subscribe]', $field->allow_subscribe);
+		} else {
+			// No lists found, no need to display any other option
+			$html .= '<tr><td>'.JText::_('VMCUSTOM_ACYBUYER_NO_LISTS').'</td></tr>';
+		}
+
+		$html .= '</table></fieldset>';
+		$retValue .= $html;
+		$row++;
+		return true ;
+	}
+	
+	function displayProduct($field) {
+$this->addAcyUser("Reinhold Kainhofer", "reinhold@kainhofer.com" , 673);
+		$html = '';
+		$this->parseCustomParams($field);
+		$user = JFactory::getUser()->get('id');
+		if ($user>0) {
+			$acyuid = $this->getAcyUidFromUser($user);
+			$allsubscriptions = $this->getUserSubscriptions($acyuid);
+			$subscribed = array_intersect ($field->lists, $allsubscriptions);
+			$notsubscribed = array_diff ($field->lists, $allsubscriptions);
+			if (!empty($notsubscribed)) {
+				$html .= $this->renderByLayout('button_subscribe', array($notsubscribed, $user, $field));
+				// TODO: implement subscribe button
+			}
+			if (!empty($subscribed)) {
+				// TODO: implement unsubscribe button
+				$html .= $this->renderByLayout('button_unsubscribe', array($subscribed, $user, $field));
+			}
+// 			$html .= "<pre>USER: $user, field: ".print_r($field,1).", all subscriptions: ".print_r($allsubscriptions,1).", subscriptions: ".print_r($subscribed,1).", unsubscriptions: ".print_r($notsubscribed,1).", lists: ".print_r($field->lists, 1)."</pre>";
+		} elseif ($field->allow_subscribe) {
+			$html .= $this->renderByLayout('button_subscribe_anon', array($field->lists, $field));
+			// TODO: Display anonymous subscribe button
+			$html = "<pre>NO USER, SUBSCRIBE allowed</pre>";
+		} else {
+			// Not logged in, manual subscription not allowed
+		}
+
+		return $html;
+	}
+
+	/**
+	 * plgVmOnDisplayProductVariantFE ... Called for product variant custom fields to display on the product details page
+	 */
+	function plgVmOnDisplayProductVariantFE($field,&$row,&$group) {
+		// default return if it's not this plugin
+		if ($field->custom_element != $this->_name) return '';
+		$group->display .= $this->displayProduct($field);
+		return true;
+	}
+
+	/**
+	 * plgVmOnDisplayProductFE ... Called for NON-product variant custom fields to display on the product details page
+	 */
+	function plgVmOnDisplayProductFE( $product, &$idx,&$field){
+		// default return if it's not this plugin
+		if ($field->custom_element != $this->_name) return '';
+		$field->display .= $this->displayProduct($field);
+		return true;
+	}
+
+	/**
+	 * We must reimplement this triggers for joomla 1.7
+	 * vmplugin triggers note by Max Milbers
+	 */
+	public function plgVmOnStoreInstallPluginTable($psType, $name) {
+		return $this->onStoreInstallPluginTable($psType, $name);
+	}
+
+	function plgVmDeclarePluginParamsCustom($psType,$name,$id, &$data){
+		return $this->declarePluginParams('custom', $name, $id, $data);
+	}
+
+	function plgVmSetOnTablePluginParamsCustom($name, $id, &$table){
+		return $this->setOnTablePluginParams($name, $id, $table);
+	}
+
+	function plgVmOnDisplayEdit($virtuemart_custom_id,&$customPlugin){
+		return $this->onDisplayEditBECustom($virtuemart_custom_id,$customPlugin);
+	}
+
+	public function getVmPluginCreateTableSQL() {
+// 		return $this->createTableSQL('Downloads for Sale tracking');
+		return false;
+	}
+
+	function getTableSQLFields() {
+// 		$SQLfields = array();
+// 		return $SQLfields;
+		return null;
+	}
+	/**
+	 * This function is called, when the order is confirmed by the shopper.
+	 *
+	 * Here are the last checks done by payment plugins.
+	 * The mails are created and send to vendor and shopper
+	 * will show the orderdone page (thank you page)
+	 *
+	 */
+	function plgVmConfirmedOrder($cart, $order) {
+		// Each custom field will have its own value for auto-subscribe, so we need to handle all purchased products!
+		$uid = $order['details']['BT']->virtuemart_user_id;
+		$email = $order['details']['BT']->email;
+		$name = $order['details']['BT']->first_name . " " . $order['details']['BT']->last_name;
+		$acyuid = $this->getAcyUidFromEmail($email);
+		if (!($acyuid>0)&&($uid>0)) {
+			$acyuid = $this->getAcyUidFromUser($uid);
+		}
+		$acyuid = $this->getAcyUidFromUser($uid);
+		$customModel = VmModel::getModel('customfields');
+		foreach ($order['items'] as $item) {
+			$customs = $customModel->getproductCustomslist ($item->virtuemart_product_id);
+JFactory::getApplication()->enqueueMessage("<pre>Custom fields: ".print_r($customs,1)."</pre>", 'error');
+			foreach ($customs as $field) {
+				if ($field->custom_element != $this->_name) continue;
+				if (!$field->subscribe_buyers) continue;
+				// Add the user to the lists:
+				if(!($acyuid>0)) {
+					$acyuid = $this->addAcyUser($name, $email, $uid);
+				}
+				$allsubscriptions = $this->getUserSubscriptions($acyuid);
+				$notsubscribed = array_diff ($field->lists, $allsubscriptions);
+				$this->subscribeUser($acyuid, $notsubscribed);
+				foreach ($notsubscribed as $l) {
+					$listname=$this->getAcyListname($l);
+					JFactory::getApplication()->enqueueMessage(JText::sprintf('VMCUSTOM_ACYBUYER_ADDED_USER', $name, $email, $listname), 'info');
+				}
+			}
+		}
+		// TODO: If auto-subscribe 
+JFactory::getApplication()->enqueueMessage("plgVmConfirmedOrder, cart: <pre>".print_r($cart,1)."</pre><br><h2>ORDER:</h2><pre>".print_r($order,1)."</pre>", 'error');
+	}
+}
+
+// No closing tag
\ No newline at end of file

acy_subscribe_buyer.script.php

+<?php
+defined('_JEXEC') or die('Restricted access');
+
+class plgVmCustomAcy_subscribe_BuyerInstallerScript
+{
+    /**
+     * Constructor
+     *
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     */
+//     public function __constructor(JAdapterInstance $adapter);
+ 
+    /**
+     * Called before any type of action
+     *
+     * @param   string  $route  Which action is happening (install|uninstall|discover_install)
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     *
+     * @return  boolean  True on success
+     */
+//     public function preflight($route, JAdapterInstance $adapter);
+ 
+    /**
+     * Called after any type of action
+     *
+     * @param   string  $route  Which action is happening (install|uninstall|discover_install)
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     *
+     * @return  boolean  True on success
+     */
+//     public function postflight($route, JAdapterInstance $adapter);
+ 
+    /**
+     * Called on installation
+     *
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     *
+     * @return  boolean  True on success
+     */
+    public function install(JAdapterInstance $adapter)
+    {
+        // enabling plugin
+        $db =& JFactory::getDBO();
+        $db->setQuery('update #__extensions set enabled = 1 where type = "plugin" and element = "acy_subscribe_buyer" and folder = "vmcustom"');
+        $db->query();
+        
+        return True;
+    }
+ 
+    /**
+     * Called on update
+     *
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     *
+     * @return  boolean  True on success
+     */
+//     public function update(JAdapterInstance $adapter)
+//     {
+//         jimport( 'joomla.filesystem.file' ); 
+//         $file = JPATH_ROOT . DS . "administrator" . DS . "language" . DS . "en-GB" . DS . "en-GB.plg_vmshopper_ordernumber.sys.ini";
+//         if (JFile::exists($file)) JFile::delete($file); 
+//         $file = JPATH_ROOT . DS . "administrator" . DS . "language" . DS . "de-DE" . DS . "de-DE.plg_vmshopper_ordernumber.sys.ini"; 
+//         if (JFile::exists($file)) JFile::delete($file); 
+//         return true;
+//     }
+ 
+    /**
+     * Called on uninstallation
+     *
+     * @param   JAdapterInstance  $adapter  The object responsible for running this script
+     */
+    public function uninstall(JAdapterInstance $adapter)
+    {
+        // Remove plugin table
+//         $db =& JFactory::getDBO();
+//         $db->setQuery('DROP TABLE `#__virtuemart_shipment_plg_rules_shipping`;');
+//         $db->query();
+    }
+}
\ No newline at end of file

acy_subscribe_buyer.xml

+<?xml version="1.0" encoding="UTF-8" ?>
+<install version="1.5" type="plugin" group="vmcustom" method="upgrade">
+    <name>VMCUSTOM_ACYBUYER</name>
+    <creationDate>2013-02-24</creationDate>
+    <author>Reinhold Kainhofer</author>
+    <authorUrl>http://www.kainhofer.com/</authorUrl>
+    <copyright>Copyright (C) 2013 Reinhold Kainhofer. All rights reserved.</copyright>
+    <license>http://www.gnu.org/licenses/gpl.html GNU/GPL v3+</license>
+    <version>1.0.0</version>
+    <description>VMCUSTOM_ACYBUYER_DESC</description>
+    <files>
+        <filename plugin="acy_subscribe_buyer">acy_subscribe_buyer.php</filename>
+        <filename>acy_subscribe_buyer.script.php</filename>
+        <filename>index.html</filename>
+    </files>
+    <languages>
+        <language tag="en-GB">en-GB.plg_vmcustom_acy_subscribe_buyer.ini</language>
+    </languages>
+    <scriptfile>acy_subscribe_buyer.script.php</scriptfile>
+    <params addpath="/administrator/components/com_virtuemart/elements">
+	<param name="auto_subscribe" type="radio" default="1" label="VMCUSTOM_ACYBUYER_AUTO_SUBSCRIBE" description="VMCUSTOM_ACYBUYER_AUTO_SUBSCRIBE_DESC" >
+                        <option value="0">COM_VIRTUEMART_NO</option>
+                        <option value="1">COM_VIRTUEMART_YES</option>
+                </param>
+	<param name="allow_registered_subscribe" type="radio" default="1" label="VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE" description="VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE_DESC" >
+                        <option value="0">COM_VIRTUEMART_NO</option>
+                        <option value="1">COM_VIRTUEMART_YES</option>
+                </param>
+    </params>
+</install>

acy_subscribe_buyer/tmpl/button_subscribe.php

+<?php
+/**
+ *
+ * @author Reinhold Kainhofer
+ * @package VirtueMart
+ * @subpackage custom
+ * @copyright Copyright (C) 2013 RK - All rights reserved.
+ * @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php
+ *
+ **/
+  
+defined('_JEXEC') or die();
+if(JFile::exists(JPATH_SITE.DS.'plugins'.DS.'vmcustom'.DS.'acy_subscribe_buyer'.DS.'assets'.DS.'acy_subscribe_buyer.css')) {
+	$doc =& JFactory::getDocument();
+	$doc->addStyleSheet(JURI::root().'plugins/vmcustom/acy_subscribe_buyer/assets/acy_subscribe_buyer.css');  
+}
+?>
+<div class="acy_subscribe_buyer">
+<div style="background: #00FF00;">Subscribe user <?php echo $viewData[1]; ?> to: <?php print_r($viewData[0]); ?></div>
+</div>
\ No newline at end of file

acy_subscribe_buyer/tmpl/button_subscribe_anon.php

+<?php
+/**
+ *
+ * @author Reinhold Kainhofer
+ * @package VirtueMart
+ * @subpackage custom
+ * @copyright Copyright (C) 2013 RK - All rights reserved.
+ * @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php
+ *
+ **/
+  
+defined('_JEXEC') or die();
+if(JFile::exists(JPATH_SITE.DS.'plugins'.DS.'vmcustom'.DS.'acy_subscribe_buyer'.DS.'assets'.DS.'acy_subscribe_buyer.css')) {
+	$doc =& JFactory::getDocument();
+	$doc->addStyleSheet(JURI::root().'plugins/vmcustom/acy_subscribe_buyer/assets/acy_subscribe_buyer.css');  
+}
+?>
+<div class="acy_subscribe_buyer">
+<div style="background: #00FF00;">Subscribing anonymous to: <?php print_r($viewData[0]); ?></div>
+</div>
\ No newline at end of file

acy_subscribe_buyer/tmpl/button_unsubscribe.php

+<?php
+/**
+ *
+ * @author Reinhold Kainhofer
+ * @package VirtueMart
+ * @subpackage custom
+ * @copyright Copyright (C) 2013 RK - All rights reserved.
+ * @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php
+ *
+ **/
+ 
+defined('_JEXEC') or die();
+if(JFile::exists(JPATH_SITE.DS.'plugins'.DS.'vmcustom'.DS.'acy_subscribe_buyer'.DS.'assets'.DS.'acy_subscribe_buyer.css')) {
+	$doc =& JFactory::getDocument();
+	$doc->addStyleSheet(JURI::root().'plugins/vmcustom/acy_subscribe_buyer/assets/acy_subscribe_buyer.css');  
+}
+?>
+<div class="acy_subscribe_buyer">
+<div style="background: red">Unsubscribe user <?php echo $viewData[1]; ?> from: <?php print_r($viewData[0]); ?></div>
+</div>
\ No newline at end of file

en-GB.plg_vmcustom_acy_subscribe_buyer.ini

+; Virtuemart! Project
+; Copyright (C)  2011 Virtuemart Team. All rights reserved.
+; License http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL, see LICENSE.php
+; Note : All ini files need to be saved as UTF-8 - No BOM
+
+VMCUSTOM_ACYBUYER="VM Subscribe Buyers to AcyMailing"
+VMCUSTOM_ACYBUYER_DESC="VirtueMart custom field plugin to automatically subscribe buyers to AcyMailing lists."
+
+VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE
+VMCUSTOM_ACYBUYER_AUTO_SUBSCRIBE="Auto-subscribe buyers"
+VMCUSTOM_ACYBUYER_AUTO_SUBSCRIBE_DESC="Automatically add users to the mailing list after a successful purchase."
+VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE="Allow manual subscription"
+VMCUSTOM_ACYBUYER_ALLOW_SUBSCRIBE_DESC="Allow users to subscribe to a product without buying it. For registered users, the Joomla/VirtueMart users's email is automatically used for registered users, anonymous users will be asked for the name and email."
+
+VMCUSTOM_ACYBUYER_NO_LISTS="No AcyMailing lists are available"
+VMCUSTOM_ACYBUYER_LIST="AcyMailing lists:"
+
+VMCUSTOM_ACYBUYER_ADDED_USER="User '%s' (%s) added to mailing list %s."
+VMCUSTOM_ACYBUYER_SQL_ERROR="SQL error, please contact the author with the following information:<br/>%s"
\ No newline at end of file

en-GB.plg_vmcustom_acy_subscribe_buyer.sys.ini

+; Virtuemart! Project
+; Copyright (C)  2011 Virtuemart Team. All rights reserved.
+; License http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL, see LICENSE.php
+; Note : All ini files need to be saved as UTF-8 - No BOM
+
+VMCUSTOM_ACYBUYER="VM Subscribe Buyers to AcyMailing"
+VMCUSTOM_ACYBUYER_DESC="VirtueMart custom field plugin to automatically subscribe buyers to AcyMailing lists."