Issue 399: Implement updates to API::PrintStation::release

Author: kylemhall

lib/Libki/Controller/API/PrintStation/v1_0.pm

@@ -134,20 +134,22 @@ sub print_jobs : Path('print_jobs') : Args(0) {
 
     my $print_jobs = [];
     while ( my $j = $jobs->next ) {
-        my $cost = Libki::Utils::Printing::calculate_job_cost( $c, { print_job => $j } );
+        my ( $cost, $gratis_discount ) = Libki::Utils::Printing::calculate_job_cost( $c, { print_job => $j } );
 
         push(
             @$print_jobs,
             {
-                print_job_id  => $j->id,
-                printer       => $j->printer,
-                copies        => $j->copies,
-                created_on    => $c->format_dt( { dt => $j->created_on, include_time => 1 } ),
-                print_file_id => $j->print_file_id,
-                pages         => $j->print_file->pages,
-                cost          => $cost,
+                print_job_id => $j->id,
+                printer      => $j->printer,
+                copies       => $j->copies,
+                created_on   => $c->format_dt( { dt => $j->created_on, include_time => 1 } ),
+                print_file_id   => $j->print_file_id,
+                pages           => $j->print_file->pages,
+                cost            => $cost,
+                gratis_discount => $gratis_discount,
             }
         );
+
     }
 
     my $data = {

lib/Libki/Controller/Public/API/DataTables.pm

@@ -112,7 +112,7 @@ sub prints : Local Args(0) {
     foreach my $print_job (@prints) {
         my $print_file = $print_job->print_file;
 
-        my $total_cost = Libki::Utils::Printing::calculate_job_cost(
+        my ($total_cost, $gratis_discount) = Libki::Utils::Printing::calculate_job_cost(
             $c,
             {
                 print_job => $print_job,
@@ -131,7 +131,7 @@ sub prints : Local Args(0) {
         }
         keys %{$printers->{printers}} ) {
             my $printer = $printers->{printers}->{ $key };
-            my $total_cost = Libki::Utils::Printing::calculate_job_cost(
+            my ($total_cost, $gratis_discount) = Libki::Utils::Printing::calculate_job_cost(
                 $c,
                 {
                     print_job => $print_job,
@@ -144,6 +144,7 @@ sub prints : Local Args(0) {
                 selected => $key eq $print_job->printer ? 1 : 0,
                 name => $printer->{public_printer_name},
                 cost => $total_cost,
+                gratis_discount => $gratis_discount,
             };
 
             push( @printer_costs, $data );

lib/Libki/Utils/Printing.pm

@@ -4,6 +4,7 @@ use Modern::Perl;
 
 use File::Slurp qw( write_file );
 use File::Temp qw( tempfile );
+use JSON qw( to_json );
 use PDF::API2;
 use Try::Tiny;
 
@@ -148,7 +149,10 @@ sub create_print_job_and_file {
 
 =head2 calculate_job_cost
 
-Helper function to calculate the cost of a print job for a given printer
+Helper function to calculate the cost of a print job for a given printer.
+Returns a list containing the calculated cost and the gratis discount applied.
+
+    my ( $cost, $gratis_discount ) = calculate_job_cost( $c, { print_job => $job } );
 
 =cut
 
@@ -179,18 +183,31 @@ sub calculate_job_cost {
 
     my $total_pages = $pages * $copies;
 
-    # Fetch grais print settings and decrement pages or balance as needed
+    my $gratis_discount = 0;
+
     if ( $GratisPrintingMethod  eq 'pages' ) {
-        $total_pages -= $c->user->gratis_print_balance;        
+        if ( $total_pages >= $c->user->gratis_print_balance ) {
+            $gratis_discount = $c->user->gratis_print_balance;
+            $total_pages -= $c->user->gratis_print_balance;        
+        } else {
+            $gratis_discount = $total_pages;
+            $total_pages = 0;
+        }
     } 
 
     my $cost = $total_pages * $cpp;
 
     if ( $GratisPrintingMethod  eq 'balance' ) {
-        $cost -= $c->user->gratis_print_balance;        
+        if ( $cost >= $c->user->gratis_print_balance ) {
+            $gratis_discount = $c->user->gratis_print_balance;
+            $cost -= $c->user->gratis_print_balance;        
+        } else {
+            $gratis_discount = $cost;
+            $cost = 0;
+        }
     } 
 
-    return $cost;
+    return ($cost, $gratis_discount);
 }
 
 =head2 cancel
@@ -311,7 +328,7 @@ sub release {
         printer    => $printer,
     };
 
-    my $total_cost = calculate_job_cost( $c,
+    my ($total_cost, $gratis_discount) = calculate_job_cost( $c,
         {
             print_job => $print_job,
             printer   => $printer,
@@ -323,12 +340,33 @@ sub release {
     if ( $total_cost <= $user->funds ) {
         $user->debit_funds( $c, $total_cost );
 
+        $user->gratis_print_balance( $user->gratis_print_balance - $gratis_discount );
+
         $print_job->status(PRINT_STATUS_PENDING);
 
         $c->model('DB')->txn_do(
             sub {
                 $user->update();
                 $print_job->update();
+
+                # Add statistic indicating gratis discount was used
+                if ( $gratis_discount > 0 ) {
+                    $c->model('DB::Statistic')->create(
+                        {
+                            instance   => $c->instance,
+                            username   => $c->user->username,
+                            action     => 'GRATIS_DISCOUNT',
+                            created_on => $c->now,
+                            session_id => $c->sessionid,
+                            info       => to_json(
+                                {
+                                    print_job_id    => $print_job->id,
+                                    gratis_discount => $gratis_discount,
+                                }
+                            ),
+                        }
+                    );
+                }
             }
         );
     }