First pass at implementing a new lock tracking mechnism. Not complete, but the basics seem to work

git-svn-id: file:///svn-source/pmgr/branches/v0.3_work@1038 97e9348a-65ac-dc4b-aefc-98561f571b83

site/controllers/locks_controller.php

@@ -0,0 +1,152 @@
+<?php
+
+class LocksController extends AppController {
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * override: addGridViewSideMenuLinks
+   *  - Adds grid view navigation side menu links
+   */
+
+  function addGridViewSideMenuLinks() {
+    parent::addGridViewSideMenuLinks();
+
+    $this->addSideMenuLink('Add',
+    			   array('controller' => 'locks', 'action' => 'add'), null,
+    			   'CONTROLLER');
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * action: index / all
+   *  - Generate a listing of locks
+   */
+
+  function index()       { $this->all(); }
+  function all()         { $this->gridView('Locks', 'all'); }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * virtuals: gridData
+   *  - With the application controller handling the gridData action,
+   *    these virtual functions ensure that the correct data is passed
+   *    to jqGrid.
+   */
+
+  /* function gridDataCountTables(&$params, &$model) { */
+  /*   return array('link' => array('Unit')); */
+  /* } */
+
+  function gridDataTables(&$params, &$model) {
+    $tables = parent::gridDataTables($params, $model);
+    $tables['link']['LocksUnit'] = array();
+    return $tables;
+  }
+
+  function gridDataFields(&$params, &$model) {
+    $fields = parent::gridDataFields($params, $model);
+    $fields[] = 'COUNT(LocksUnit.id) AS inuse';
+    return $fields;
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * action: view
+   *  - Displays information about a specific entry
+   */
+
+  function view($id = null) {
+    if (!$id) {
+      $this->Session->setFlash(__('Invalid Item.', true));
+      $this->redirect(array('controller' => 'accounts', 'action'=>'index'));
+    }
+
+    // Get the UnitSize and related fields
+    $this->Lock->id = $id;
+    $lock = $this->Lock->find
+      ('first', array
+       ('contain' => array(),
+	));
+    //$lock['Lock'] = $lock[0] + $lock['lock'];
+    //unset($lock[0]);
+
+    $this->addSideMenuLink('Edit',
+			   array('action' => 'edit', $id), null,
+			   'ACTION');
+
+    $this->set(compact('lock'));
+
+    // Prepare to render.
+    $title = "Lock : {$lock['Lock']['name']}";
+    $this->set(compact('title'));
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * action: edit
+   *  - Edit customer information
+   */
+
+  function edit($id = null) {
+    if (isset($this->data)) {
+      // Check to see if the operation was cancelled.
+      if (isset($this->params['form']['cancel'])) {
+	if (isset($this->data['Lock']['id']))
+	  $this->redirect(array('action'=>'view', $this->data['Lock']['id']));
+
+	$this->redirect(array('action'=>'index'));
+      }
+
+      // Save the lock and all associated data
+      if (!$this->Lock->saveLock($this->data)) {
+	$this->Session->setFlash("LOCK SAVE FAILED", true);
+	pr("LOCK SAVE FAILED");
+      }
+
+      // View the lock by redirect
+      $this->redirect(array('action'=>'view', $this->Lock->id));
+    }
+
+    if ($id) {
+      // Get details on this customer, its contacts and leases
+      $lock = $this->Lock->find
+	('first', array
+	 ('conditions' => array('Lock.id' => $id),
+	  ));
+
+      $this->data = $lock;
+      $title = 'Lock: ' . $this->data['Lock']['name'] . " : Edit";
+    }
+    else {
+      $title = "Enter New Lock Information";
+      $this->data = array();
+    }
+
+    // Prepare to render.
+    //pr($this->data);
+    $this->set(compact('title'));
+    $this->render('edit');
+  }
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * action: add
+   *  - Add a new lock
+   */
+
+  function add() {
+    $this->edit();
+  }
+
+}

site/controllers/units_controller.php

@@ -213,7 +213,7 @@ class UnitsController extends AppController {
   /**************************************************************************
    **************************************************************************
    **************************************************************************
-   * action: lock/unlock
+   * action: lock/unlock/lien
    *  - Transitions the unit into / out of the LOCKED state
    */
 
@@ -221,8 +221,73 @@ class UnitsController extends AppController {
     $this->Unit->updateStatus($id, $status, true);
     $this->redirect(array('action' => 'view', $id));
   }
-  function lock($id)    { $this->status($id, 'LOCKED'); }
-  function unlock($id)  { $this->status($id, 'OCCUPIED'); }
+
+  function lock($id) {
+    if (isset($this->data)) {
+      $id = $this->id = $this->data['Unit']['id'];
+
+      // Check to see if the operation was cancelled.
+      if (isset($this->params['form']['cancel'])) {
+	if (isset($id))
+	  $this->redirect(array('action'=>'view', $id));
+
+	$this->redirect(array('action'=>'index'));
+      }
+
+      // Figure out which locks the user put on
+      $locks = array();
+      if (isset($this->data['Lock']) && is_array($this->data['Lock'])) {
+	foreach ($this->data['Lock'] AS $lock) {
+	  $locks[] = $lock['id'];
+	}
+      }
+
+      // Save the lock and all associated data
+      if (!$this->Unit->lockUnit($id, $locks)) {
+    	$this->Session->setFlash("UNIT LOCK FAILED", true);
+    	pr("UNIT LOCK FAILED");
+      }
+
+      // If it's no longer locked, change status to OCCUPIED
+      // Could still be liened... but that would be odd.
+      if (count($locks) == 0)
+	$this->status($id, 'OCCUPIED');
+
+      // If we're not liened, we must now just be locked
+      if (!$this->Unit->liened($id))
+	$this->status($id, 'LOCKED');
+
+      // Otherwise, don't change anything.
+      $this->redirect(array('action' => 'view', $id));
+    }
+
+    if (!$id)
+	$this->INTERNAL_ERROR("$id cannot be NULL");
+
+    // Get all locks on this unit
+    $this->data = $this->Unit->find
+      ('first',
+       array('contain' => array('Lock' => array('id')),
+	     'fields' => array('id'),
+	     'conditions' => array('Unit.id' => $id)
+	     ));
+
+    $locks = $this->Unit->Lock->lockList();
+    /* $locksold = $locks; */
+    /* foreach ($locksold AS $name) { */
+    /*   $locks[$name] = $name; */
+    /* } */
+    $this->set(compact('locks'));
+
+    // Prepare to render.
+    //pr($this->data);
+    $this->set(compact('title'));
+    //    $this->render('lock');
+  }
+
+
+  function unlock($id)  { $this->lock($id); }
+  function lien($id)    { $this->status($id, 'LIENED'); }
 
 
   /**************************************************************************
@@ -339,15 +404,20 @@ class UnitsController extends AppController {
     if ($this->Unit->occupied($unit['Unit']['status']) &&
 	!$this->Unit->locked($unit['Unit']['status']))
       $this->addSideMenuLink('Lock',
-			     array('action' => 'Lock', $id), null,
+			     array('action' => 'lock', $id), null,
 			     'ACTION');
 
     // If the unit is locked, provide an option to unlock it,
-    // unless it's locked due to lien, which is not so simple.
+    if ($this->Unit->locked($unit['Unit']['status']))
+      $this->addSideMenuLink('Relock/Unlock',
+			     array('action' => 'lock', $id), null,
+			     'ACTION');
+
+    // If the unit is locked, but not liened, give option to lien.
     if ($this->Unit->locked($unit['Unit']['status']) &&
 	!$this->Unit->liened($unit['Unit']['status']))
-      $this->addSideMenuLink('Unlock',
-			     array('action' => 'unlock', $id), null,
+      $this->addSideMenuLink('Lien',
+			     array('action' => 'lien', $id), null,
 			     'ACTION');
 
     // If there is a current lease on this unit, then provide

site/models/lock.php

@@ -0,0 +1,67 @@
+<?php
+class Lock extends AppModel {
+
+	var $name = 'Lock';
+	var $validate = array(
+		'id' => array('numeric'),
+		'name' => array('notempty'),
+		'key' => array('notempty')
+	);
+
+	var $hasMany = array(
+		'LocksUnits'
+	);
+
+	var $hasAndBelongsToMany = array(
+		'Unit'
+	);
+
+	var $default_log_level = array('log' => 30, 'show' => 15);
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: saveLock
+   *  - save data about a new or existing lock
+   */
+
+  function saveLock($data) {
+    $this->prEnter(compact('data'));
+    $id = $data['Lock']['id'];
+
+    if ($id) {
+      $this->id = $id;
+
+      // Save the old key
+      $oldkey = $this->field('key');
+      $this->pr(5, compact('oldkey'));
+
+      if ($this->field('key') != $data['Lock']['key'])
+	$data['Lock']['last_key'] = $this->field('key');
+
+      /* // Find the number of outstanding locks in use */
+      /* $locks = $this->find('first', */
+      /* 			   array('link' => array('Unit' => array('fields' => array('Unit.id'))), */
+      /* 				 'fields' => 'SUM(Unit.id) AS inuse', */
+      /* 				 'conditions' => array('Lock.id' => $id), */
+      /* 				 )); */
+      /* $this->pr(5, compact('locks')); */
+
+      /* // Can't reduce the locks if there are all in use */
+      /* if ($locks[0]['inuse'] > $data['Lock']['qty']) */
+      /* 	return $this->prReturn(false); */
+    }
+
+    // Everything looks good... save it!
+    return $this->prReturn($this->save($data, false));
+  }
+
+  function lockList() {
+    return $this->find('list',
+		       array('order' =>
+			     array('name'),
+			     ));
+  }
+
+}

site/models/locks_unit.php

@@ -0,0 +1,11 @@
+<?php
+class LocksUnit extends AppModel {
+	var $primaryKey = false;
+
+	var $belongsTo = array(
+		'Lock',
+		'Unit',
+	);
+
+}
+?>

site/models/unit.php

@@ -25,6 +25,11 @@ class Unit extends AppModel {
 
 	var $hasMany = array(
 		'Lease',
+		'LocksUnit'
+	);
+
+	var $hasAndBelongsToMany = array(
+		'Lock'
 	);
 
 	//var $default_log_level = array('log' => 30, 'show' => 15);
@@ -209,6 +214,40 @@ class Unit extends AppModel {
   }
 
 
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: lockUnit
+   *  - Put lock on unit
+   */
+  function lockUnit($id, $lock_ids) {
+    $this->prEnter(compact('id', 'lock_ids'));
+    $this->id = $id;
+
+    // Remove any exising locks for this unit
+    $this->LocksUnit->deleteAll
+      (array('unit_id' => $id), false);
+
+    // We'll proceed forward as much as possible, even
+    // if we encounter an error.  For now, we'll assume
+    // the operation will succeed.
+    $ret = true;
+
+    // Go through each lock, and put them on the unit
+    foreach ($lock_ids AS $lock_id) {
+      $pair['unit_id'] = $id;
+      $pair['lock_id'] = $lock_id;
+
+      // Save the relationship between lock and unit
+      $LU = new LocksUnit();
+      if (!$LU->save($pair, false))
+	$ret = false;
+    }
+
+    return $this->prReturn($ret);
+  }
+
+
   /**************************************************************************
    **************************************************************************
    **************************************************************************

site/views/elements/locks.ctp

@@ -0,0 +1,18 @@
+<?php /* -*- mode:PHP -*- */
+
+// Define the table columns
+$cols = array();
+$cols['Name']     = array('index' => 'name',             'formatter' => 'longname');
+$cols['Quantity'] = array('index' => 'qty',              'formatter' => 'number');
+$cols['Key']      = array('index' => 'key',              'formatter' => 'shortname');
+$cols['Last Key'] = array('index' => 'last_key',         'formatter' => 'shortname');
+$cols['Comment']  = array('index' => 'comment',          'formatter' => 'comment');
+
+// Render the grid
+$grid
+->columns($cols)
+->sortField('Name')
+->defaultFields(array('Name'))
+->searchFields(array('Name'))
+->render($this, isset($config) ? $config : null,
+	 array_diff(array_keys($cols), array('Comment')));

site/views/locks/edit.ctp

@@ -0,0 +1,48 @@
+<?php /* -*- mode:PHP -*- */
+
+//pr($this->data);
+?>
+
+<script type="text/javascript"><!--
+
+  // Reset the form
+  function newKey(dig) {
+   $('#LockKey').val(("000000000" + Math.floor(Math.random()*(Math.pow(10,dig)))) . slice(-1*dig));
+  }
+
+--></script>
+
+<?php
+; // alignment
+
+/**********************************************************************
+ **********************************************************************
+ **********************************************************************
+ **********************************************************************
+ * Lock Edit
+ */
+
+echo '<div class="lock edit">' . "\n";
+
+echo $form->create('Lock', array('action' => 'edit')) . "\n";
+echo $form->input('id') . "\n";
+
+echo($this->element
+     ('form_table',
+      array('class'  => 'item lock detail',
+	    'caption' => isset($this->data['Lock']) ? 'Edit Lock' : 'New Lock',
+	    'fields' => array
+	    ('name' => array('label_attributes' => array('class' => 'empty'),
+			     'after' => ("Name of the Lock Set")),
+	     'key'  => array('label_attributes' => array('class' => 'empty'),
+			     'after' => ('(<A HREF="#" ONCLICK="newKey(4); return false;">New</A>) Key Code / Combination')),
+	     'qty'  => array('label_attributes' => array('class' => 'empty'),
+			     'after' => ("Quantity")),
+	     'comment' => array('label_attributes' => array('class' => 'optional empty'),
+				'after' => 'Optional: Comments about this lock set.'),
+	     ))) . "\n");
+
+echo $form->submit(isset($this->data['Lock']) ? 'Update' : 'Add New Lock') . "\n";
+echo $form->submit('Cancel', array('name' => 'cancel')) . "\n";
+echo $form->end() . "\n";
+echo '</div>' . "\n";

site/views/locks/view.ctp

@@ -0,0 +1,43 @@
+<?php /* -*- mode:PHP -*- */
+
+echo '<div class="lock view">' . "\n";
+
+/**********************************************************************
+ **********************************************************************
+ **********************************************************************
+ **********************************************************************
+ * Lock Detail Main Section
+ */
+
+$lock    = $lock['Lock'];
+
+$rows = array();
+$rows[] = array('Name',        $lock['name']);
+$rows[] = array('Quantity',    $lock['qty']);
+$rows[] = array('Key',         $lock['key']);
+if (!empty($lock['last_key']))
+  $rows[] = array('Last Key',    $lock['last_key']);
+$rows[] = array('Comment',     $lock['comment']);
+
+echo $this->element('table',
+		    array('class'   => 'item lock detail',
+			  'caption' => 'Lock Information',
+			  'rows'    => $rows,
+			  'column_class' => array('field', 'value')));
+
+
+
+/**********************************************************************
+ **********************************************************************
+ **********************************************************************
+ **********************************************************************
+ * Supporting Elements Section
+ */
+
+echo '<div CLASS="detail supporting">' . "\n";
+
+/* End "detail supporting" div */
+echo '</div>' . "\n";
+
+/* End page div */
+echo '</div>' . "\n";

site/views/units/lock.ctp

@@ -0,0 +1,142 @@
+<?php /* -*- mode:PHP -*- */
+
+/**********************************************************************
+ * Because we make use of functions here,
+ * we need to put our top level variables somewhere
+ * we can access them.
+ */
+$this->varstore = compact('locks');
+
+function lockDiv($obj) {
+
+  $div = 
+    // BEGIN lock-div
+    '<DIV>' . "\n" .
+    // BEGIN lock-fieldset
+    '<FIELDSET CLASS="lock subset">' . "\n" .
+    '<LEGEND>Lock #%{id} (%{remove})</LEGEND>' . "\n" .
+
+    // BEGIN lock-n-div
+    '<div id="lock-%{id}-div">' . "\n" .
+
+    $obj->element
+    ('form_table',
+     array('class'  => "item lock entry",
+	   'field_prefix' => 'Lock.%{id}',
+	   'fields' => array
+	   (
+	    'id' => array('name' => 'Lock',
+			  'label_attributes' => array('class' => 'required'),
+			  'opts' => array('options' => $obj->varstore['locks']),
+			  'after' => "Select the lock."),
+
+	    ))) . "\n" .
+    
+    // END lock-n-div
+    '</div>' . "\n" . 
+
+    // END lock-fieldset
+    '</FIELDSET>' . "\n" . 
+    // END lock-div
+    '</DIV>'
+    ;
+
+  return $div;
+}
+
+
+/**********************************************************************
+ **********************************************************************
+ **********************************************************************
+ **********************************************************************
+ * Javascript
+ */
+
+?>
+
+<script type="text/javascript"><!--
+
+  function addLock(flash) {
+    addDiv('lock-entry-id', 'lock', 'locks', flash, <?php
+	   echo FormatHelper::phpVarToJavascript
+	   (lockDiv($this),
+	    null,
+	    '           ');
+	   ?>
+	   );
+  }
+
+  // Reset the form
+  function resetForm() {
+    $('#locks').html('');
+    $('#lock-entry-id').val(1);
+
+    <?php foreach ($this->data['Lock'] AS $lock): ?>
+    addDiv('lock-entry-id', 'lock', 'locks', false, <?php
+	   echo FormatHelper::phpVarToJavascript
+	   (lockDiv($this),
+	    null,
+	    '           ');
+	   ?>
+	   );
+    $('#Lock'+($('#lock-entry-id').val()-1)+'Id').val(<?php echo $lock['id'] ?>);
+    <?php endforeach; ?>
+
+    if ($("#lock-entry-id").val() == 1) {
+      addDiv('lock-entry-id', 'lock', 'locks', false, <?php
+	     echo FormatHelper::phpVarToJavascript
+	     (lockDiv($this),
+	      null,
+	      '           ');
+	     ?>
+	     );
+    }
+  }
+
+  $(document).ready(function(){
+      resetForm();
+    });
+
+--></script>
+
+<?php
+; // alignment
+
+/**********************************************************************
+ **********************************************************************
+ **********************************************************************
+ **********************************************************************
+ * Unit-Lock Edit
+ */
+
+echo '<div class="unit-lock edit">' . "\n";
+
+echo $form->create('Unit', array('action' => 'lock')) . "\n";
+echo $form->hidden('id') . "\n";
+
+?>
+
+<div CLASS="dynamic-set">
+<fieldset CLASS="lock superset">
+ <legend>Locks</legend>
+ <input type="hidden" id="lock-entry-id" value="0">
+ <div id="locks"></div>
+  <fieldset> <legend>
+   <a href="#" onClick="addLock(true); return false;">Add a Lock</a>
+  </legend> </fieldset>
+</fieldset>
+</div>
+
+<?php
+; // Alignment
+
+echo $form->submit('Update Locks') . "\n";
+echo $form->submit('Cancel', array('name' => 'cancel')) . "\n";
+echo $form->end() . "\n";
+echo '</div>' . "\n";
+
+echo "\n<PRE>\n";
+echo print_r($this->data, true);
+echo print_r($this->varstore, true);
+echo "\n</PRE>\n";
+