<?php

class LeasesController extends AppController {

  var $sidemenu_links =
    array(array('name' => 'Leases',   'header' => true),
	  array('name' => 'Active',   'url' => array('controller' => 'leases', 'action' => 'active')),
	  array('name' => 'Closed',   'url' => array('controller' => 'leases', 'action' => 'closed')),
	  array('name' => 'All',      'url' => array('controller' => 'leases', 'action' => 'all')),
	  );


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * override: sideMenuLinks
   *  - Generates controller specific links for the side menu
   */
  function sideMenuLinks() {
    return array_merge(parent::sideMenuLinks(), $this->sidemenu_links);
  }

  
  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: index / active / closed / all
   *  - Generate a listing of leases
   */

  function index()    { $this->all(); }
  function active()   { $this->jqGridView('Active Leases'); }
  function closed()   { $this->jqGridView('Closed Leases'); }
  function all()      { $this->jqGridView('All Leases', 'all'); }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * virtuals: jqGridData
   *  - With the application controller handling the jqGridData action,
   *    these virtual functions ensure that the correct data is passed
   *    to jqGrid.
   */

  function jqGridDataSetup(&$params) {
    parent::jqGridDataSetup($params);
    if (!isset($params['action']))
      $params['action'] = 'all';
  }

  function jqGridDataCountTables(&$params, &$model) {
    return array
      ('link' => array('Unit'     => array('fields' => array('Unit.id', 'Unit.name')),
		       'Customer' => array('fields' => array('Customer.id', 'Customer.name'))));
  }

  function jqGridDataTables(&$params, &$model) {
    $link = $this->jqGridDataCountTables($params, $model);
    $link['link']['LedgerEntry'] = array('fields' => array());
    $link['link']['LedgerEntry']['Ledger'] = array('fields' => array());
    $link['link']['LedgerEntry']['Ledger']['Account'] = array('fields' => array());
    // INNER JOIN would be great, as it would ensure we're only looking
    // at the ledger entries that we truly want.  However, this also
    // removes from the query any leases that do not yet have a ledger
    // entry in A/R.  A solution would be to INNER JOIN these tables,
    // and LEFT JOIN it to the rest.  Grouping of JOINs, however, is
    // implemented with the 'joins' tag, and is not available through
    // the Linkable behavior interface.
    //$link['link']['LedgerEntry']['Ledger']['Account']['type'] = 'INNER';
    $link['link']['LedgerEntry']['Ledger']['Account']['conditions']
      = array('Account.id' =>
	      $this->Lease->LedgerEntry->Ledger->Account->accountReceivableAccountID());
    return $link;
  }

  function jqGridDataFields(&$params, &$model) {
    $db = &$model->getDataSource();
    $fields = $db->fields($model, $model->alias);
    $fields[] = ("SUM(IF(Account.id IS NULL, 0," .
		 "       IF(LedgerEntry.debit_ledger_id = Account.id," .
		 "          1, -1))" .
		 "    * IF(LedgerEntry.amount IS NULL, 0, LedgerEntry.amount))" .
		 " AS 'balance'");
    return $fields;
  }

  function jqGridDataConditions(&$params, &$model) {
    $conditions = parent::jqGridDataConditions($params, $model);

    if ($params['action'] === 'active') {
      $conditions[] = 'Lease.close_date IS NULL';
    }
    elseif ($params['action'] === 'closed') {
      $conditions[] = 'Lease.close_date IS NOT NULL';
    }

    return $conditions;
  }

  function jqGridDataOrder(&$params, &$model, $index, $direction) {
    // Do not sort by number, which is type varchar and
    // sorts on an ascii basis.  Sort by ID instead.
    if ($index === 'Lease.number')
      $index = 'Lease.id';

    // Instead of sorting by name, sort by defined order
    if ($index === 'Unit.name')
      $index = 'Unit.sort_order';

    $order = array();
    $order[] = parent::jqGridDataOrder($params, $model, $index, $direction);

    // If sorting by anything other than id/number
    // add sorting by id as a secondary condition.
    if ($index !== 'Lease.id' && $index !== 'Lease.number')
      $order[] = parent::jqGridDataOrder($params, $model,
					 'Lease.id', $direction);

    return $order;
  }

/*   function jqGridRecordsPostProcess(&$params, &$model, &$records) { */
/*     foreach ($records AS &$record) { */
/*       $record['Lease']['through_date'] */
/* 	= $this->Lease->rentChargeThrough($record['Lease']['id']); */
/*     } */

/*     parent::jqGridRecordsPostProcess($params, $model, $records); */
/*   } */

  function jqGridRecordLinks(&$params, &$model, &$records, $links) {
    $links['Lease'] = array('number');
    $links['Unit'] = array('name');
    $links['Customer'] = array('name');
    return parent::jqGridRecordLinks($params, $model, $records, $links);
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: move_in
   *  - execute a move in on a new lease
   */

  function move_in() {
    if (!$this->data)
      die("Should have some data");

    // Handle the move in based on the data given
    //pr(array('Move-in data', $this->data));

    $lid = $this->Lease->moveIn($this->data['Lease']['customer_id'],
				$this->data['Lease']['unit_id'],
				null, null,
				$this->data['Lease']['movein_date'],
				$this->data['Lease']['comment']
				);

    // Since this is a new lease, go to the invoice
    // screen so we can start assessing charges.
    $this->redirect(array('action'=>'invoice', $lid));

    // For debugging, only if the redirect above have been
    // commented out, otherwise this section isn't reached.
    $this->render('/empty');
  }

  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: move_out
   *  - prepare or execute a move out on a specific lease
   */

  function move_out($id = null) {
    if ($this->data) {
      // Handle the move out based on the data given
      //pr($this->data);

      $this->Lease->moveOut($this->data['Lease']['id'],
			    'VACANT',
			    $this->data['Lease']['moveout_date'],
			    //true // Close this lease, if able
			    false
			    );

      $this->redirect($this->data['redirect']);
      $this->autoRender = false;
      return;
    }

    if (!isset($id))
      die("Oh Nooooo!!");

    $lease = $this->Lease->find
      ('first', array
       ('contain' => array
	(// Models
	 'Unit' =>
	 array('order'  => array('sort_order'),
	       'fields' => array('id', 'name'),
	       ),

	 'Customer' =>
	 array('fields' => array('id', 'name'),
	       ),
	 ),

	'conditions' => array(array('Lease.id' => $id),
			      array('Lease.close_date' => null),
			      ),
	));
    $this->set('customer', $lease['Customer']);
    $this->set('unit',     $lease['Unit']);
    $this->set('lease',    $lease['Lease']);

    $redirect = array('controller' => 'leases',
		      'action' => 'view',
		      $id);

    $title = ('Lease #' . $lease['Lease']['number'] . ': ' .
	      $lease['Unit']['name'] . ': ' .
	      $lease['Customer']['name'] . ': Prepare Move-Out');
    $this->set(compact('title', 'redirect'));
    $this->render('/leases/move');
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: apply_deposit
   *  - Applies the security deposit to charges.  This is much
   *    like a receipt, but it's separated to keep it simple and
   *    to prevent feature overload on the receipt page.
   */

  function apply_deposit($id) {
    $A = new Account();

    $lease = $this->Lease->find
      ('first', array
       ('contain' => array
	(// Models
	 'Unit' =>
	 array('order'  => array('sort_order'),
	       'fields' => array('id', 'name'),
	       ),

	 'Customer' =>
	 array('fields' => array('id', 'name'),
	       ),
	 ),

	'conditions' => array(array('Lease.id' => $id),
			      array('Lease.close_date' => null),
			      ),
	));


    // Get the lease balance, part of lease stats
    $this->Lease->statsMerge($lease['Lease'],
			     array('stats' => $this->Lease->stats($id)));

    // Determine the lease security deposit
    $deposit = $this->Lease->findSecurityDeposits($lease['Lease']['id']);
    $this->set(compact('deposit'));
    $this->set('customer', $lease['Customer']);
    $this->set('unit',     $lease['Unit']);
    $this->set('lease',    $lease['Lease']);
    $this->set('account',  array('id' => $A->securityDepositAccountID()));

/*     $redirect = array('controller' => 'leases', */
/* 		      'action' => 'view', */
/* 		      $id); */

    $title = ('Lease #' . $lease['Lease']['number'] . ': ' .
	      $lease['Unit']['name'] . ': ' .
	      $lease['Customer']['name'] . ': Utilize Security Deposit');
    $this->set(compact('title', 'redirect'));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: bad_debt
   *  - Writes off remaining charges on a lease.
   *    REVISIT <AP>: 20090710
   *     Should this be a customer function?  What customer
   *     would have only one lease that results in bad debt.
   */

  function bad_debt($id) {
    $A = new Account();

    $lease = $this->Lease->find
      ('first', array
       ('contain' => array
	(// Models
	 'Unit' =>
	 array('order'  => array('sort_order'),
	       'fields' => array('id', 'name'),
	       ),

	 'Customer' =>
	 array('fields' => array('id', 'name'),
	       ),
	 ),

	'conditions' => array(array('Lease.id' => $id),
			      array('Lease.close_date' => null),
			      ),
	));


    // Get the lease balance, part of lease stats
    $this->Lease->statsMerge($lease['Lease'],
			     array('stats' => $this->Lease->stats($id)));

    // Determine the lease security deposit
    $deposit = $this->Lease->findSecurityDeposits($lease['Lease']['id']);
    if ($deposit['summary']['balance'] > 0)
      die("Still have un-utilized security deposit");

    $this->set('customer', $lease['Customer']);
    $this->set('unit',     $lease['Unit']);
    $this->set('lease',    $lease['Lease']);
    $this->set('account',  array('id' => $A->badDebtAccountID()));

/*     $redirect = array('controller' => 'leases', */
/* 		      'action' => 'view', */
/* 		      $id); */

    $title = ('Lease #' . $lease['Lease']['number'] . ': ' .
	      $lease['Unit']['name'] . ': ' .
	      $lease['Customer']['name'] . ': Write Off Bad Debt');
    $this->set(compact('title', 'redirect'));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: refund
   *  - Provides user with a refund
   *    REVISIT <AP>: 20090710
   *     Should this be a customer function?
   */

  function refund($id) {
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: close
   *  - Closes a lease to any further action
   */

  function close($id) {
    // REVISIT <AP>: 20090708
    //  We should probably seek confirmation first...
    $this->Lease->close($id);
    $this->redirect(array('action'=>'view', $id));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: invoice
   *  - Sets up the invoice entry page for the given customer.
   */

  function invoice($id = null, $type = null) {

    $lease = $this->Lease->find
      ('first', array
       ('contain' => array
	(// Models
	 'Unit' =>
	 array('order'  => array('sort_order'),
	       'fields' => array('id', 'name'),
	       ),

	 'Customer' =>
	 array('fields' => array('id', 'name'),
	       ),
	 ),

	'conditions' => array(array('Lease.id' => $id),
			      array('Lease.close_date' => null),
			      ),
	));

    $A = new Account();
    $charge_accounts = $A->chargeAccounts();
    $default_account = $A->rentAccountID();
    $this->set(compact('charge_accounts', 'default_account'));

    // REVISIT <AP> 20090705:
    //   Of course, the late charge should come from the late_schedule
    $default_rent = $lease['Lease']['rent'];
    $default_late = 10;
    $this->set(compact('default_rent', 'default_late'));

    $title = ('Lease #' . $lease['Lease']['number'] . ': ' .
	      $lease['Unit']['name'] . ': ' .
	      $lease['Customer']['name'] . ': Charge Entry');
    $this->set(compact('title', 'lease', 'charge'));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: view
   *  - Displays information about a specific lease
   */

  function view($id = null) {
    if (!$id) {
      $this->Session->setFlash(__('Invalid Item.', true));
      $this->redirect(array('action'=>'index'));
    }

    // Get details about the lease and its ledgers (no ledger entries yet)
    $lease = $this->Lease->find
      ('first',
       array('contain' =>
	     array(// Models
		   'LeaseType',
		   'Unit',
		   'Customer',
		   ),
	     'conditions' => array(array('Lease.id' => $id)),
	     )
       );

    $this->set('charge_gaps', $this->Lease->rentChargeGaps($id));
    $this->set('charge_through', $this->Lease->rentChargeThrough($id));

    // Obtain the overall lease balance
    $this->Lease->statsMerge($lease['Lease'],
			     array('stats' => $this->Lease->stats($id)));
    $outstanding_balance = $lease['Lease']['stats']['balance'];

    // Determine the lease security deposit
    $deposits = $this->Lease->findSecurityDeposits($lease['Lease']['id']);
    $outstanding_deposit = $deposits['summary']['balance'];

    // Set up dynamic menu items
    if (!isset($lease['Lease']['close_date'])) {
      $this->sidemenu_links[] =
	array('name' => 'Operations', 'header' => true);

      if (!isset($lease['Lease']['moveout_date']))
	$this->sidemenu_links[] =
	  array('name' => 'Move-Out', 'url' => array('action' => 'move_out',
						     $id));

      $this->sidemenu_links[] =
	array('name' => 'Charges', 'url' => array('action' => 'invoice',
						  $id));

      $this->sidemenu_links[] =
	array('name' => 'Payments', 'url' => array('controller' => 'customers',
						   'action' => 'receipt',
						   $lease['Customer']['id']));

      if (isset($lease['Lease']['moveout_date']) && $outstanding_deposit > 0)
	$this->sidemenu_links[] =
	  array('name' => 'Apply Deposit', 'url' => array('action' => 'apply_deposit',
							  $id));

      if (isset($lease['Lease']['moveout_date']) && $outstanding_deposit == 0 && $outstanding_balance > 0)
	$this->sidemenu_links[] =
	  array('name' => 'Write-Off', 'url' => array('action' => 'bad_debt',
						      $id));

      if ($this->Lease->closeable($id))
	$this->sidemenu_links[] =
	  array('name' => 'Close', 'url' => array('action' => 'close',
						  $id));
    }

    // Prepare to render
    $title = 'Lease: #' . $lease['Lease']['id'];
    $this->set(compact('lease', 'title',
		       'outstanding_deposit',
		       'outstanding_balance'));
  }
}