Open Source Billing

modules/product/classes/Controller/Admin/Product.php

@@ -0,0 +1,142 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class provides Admin Product management
+ *
+ * @package    Product
+ * @category   Controllers/Admin
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Controller_Admin_Product extends Controller_TemplateDefault_Admin {
+	protected $secure_actions = array(
+		'ajaxtranslateform'=>TRUE,
+		'list'=>TRUE,
+		'update'=>TRUE,
+		'view'=>TRUE,
+	);
+
+	public function action_ajaxtranslateform() {
+		$this->auto_render = FALSE;
+
+		$po = ORM::factory('Product',$this->request->param('id'));
+
+		if (! $this->request->is_ajax() OR ! $po->loaded() OR ! isset($_REQUEST['key']))
+			$this->response->body(_('Unable to find translate data'));
+
+		else {
+
+			$pto = $po->product_translate->where('language_id','=',$_REQUEST['key'])->find();
+
+			$this->response->body(View::factory($this->viewpath())->set('pto',$pto));
+		}
+	}
+
+	/**
+	 * Show a list of products
+	 */
+	public function action_list() {
+		if ($this->request->param('id'))
+			$prods = ORM::factory('Product_Category',$this->request->param('id'))->products();
+		else
+			$prods = ORM::factory('Product')->order_by('status DESC,prod_plugin_file')->find_all();
+
+		Block::add(array(
+			'title'=>_('Customer Products'),
+			'body'=>Table::display(
+				$prods,
+				25,
+				array(
+					'id'=>array('label'=>'ID','url'=>URL::link('admin','product/view/')),
+					'name()'=>array('label'=>'Details'),
+					'status'=>array('label'=>'Active'),
+					'prod_plugin_file'=>array('label'=>'Plugin Name'),
+					'prod_plugin_data'=>array('label'=>'Plugin Data'),
+					'price_type'=>array('label'=>'Price Type'),
+					'taxable'=>array('label'=>'Taxable'),
+					'count_services()'=>array('label'=>'Services'),
+					'count_invoices()'=>array('label'=>'Invoices'),
+				),
+				array(
+					'page'=>TRUE,
+					'type'=>'select',
+					'form'=>URL::link('admin','product/view'),
+				)),
+			));
+	}
+
+	/**
+	 * Edit a product configuration
+	 */
+	public function action_update() {
+		$po = ORM::factory('Product',$this->request->param('id'));
+
+		if (! $po->loaded())
+			HTTP::redirect('welcome/index');
+
+		if ($_POST) {
+			if (isset($_POST['product_translate']['id']) AND ($pto=ORM::factory('Product_Translate',$_POST['product_translate']['id'])) AND $pto->loaded())
+				if (! $pto->values($_POST['product_translate'])->save())
+					throw new Kohana_Exception('Failed to save updates to product_translate data for record :record',array(':record'=>$po->id()));
+
+			if (! $po->values($_POST)->save())
+				throw new Kohana_Exception('Failed to save updates to product data for record :record',array(':record'=>$so->id()));
+		}
+
+		Block::add(array(
+			'title'=>sprintf('%s %s:%s',_('Update Product'),$po->id,$po->name()),
+			'body'=>View::factory($this->viewpath())
+				->set('po',$po)
+				->set('mediapath',Route::get('default/media'))
+				->set('plugin_form',$po->admin_update()),
+		));
+
+		Script::add(array('type'=>'stdin','data'=>'
+			$(document).ready(function() {
+				$("select[name=language_id]").change(function() {
+					// Send the request and update sub category dropdown
+					$.ajax({
+						type: "GET",
+						data: "key="+$(this).val(),
+						dataType: "html",
+						cache: false,
+						url: "'.URL::link('admin','product/ajaxtranslateform/'.$po->id,TRUE).'",
+						timeout: 2000,
+						error: function(x) {
+							alert("Failed to submit");
+						},
+						success: function(data) {
+							$("div[id=translate]").replaceWith(data);
+						}
+					});
+				});
+			});
+		'));
+	}
+
+	public function action_view() {
+		$po = ORM::factory('Product',$this->request->param('id'));
+
+		Block::add(array(
+			'title'=>sprintf('%s: %s',_('Current Services Using this Product'),$po->name()),
+			'body'=>Table::display(
+				ORM::factory('Service')->where('product_id','=',$po->id)->find_all(),
+				25,
+				array(
+					'id'=>array('label'=>'ID','url'=>URL::link('user','service/view/')),
+					'account->accnum()'=>array(),
+					'account->name()'=>array('label'=>'Account'),
+					'name()'=>array('label'=>'Details'),
+					'status'=>array('label'=>'Active'),
+					'price(TRUE,TRUE)'=>array('label'=>'Price','align'=>'right'),
+				),
+				array(
+					'page'=>TRUE,
+					'type'=>'select',
+					'form'=>URL::link('user','service/view'),
+				)),
+			));
+	}
+}
+?>

modules/product/classes/Controller/Product.php

@@ -0,0 +1,104 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class provides product categories
+ *
+ * @package    Product
+ * @category   Controllers
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Controller_Product extends Controller_TemplateDefault {
+	protected $auth_required = FALSE;
+
+	/**
+	 * Show a list of product categories
+	 */
+	public function action_categorys() {
+		$output = '<div id="category">';
+		$output .= '<ul>';
+
+		foreach (ORM::factory('Product_Category')->list_active() as $pco) {
+			$a = '<h3>'.$pco->display('name').'</h3>';
+			$a .= '<p>'.$pco->description().'</p>';
+
+			$output .= '<li>'.HTML::anchor('product/category/'.$pco->id,$a).'</li>';
+		}
+
+		$output .= '</ul>';
+		$output .= '</div>';
+
+		$this->template->content = $output;
+	}
+
+	/**
+	 * Show the available topics in a category
+	 *
+	 * @todo Only show categories according to their validity dates
+	 * @todo Obey sort order
+	 */
+	public function action_category() {
+		$output = '';
+
+		$pco = ORM::factory('Product_Category',$this->request->param('id'));
+
+		if (! $pco->loaded())
+			HTTP::redirect('welcome/index');
+
+		if (! $pco->status AND ! Kohana::$config->load('debug')->show_inactive)
+			HTTP::redirect('welcome/index');
+
+		BreadCrumb::name($this->request->uri(),$pco->name);
+		BreadCrumb::url('product','product/categorys');
+		BreadCrumb::url('product/category','product/categorys');
+
+		foreach ($pco->products() as $po)
+			$output .= View::factory($this->viewpath().'/list_item')
+				->set('co',$pco)
+				->set('o',$po);
+
+		// If our output is blank, then there are no products
+		if (! $output)
+			$output = _('Sorry, no pages were found in this category, or your account is not authorized for this category.');
+
+		Block::add(array(
+			'title'=>sprintf('%s: %s',_('Category'),$pco->name),
+			'body'=>$output,
+		));
+	}
+
+	/**
+	 * Show a product
+	 */
+	public function action_view() {
+		$id = $this->request->param('id');
+
+		$po = ORM::factory('Product',$id);
+
+		if (! $po->loaded())
+			HTTP::redirect('Product_Category/index');
+
+		BreadCrumb::name($this->request->uri(),$po->product_translate->find()->name);
+		BreadCrumb::url('product','product/categorys');
+
+		// Work out our category id for the control line
+		if (! empty($_GET['cid'])) {
+			$co = ORM::factory('Product_Category',$_GET['cid']);
+
+			// If the product category doesnt exist, or doesnt match the product
+			if (! $co->loaded() OR ! in_array($co->id,$po->avail_category))
+				HTTP::redirect('Product_Category/index');
+
+			BreadCrumb::name('product/view',$co->name);
+			BreadCrumb::url('product/view','product/category/'.$co->id);
+		}
+
+		Block::add(array(
+			'title'=>$po->description_short(),
+			'body'=>View::factory($this->viewpath())
+				->set('record',$po),
+		));
+	}
+}
+?>

modules/product/classes/Controller/Product/Category.php

@@ -0,0 +1,39 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class provides product categories
+ *
+ * @package    Product
+ * @category   Controllers
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Controller_Product_Category extends Controller_TemplateDefault {
+	/**
+	 * By default show a menu of available categories
+	 */
+	public function action_index() {
+		HTTP::redirect('product_category/list');
+	}
+
+	public function action_list() {
+		Block::add(array(
+			'title'=>_('Product Categories'),
+			'body'=>View::factory('product/category/list')
+				->set('results',$this->_get_categories()),
+			));
+	}
+
+	/**
+	 * Obtain a list of our categories
+	 * @todo Only show categories according to the users group memeberhsip
+	 * @todo Obey sort order
+	 * @todo Move this to the model
+	 */
+	private function _get_categories() {
+		return ORM::factory('Product_Category')
+			->list_active();
+	}
+}
+?>

modules/product/classes/Model/Product.php

@@ -0,0 +1,221 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class supports OSB listing products
+ *
+ * @package    Product
+ * @category   Models
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ *
+ * Column Definitions:
+ * + price_type: 0=One Time, 1=Recurring, 2=Trial
+ */
+class Model_Product extends ORM_OSB {
+	// @todo this doesnt have our site_id when getting the translation
+	protected $_has_many = array(
+		'product_translate'=>array('far_key'=>'id'),
+		'service'=>array('far_key'=>'id'),
+		'invoice'=>array('through'=>'invoice_item'),
+	);
+
+	protected $_sorting = array(
+		'position'=>'asc',
+	);
+
+	protected $_display_filters = array(
+		'price_type'=>array(
+			array('StaticList_PriceType::display',array(':value')),
+		),
+		'status'=>array(
+			array('StaticList_YesNo::display',array(':value')),
+		),
+		'taxable'=>array(
+			array('StaticList_YesNo::display',array(':value')),
+		),
+	);
+
+	// Our attributes that are arrays, we'll convert/unconvert them
+	protected $_serialize_column = array(
+		'avail_category',
+		'price_group',
+	);
+
+	/**
+	 * Which categories is this product available in
+	 */
+	public function categories() {
+		return $this->avail_category;
+	}
+
+	/**
+	 * Get the product description, after translating
+	 * @todo This needs to be improved to find the right language item.
+	 */
+	public function description_long() {
+		return $this->product_translate->find()->display('description_full');
+	}
+
+	/**
+	 * Get the product description, after translating
+	 * @todo This needs to be improved to find the right language item.
+	 */
+	public function description_short() {
+		return $this->product_translate->find()->display('description_short');
+	}
+
+	/**
+	 * This will render the product feature summary information
+	 */
+	public function feature_summary() {
+		return (is_null($plugin = $this->plugin())) ? HTML::nbsp('') : $plugin->feature_summary();
+	}
+
+	/**
+	 * Get the product name, after translating
+	 * @todo This needs to be improved to find the right language item.
+	 */
+	public function name() {
+		return $this->product_translate->find()->display('name');
+	}
+
+	/**
+	 * Return the object of the product plugin
+	 */
+	public function plugin() {
+		if (! $this->prod_plugin_file)
+			return NULL;
+
+		if (! is_numeric($this->prod_plugin_data))
+			throw new Kohana_Exception('Missing plugin_id for :product (:type)',array(':product'=>$this->id,':type'=>$this->prod_plugin_file));
+
+		return ORM::factory(Kohana::classname(sprintf('Product_Plugin_%s',$this->prod_plugin_file)),$this->prod_plugin_data);
+	}
+
+	/**
+	 * Return the best price to the uesr based on the users group's memberships
+	 * @todo This needs to be tested with more than one price group enabled
+	 */
+	public function get_price_array() {
+		if (! $this->loaded())
+			throw new Kohana_Exception('Call to :method where no object loaded?',array(':method'=>__METHOD__));
+
+		// Figure out our eligable groups
+		// @todo Need to work out our default groups elsewhere, not in product
+		// All users are members of the all user group "0"
+		$groups = array(0);
+		if (Auth::instance()->logged_in())
+			foreach (Auth::instance()->get_user()->group->find_all() as $go)
+				array_push($groups,$go->id);
+
+		// Work out the best price for the user
+		$price = array();
+		if (is_array($this->price_group))
+		foreach ($this->price_group as $bill_freq => $pg) {
+			if (isset($pg['show']) AND $pg['show'])
+				foreach ($groups as $gid) {
+					if (! empty($pg[$gid])) {
+						if (empty($price[$bill_freq]['price_base'])
+							OR ($pg[$gid]['price_base'] AND $price[$bill_freq]['price_base'] > $pg[$gid]['price_base'])) {
+							$price[$bill_freq]['price_setup'] = $pg[$gid]['price_setup'];
+							$price[$bill_freq]['price_base'] = $pg[$gid]['price_base'];
+						}
+					}
+				}
+		}
+
+		// @todo Ugly hack
+		return $price ? $price : array('0'=>array('price_base'=>0,'price_setup'=>0));
+	}
+
+	/**
+	 * Test if the product is a TRIAL product
+	 * (price_type == 2)
+	 *
+	 * @return boolean
+	 */
+	public function is_trial() {
+		if ($this->price_type == 2)
+			return TRUE;
+		else
+			return FALSE;
+	}
+
+	public function show_thumb() {
+		$mediapath = Route::get('default/media');
+
+		$thumbfile = sprintf('prod_thmb_%s',$this->id);
+
+		// @todo This needs to be optimised. By nice if find_files could return the HTML path too.
+		if (Kohana::find_file('media/img/thumbnails',$thumbfile,'png')) {
+			$thumb = $mediapath->uri(array('file'=>'img/thumbnails/'.$thumbfile.'.png'));
+
+			// @todo Change the ALT to the product name.
+			echo HTML::image($thumb,array('alt'=>_('Thumb Nail')));
+		} else
+			echo '';
+	}
+
+	/**
+	 * Enable the plugin to store data
+	 */
+	public function admin_update() {
+		if (is_null($plugin = $this->plugin()))
+			return NULL;
+		else
+			return $plugin->admin_update();
+	}
+
+	/**
+	 * Is price shown for a specific period
+	 */
+	public function isPriceShown($p) {
+		$x = $this->keyget('price_group',$p);
+
+		return (isset($x['show']) AND $x['show']) ? TRUE : FALSE;
+	}
+
+	/**
+	 * Return the configured price groups for this product
+	 */
+	public function availPriceGroups() {
+		// @todo This needs to be worked out dynamically
+		return array(0,1);
+	}
+
+	/**
+	 * Return the available pricing options
+	 */
+	public function availPriceOptions() {
+		// @todo This needs to be worked out dynamically
+		return array('price_base','price_setup');
+	}
+
+	/**
+	 * List the number of services using this product
+	 */
+	public function count_services() {
+		return $this->service->list_count(TRUE);
+	}
+
+	/**
+	 * List the number of invoices using this product
+	 */
+	public function count_invoices() {
+		return $this->invoice->list_count(TRUE);
+	}
+
+	/**
+	 * Return the price for the particle group and price option for the period
+	 */
+	public function price($grp,$period,$option,$taxed=FALSE) {
+		$x = $this->keyget('price_group',$period);
+
+		if (isset($x[$grp][$option]))
+			return $taxed ? Tax::add($x[$grp][$option]) : $x[$grp][$option];
+		else
+			return NULL;
+	}
+}
+?>

modules/product/classes/Model/Product/Category.php

@@ -0,0 +1,55 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class supports OSB listing products by category.
+ *
+ * @package    Product
+ * @category   Models
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Model_Product_Category extends ORM_OSB {
+	protected $_table_name = 'product_cat';
+
+	protected $_has_many = array(
+		'product_category_translate'=>array('foreign_key'=>'product_cat_id','far_key'=>'id'),
+	);
+
+	protected $_sorting = array(
+		'name'=>'asc',
+	);
+
+	public function description() {
+		// If the user is not logged in, show the site default language
+		// @todo This needs to change to the session language.
+		if (! $ao=Auth::instance()->get_user())
+			$ao=Company::instance()->so();
+
+		return ($x=$this->product_category_translate->where('language_id','=',$ao->language_id)->find()->description) ? $x : _('No Description');
+	}
+
+	/**
+	 * List all the products belonging to this cateogry
+	 * @todo Consider if we should cache this
+	 */
+	public function products() {
+		$result = array();
+
+		foreach (ORM::factory('Product')->where_active()->find_all() as $po)
+			if (in_array($this->id,$po->categories()))
+				array_push($result,$po);
+
+		return $result;
+	}
+
+	public function list_bylistgroup($cat) {
+		$result = array();
+
+		foreach ($this->where('list_group','=',$cat)->find_all() as $pco)
+			$result[$pco->id] = $pco;
+
+		return $result;
+	}
+}
+?>

modules/product/classes/Model/Product/Category/Translate.php

@@ -0,0 +1,19 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class product access to product category translation.
+ *
+ * @package    Product
+ * @category   Models
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Model_Product_Category_Translate extends ORM_OSB {
+	protected $_table_name = 'product_cat_translate';
+
+	protected $_belongs_to = array(
+		'product_category'=>array(),
+	);
+}
+?>

modules/product/classes/Model/Product/Plugin.php

@@ -0,0 +1,28 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class supports Product Plugins.
+ *
+ * @package    Product
+ * @category   Models
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+abstract class Model_Product_Plugin extends ORM_OSB {
+	// Reset any sorting that may be defined in our parent
+	protected $_sorting = array();
+
+	/**
+	 * The admin_update should be implemented in plugins.
+	 * It is used to update the plugin specific product information
+	 */
+	abstract public function admin_update();
+
+	/**
+	 * The feature summary should be implemented in plugins.
+	 * It is displayed on the product overview page, as a summary of the products features.
+	 */
+	abstract public function feature_summary();
+}
+?>

modules/product/classes/Model/Product/Translate.php

@@ -0,0 +1,19 @@
+<?php defined('SYSPATH') or die('No direct access allowed.');
+
+/**
+ * This class product access to product translation.
+ *
+ * @package    Product
+ * @category   Models
+ * @author     Deon George
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
+ */
+class Model_Product_Translate extends ORM_OSB {
+	protected $_updated_column = FALSE;
+
+	protected $_belongs_to = array(
+		'product'=>array(),
+	);
+}
+?>