Merge in HEAD, up to 9866.

lib/WebGUI/Shop/AddressBook.pm

@@ -147,7 +147,7 @@ An address object's unique id.
 
 sub getAddress {
     my ($self, $addressId) = @_;
-    my $id = ref $self;
+    my $id = id $self;
     unless (exists $addressCache{$id}{$addressId}) {
         $addressCache{$id}{$addressId} = WebGUI::Shop::Address->new($self, $addressId);
     }

lib/WebGUI/Shop/Admin.pm

@@ -68,6 +68,7 @@ sub getAdminConsole {
     $ac->addSubmenuItem($url->page("shop=ship;method=manage"), $i18n->get("shipping methods"));
     $ac->addSubmenuItem($url->page("shop=transaction;method=manage"), $i18n->get("transactions"));
     $ac->addSubmenuItem($url->page("shop=vendor;method=manage"), $i18n->get("vendors"));
+    $ac->addSubmenuItem($url->page("shop=vendor;method=managePayouts"), $i18n->get("vendor payouts"));
     $ac->addSubmenuItem($url->page("shop=credit;method=manage"), $i18n->get("in shop credit"));
     return $ac;
 }

lib/WebGUI/Shop/Cart.pm

@@ -260,7 +260,7 @@ Returns a reference to the address book for the user who's cart this is.
 
 sub getAddressBook {
     my $self = shift;
-    my $id = ref $self;
+    my $id = id $self;
     unless (exists $addressBookCache{$id}) {
         $addressBookCache{$id} = WebGUI::Shop::AddressBook->newBySession($self->session);
     }    
@@ -297,7 +297,6 @@ sub getItem {
     unless (defined $itemId && $itemId =~ m/^[A-Za-z0-9_-]{22}$/) {
         WebGUI::Error::InvalidParam->throw(error=>"Need an itemId.");
     }
-    my $id = ref $self;
     my $item = WebGUI::Shop::CartItem->new($self, $itemId);
     return $item;
 }

lib/WebGUI/Shop/CartItem.pm

@@ -173,7 +173,6 @@ Returns an instanciated WebGUI::Asset::Sku object for this cart item.
 
 sub getSku {
     my ($self) = @_;
-    my $id = ref $self;
     my $asset = '';
     $asset = WebGUI::Asset->newByDynamicClass($self->cart->session, $self->get("assetId"));
     $asset->applyOptions($self->get("options"));

lib/WebGUI/Shop/TransactionItem.pm

@@ -267,11 +267,14 @@ sub update {
     if (exists $newProperties->{item}) {
         my $item = $newProperties->{ item };
         my $sku = $item->getSku;
-        $newProperties->{ options           } = $sku->getOptions;
-        $newProperties->{ assetId           } = $sku->getId;       
-        $newProperties->{ price             } = $sku->getPrice;       
-        $newProperties->{ configuredTitle   } = $item->get('configuredTitle');
-        $newProperties->{ quantity          } = $item->get('quantity');
+        $newProperties->{ options               } = $sku->getOptions;
+        $newProperties->{ assetId               } = $sku->getId;       
+        $newProperties->{ price                 } = $sku->getPrice;       
+        $newProperties->{ configuredTitle       } = $item->get('configuredTitle');
+        $newProperties->{ quantity              } = $item->get('quantity');
+        $newProperties->{ vendorId              } = $sku->getVendorId;
+        $newProperties->{ vendorPayoutAmount    } = sprintf '%.2f', $sku->getVendorPayout * $item->get('quantity');
+
         my $address = $item->getShippingAddress;
         $newProperties->{ shippingAddressId     } = $address->getId;
         $newProperties->{ shippingAddressName   } = $address->get('name');
@@ -289,7 +292,8 @@ sub update {
     }
     my @fields = (qw(assetId configuredTitle options shippingAddressId shippingTrackingNumber orderStatus
         shippingName shippingAddress1 shippingAddress2 shippingAddress3 shippingCity shippingState
-        shippingCountry shippingCode shippingPhoneNumber quantity price vendorId));
+        shippingCountry shippingCode shippingPhoneNumber quantity price vendorId 
+        vendorPayoutStatus vendorPayoutAmount));
     foreach my $field (@fields) {
         $properties{$id}{$field} = (exists $newProperties->{$field}) ? $newProperties->{$field} : $properties{$id}{$field};
     }

lib/WebGUI/Shop/Vendor.pm

@@ -5,7 +5,9 @@ use Class::InsideOut qw{ :std };
 use WebGUI::Shop::Admin;
 use WebGUI::Exception::Shop;
 use WebGUI::International;
-
+use WebGUI::Utility qw{ isIn };
+use List::Util qw{ sum };
+use JSON qw{ encode_json };
 
 =head1 NAME
 
@@ -406,4 +408,225 @@ sub www_manage {
 }
 
 
+#-------------------------------------------------------------------
+
+=head2 getPayoutTotals ( )
+
+Returns a hash ref, containing the payout details for this vendor. The keys in the hash are:
+
+=head3 paid
+
+The amount of money already transfered to the vendor.
+
+=head3 scheduled
+
+The amount of money scheduled to be transfered to the vendor.
+
+=head3 notPaid
+
+The amount of money that is yet to be scheduled for payment to the vendor.
+
+=head3 total
+
+The sum of these three values.
+
+=cut
+
+sub getPayoutTotals {
+    my $self    = shift;
+
+    my %totals = $self->session->db->buildHash(
+        'select vendorPayoutStatus, sum(vendorPayoutAmount) as amount from transactionItem '
+        .'where vendorId=? group by vendorPayoutStatus ',
+        [ $self->getId ]
+    );
+
+    # Format the payout categories and calc the total those.
+    %totals          = 
+        map     { lcfirst $_ => sprintf '%.2f', $totals{ $_ } } 
+                qw( Paid Scheduled NotPaid );
+    $totals{ total } = sprintf '%.2f', sum values %totals;
+
+    return \%totals;
+}
+
+#-------------------------------------------------------------------
+
+=head2 www_submitScheduledPayouts ()
+
+Sets the vendorPayoutStatus flag of scheduled payments to 'Paid'. 
+
+NOTE: This method does no payments at all. In the future this method should trigger some automated payout
+mechanism.
+
+=cut
+
+sub www_submitScheduledPayouts {
+    my $class   = shift;
+    my $session = shift;
+
+    my $admin   = WebGUI::Shop::Admin->new($session);
+    return $session->privilege->adminOnly() unless ($admin->canManage);
+
+    $session->db->write(
+        q{ update transactionItem set vendorPayoutStatus = 'Paid' where vendorPayoutStatus = 'Scheduled' }
+    );
+
+    return $class->www_managePayouts( $session );
+}
+
+#-------------------------------------------------------------------
+
+=head2 www_setPayoutStatus ( )
+
+Sets the vendorPayoutStatus flag for each transaction passed by the form param 'itemId'. The new status is passed
+by the form param 'status'. Status can either be 'NotPaid' or 'Scheduled' and may only be applied on items that do
+not have their vendorPayoutStatus set to 'Paid'.
+
+Returns the status to which the item(s) are set.
+=cut
+
+sub www_setPayoutStatus {
+    my $class   = shift;
+    my $session = shift;
+
+    my $admin   = WebGUI::Shop::Admin->new($session);
+    return $session->privilege->adminOnly() unless ($admin->canManage);
+
+    my @itemIds = $session->form->process('itemId');
+    my $status  = $session->form->process('status');
+    return "error: wrong status [$status]" unless isIn( $status, qw{ NotPaid Scheduled } );
+
+    foreach  my $itemId (@itemIds) {
+       my $item = WebGUI::Shop::TransactionItem->newByDynamicTransaction( $session, $itemId );
+       return "error: invalid transactionItemId [$itemId]" unless $item;
+       return "error: cannot change status of a Paid item" if $item->get('vendorPayoutStatus') eq 'Paid';
+    
+       $item->update({ vendorPayoutStatus => $status });
+    }
+
+    return $status;
+}
+
+#-------------------------------------------------------------------
+
+=head2 www_vendorTotalsAsJSON ( )
+
+Returns a JSON string containing all vendors and their payout details. If a vendor id is passed through form param
+'vendorId' only results for that vendor will be returned.
+
+=cut
+
+sub www_vendorTotalsAsJSON {
+    my $class       = shift;
+    my $session     = shift;
+
+    my $admin   = WebGUI::Shop::Admin->new($session);
+    return $session->privilege->adminOnly() unless ($admin->canManage);
+
+    my $vendorId    = $session->form->process('vendorId');
+    my ($vendorPayoutData, @placeholders);
+  
+    my @sql;
+    push @sql,
+        'select vendorId, vendorPayoutStatus, sum(vendorPayoutAmount) as total from transactionItem';
+    push @sql, ' where vendorId=? ' if $vendorId;
+    push @sql, ' group by vendorId, vendorPayoutStatus ';
+
+    push @placeholders, $vendorId if $vendorId;
+
+    my $sth = $session->db->read( join( ' ', @sql) , \@placeholders );
+    while (my $row = $sth->hashRef) {
+        $vendorPayoutData->{ $row->{vendorId} }->{ $row->{vendorPayoutStatus} } = $row->{total};
+    }
+    $sth->finish;
+
+    my @dataset;
+    foreach my $vendorId (keys %{ $vendorPayoutData }) {
+        my $vendor = WebGUI::Shop::Vendor->new( $session, $vendorId );
+
+        push @dataset, {
+            %{ $vendor->get },
+            %{ $vendorPayoutData->{ $vendorId } },
+        }
+    }
+
+    $session->http->setMimeType( 'application/json' );
+    return JSON::to_json( { vendors => \@dataset } );
+}
+
+#-------------------------------------------------------------------
+sub www_payoutDataAsJSON {
+    my $class   = shift;
+    my $session = shift;
+
+    my $admin   = WebGUI::Shop::Admin->new($session);
+    return $session->privilege->adminOnly() unless ($admin->canManage);
+
+    my $vendorId    = $session->form->process('vendorId');
+    my $startIndex  = $session->form->process('startIndex');
+    my $rowsPerPage = $session->form->process('results') || 100;
+    my $pageNumber  = int( $startIndex / $rowsPerPage ) + 1;
+    
+    my $sql         = 
+        "select t1.* from transactionItem as t1 join transaction as t2 on t1.transactionId=t2.transactionId "
+        ." where vendorId=? and vendorPayoutAmount > 0 and vendorPayoutStatus <> 'Paid' order by t2.orderNumber";
+    my $placeholders =  [ $vendorId ];
+
+    my $paginator   = WebGUI::Paginator->new( $session, '', $rowsPerPage, '', $pageNumber ); 
+    $paginator->setDataByQuery( $sql, undef, 0, $placeholders );
+
+    my $data = {
+        totalRecords    => $paginator->getRowCount,
+        results         => $paginator->getPageData,
+    };
+
+    $session->http->setMimeType( 'application/json' );
+
+    return JSON::to_json( $data );
+}
+
+#-------------------------------------------------------------------
+sub www_managePayouts {
+    my $class   = shift;
+    my $session = shift;
+
+    my $admin   = WebGUI::Shop::Admin->new($session);
+    return $session->privilege->adminOnly() unless ($admin->canManage);
+    
+    # Load the required YUI stuff.
+    $session->style->setLink('/extras/yui/build/paginator/assets/skins/sam/paginator.css', {type=>'text/css', rel=>'stylesheet'});
+    $session->style->setLink('/extras/yui/build/datatable/assets/skins/sam/datatable.css', {type=>'text/css', rel=>'stylesheet'});
+    $session->style->setLink('/extras/yui/build/button/assets/skins/sam/button.css', {type=>'text/css', rel=>'stylesheet'});
+    $session->style->setScript('/extras/yui/build/yahoo-dom-event/yahoo-dom-event.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/element/element-beta-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/connection/connection-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/json/json-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/paginator/paginator-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/datasource/datasource.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/datatable/datatable-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/yui/build/button/button-min.js', {type=>'text/javascript'});
+    $session->style->setScript('/extras/VendorPayout/vendorPayout.js', {type=>'text/javascript'});
+
+    # Add css for scheduled payout highlighting
+    $session->style->setRawHeadTags(<<CSS);
+        <style type="text/css">
+            .yui-skin-sam .yui-dt tr.scheduled,
+            .yui-skin-sam .yui-dt tr.scheduled td.yui-dt-asc,
+            .yui-skin-sam .yui-dt tr.scheduled td.yui-dt-desc,
+            .yui-skin-sam .yui-dt tr.scheduled td.yui-dt-asc,
+            .yui-skin-sam .yui-dt tr.scheduled td.yui-dt-desc {
+                background-color    : #080;
+                color               : #fff;
+            }
+        </style>
+CSS
+
+    my $output = q{<div id="vendorPayoutContainer" class="yui-skin-sam"></div>}
+        .q{<script type="text/javascript">var vp = new WebGUI.VendorPayout( 'vendorPayoutContainer' );</script>};
+
+    my $console = WebGUI::Shop::Admin->new($session)->getAdminConsole;
+    return $console->render($output, 'Vendor payout'); #$i18n->get("vendors"));
+}
+
 1;