This repository was archived by the owner on Sep 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathorder.py
More file actions
895 lines (725 loc) · 26.2 KB
/
order.py
File metadata and controls
895 lines (725 loc) · 26.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
# -*- coding: utf-8 -*-
from server import db, errors, session, conf, request, exposed, internalExposed, securitykey
from server.tasks import callDeferred, PeriodicTask
from server.skeleton import Skeleton
from server.bones import *
from server.prototypes.list import List
from datetime import datetime, timedelta
import logging
class OrderSkel( Skeleton ):
kindName = "order"
bill_gender = selectBone( descr=u"Bill-gender", required=True, values={"male":"Mr.", "female":"Mrs."} )
bill_firstname = stringBone( descr=u"Bill-first name", params={"indexed": True, "frontend_list_visible": True},required=True,unsharp=True )
bill_lastname = stringBone( descr=u"Bill-last name", params={"indexed": True, "frontend_list_visible": True},required=True,unsharp=True )
bill_street = stringBone( descr=u"Bill-street", params={"indexed": True, "frontend_list_visible": True},required=True )
bill_city = stringBone( descr=u"Bill-city",required=True )
bill_zip = stringBone( descr=u"Bill-zipcode",required=True,unsharp=True )
bill_country = selectCountryBone( descr=u"Bill-country", codes=selectCountryBone.ISO2, required=True)
bill_email = emailBone( descr=u"email", required=True, unsharp=True)
shipping_firstname = stringBone( descr=u"Shipping-first name", params={"indexed": True, "frontend_list_visible": True},required=True,unsharp=True )
shipping_lastname = stringBone( descr=u"Shipping-last name", params={"indexed": True, "frontend_list_visible": True},required=True,unsharp=True )
shipping_street = stringBone( descr=u"Shipping-street", params={"indexed": True, "frontend_list_visible": True},required=True )
shipping_city = stringBone( descr=u"Shipping-city",required=True )
shipping_zip = stringBone( descr=u"Shipping-zipcode",required=True,unsharp=True )
shipping_country = selectCountryBone( descr=u"Shipping-country", codes=selectCountryBone.ISO2, required=True )
extrashippingaddress = booleanBone( descr=u"Use alternative Shipment-Address", required=True)
price = numericBone( descr=u"Grand total", precision=2, required=True, readOnly=True, indexed=True )
state_complete = selectBone( descr=u"Complete", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
state_payed = selectBone( descr=u"Paid", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
state_send = selectBone( descr=u"Send", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
state_rts = selectBone( descr=u"Ready to ship", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
state_canceled = selectBone( descr=u"Canceled", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
state_archived = selectBone( descr=u"Archived", values={"0":"No","1":"Yes"}, defaultValue=0, readOnly=True, required=True, visible=False, indexed=True )
idx = numericBone( descr=u"Order-number", required=True, readOnly=True, params={"indexed": True, "frontend_list_visible": True}, indexed=True )
shipping_type = selectBone( descr=u"Type of shipment", values={"0":"uninsured", "1":"insured"} , required=True)
payment_type = selectBone( descr=u"Type of payment", values={"prepaid":"Bank-transfer", "pod":"Pay on Deliver", "paypal":"Paypal", "sofort":"Sofort"} , required=True)
subSkels = {
"billaddress":["bill_*", "extrashippingaddress"],
"shippingaddress": ["shipping_*"],
"shiptype": ["shipping_type", "payment_type"]
}
class SkipStepException( Exception ):
"""Raise this Exception to skip the current step"""
pass
class ReturnHtmlException( Exception ):
"""Raise this Exception to force the return of the given HTML inside a pre/post handler"""
def __init__(self, html ):
super( ReturnHtmlException, self ).__init__()
self.html = html
from server.modules.order_paypal import PayPal
from server.modules.order_sofort import Sofort
class Order( List ):
"""
Provides an unified ordering process with payment-handling.
This is encoded as a state machine.
"""
archiveDelay = timedelta( days=31 ) # Archive completed orders after 31 Days
paymentProviders = [PayPal,Sofort]
states = [
"complete", # The user completed all steps of the process, he might got redirected to a paymentprovider
"payed", # This oder has been payed
"rts", # Ready to Ship
"send", # Goods got shipped
"canceled", # Order got canceled
"archived" # This order has been executed
]
adminInfo = {
"name": "Orders", # Name of this module, as shown in ViUR Admin (will be translated at runtime)
"handler": "list.order", # Which handler to invoke
"icon": "icons/modules/cart.svg", # Icon for this module
"filter": {
"orderby": "creationdate",
"orderdir": 1,
"state_complete": "1"
},
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"],
"views": [
{
"name": u"Not shipped",
"filter": {
"state_archived": "0",
"state_complete": "1",
"state_send": "0",
"state_canceled": "0",
"orderby": "creationdate",
"orderdir": 1
},
"icon": "icons/status/order_not_shipped.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Unpaid",
"filter": {
"state_archived": "0",
"state_complete": "1",
"state_payed": "0",
"state_canceled": "0",
"orderby": "creationdate",
"orderdir": 1
},
"icon": "icons/status/order_unpaid.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Paid",
"filter": {
"state_archived": "0",
"state_complete": "1",
"state_payed": "1",
"state_canceled": "0",
"orderby": "creationdate",
"orderdir": 1
},
"icon": "icons/status/order_paid.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Shipped",
"filter": {
"state_archived": "0",
"state_complete": "1",
"state_canceled": "0",
"state_send": "1",
"orderby": "changedate",
"orderdir": 1
},
"icon": "icons/status/order_shipped.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Ready to ship",
"filter": {
"state_archived": "0",
"state_canceled": "0",
"state_complete": "1",
"state_send": "0",
"state_rts": "1",
"orderby": "changedate",
"orderdir": 1
},
"icon": "icons/status/order_ready.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Canceled",
"filter": {
"state_archived": "0",
"state_canceled": "1",
"state_complete": "1",
"orderby": "changedate",
"orderdir": 1
},
"icon": "icons/status/order_cancelled.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}, {
"name": u"Archived",
"filter": {
"state_archived": "1",
"state_complete": "1",
"orderby": "changedate",
"orderdir": 1
},
"icon": "icons/status/archived.svg",
"columns": ["idx", "bill_firstname", "bill_lastname", "amt", "price", "creationdate"]
}
]
}
def __init__(self, *args, **kwargs):
super( Order, self ).__init__( *args, **kwargs )
# Initialize the payment-providers
self.initializedPaymentProviders = {}
for p in self.paymentProviders:
pInstance = p( self )
self.initializedPaymentProviders[ pInstance.__class__.__name__.lower() ] = pInstance
#Also put it as an object into self, sothat any exposed function is reachable
setattr( self, "pp_%s" % pInstance.__class__.__name__.lower(), pInstance )
def setState(self, orderKey, state, removeState = False):
"""
Set a status on the given order.
:param orderKey: Key of the order
:type orderKey: str
:param state: An state out of self.states
:type state: str
:param removeState: Should the state be removed instead of set
:type removeState: bool
"""
def txn( orderKey, state, removeState ):
dbObj = db.Get( db.Key( orderKey ) )
if not dbObj:
return
dbObj[ "state_%s" % state ] = "1" if not removeState else "0"
dbObj["changedate"] = datetime.now()
db.Put( dbObj )
db.RunInTransaction( txn, orderKey, state, removeState )
def getStates(self, orderKey):
"""
Returns the states currently set for the given order.
:param orderKey: Key of the order
:type orderKey: str
:returns: States of the given order.
:rtype: list of str
"""
dbObj = db.Get( db.Key( orderKey ) )
res = []
if not dbObj:
return res
for state in self.states:
stateName = "state_%s" % state
if stateName in dbObj and str( dbObj[ stateName ] )=="1":
res.append( state )
return res
def setComplete( self, orderKey ):
"""
Mark an order as complete.
May be overridden to hook this event.
:param orderKey: Order to mark completed.
:type orderKey: str
:returns: True on success.
:rtype: bool
"""
order = self.editSkel()
if not order.fromDB( str(orderKey) ):
return False
self.setState( orderKey, "complete")
if order[ "payment_type" ].value == "pod":
states = self.getStates( orderKey )
if not any( [ x in states for x in ["canceled", "rts", "send"] ] ):
self.setRTS( orderKey )
self.assignBillSequence( str(orderKey) )
return True
def setRTS(self, orderKey):
"""
Marks an order to be ready to send.
May be overridden to hook this event.
:param orderKey: Order to mark
:type orderKey: str
"""
self.setState( orderKey, "rts")
def setPayed(self, orderKey):
"""
Marks an order to as paid.
May be overridden to hook this event.
:param orderKey: Order to mark
:type orderKey: str
"""
self.setState( orderKey, "payed")
states = self.getStates( orderKey )
if not any( [ x in states for x in ["rts", "send", "canceled", "closed"] ] ):
self.setState( orderKey,"rts")
self.sendOrderPayedEMail( orderKey )
return( True )
def setSend(self, orderKey):
"""
Marks an order as shipped.
May be overridden to hook this event.
:param orderKey: Order to mark
:type orderKey: str
"""
self.setState( orderKey, "send" )
self.setState( orderKey, "rts", True )
self.sendOrderShippedEMail( orderKey )
return( True )
def setCanceled(self, orderKey):
"""
Marks an order as cancelled.
May be overridden to hook this event.
:param orderKey: Order to mark
:type orderKey: str
"""
self.setState( orderKey, "canceled" )
self.setState( orderKey, "rts", True )
self.sendOrderCanceledEMail( orderKey )
return( True )
def setArchived(self, orderKey ):
"""
Marks an order as archived.
May be overridden to hook this event.
:param orderKey: Order to mark
:type orderKey: str
"""
self.setState( orderKey, "archived" )
self.setState( orderKey, "rts", True )
self.sendOrderArchivedEMail( orderKey )
return( True )
def sendOrderShippedEMail(self, orderKey):
"""
Hook event to send an email when the given order is marked as shipped.
:param orderKey: The order.
:type orderKey: str
"""
pass
def sendOrderCompleteEMail(self, orderKey):
"""
Hook event to send an email when the given order is marked as completed.
:param orderKey: The order.
:type orderKey: str
"""
pass
def sendOrderPayedEMail(self, orderKey):
"""
Hook event to send an email when the given order is marked as paid.
:param orderKey: The order.
:type orderKey: str
"""
pass
def sendOrderCanceledEMail(self, orderKey):
"""
Hook event to send an email when the given order is marked as cancelled.
:param orderKey: The order.
:type orderKey: str
"""
pass
def sendOrderArchivedEMail(self, orderKey):
"""
Hook event to send an email when the given order is archived.
:param orderKey: The order.
:type orderKey: str
"""
pass
@exposed
def markPayed( self, key, skey, *args, **kwargs ):
"""
Exposed function for marking an order as paid.
:param key: The key of the order to be marked.
:type key: str
"""
if not self.canEdit( key ):
raise errors.Unauthorized()
if not securitykey.validate( skey ):
raise errors.PreconditionFailed()
self.setPayed(key)
return "OKAY"
@exposed
def markSend( self, key, skey, *args, **kwargs ):
"""
Exposed function for marking an order as sent.
:param key: The key of the order to be marked.
:type key: str
"""
if not self.canEdit( key ):
raise errors.Unauthorized()
if not securitykey.validate( skey ):
raise errors.PreconditionFailed()
self.setSend(key)
return "OKAY"
@exposed
def markCanceled( self, key, skey, *args, **kwargs ):
"""
Exposed function for marking an order as cancelled.
:param key: The key of the order to be marked.
:type key: str
"""
if not self.canEdit( key ):
raise errors.Unauthorized()
if not securitykey.validate( skey ):
raise errors.PreconditionFailed()
self.setCanceled( key )
return "OKAY"
def checkSkipShippingAddress( self, step, orderKey, *args, **kwargs ):
"""
This step updates the current order and copies the values from
billAddressSkel to shippingAddressSkel if extrashippingaddress is
False.
:param step: Current step within the ordering process
:type step: int
:param orderKey: order to mark completed
:type orderKey: str
"""
billSkel = self.editSkel()
billSkel.fromDB( orderKey )
if not billSkel[ "extrashippingaddress" ].value:
for name, bone in billSkel.items():
if name.startswith( "bill_" ):
name = name.replace( "bill_", "shipping_" )
if name in billSkel:
billSkel[ name ].value = bone.value
billSkel.toDB()
raise SkipStepException()
def calculateOrderSum( self, step, orderKey, *args, **kwargs ):
"""
Calculates the final price for this order.
This function *must* be called before any attempt is made to start a payment process.
:param step: Current step within the ordering process
:type step: int
:param orderKey: order to calculate the price for
:type orderKey: str
"""
price = sum( [x[3] for x in self.getBillItems( orderKey ) ] )
orderObj = db.Get( db.Key( str( orderKey ) ) )
orderObj["price"] = price
db.Put( orderObj )
def startPayment( self, step, orderKey, *args, **kwargs ):
"""
Starts the payment processing for this order.
The order is marked completed, so no further changes can be made.
:param step: Current step within the ordering process
:type step: int
:param orderKey: order to mark completed
:type orderKey: str
"""
order = self.editSkel()
order.fromDB( orderKey )
if not str(order["state_complete"]) == "1":
session.current["order_"+order.kindName] = None
session.current.markChanged() #Fixme
self.setComplete( orderKey )
if order["payment_type"] in self.initializedPaymentProviders.keys():
pp = self.initializedPaymentProviders[order["payment_type"]]
pp.startProcessing( step, orderKey )
#getattr( self, "paymentProvider_%s" % order.payment_type.value )( step, orderKey )
def paymentProvider_pod( self, step, orderKey ):
"""
If Pay-On-Delivery is choosen, immediately mark this order as ready to ship
"""
self.setRTS( orderKey )
@internalExposed
def getBillItems(self, orderKey ):
"""
Returns all items for the given Order.
Must be overridden.
:param orderKey: order to obtain bill items from.
:type orderKey: str
:returns: A list of a tuple with the following order: ``( int Amount, Unicode Description , Float Price of one Item, Float Price of all Items (normaly Price of one Item*Amount), Float Included Tax )``
:rtype: list of tuple
"""
return []
def billSequenceAvailable( self, orderKey ):
self.sendOrderCompleteEMail( orderKey )
@callDeferred
def assignBillSequence( self, orderKey ):
"""
Assigns an unique order-order to the given order.
"""
def getKeyTxn( kindName, orderKey ):
"""Generates and returns a new, unique Key"""
seqObj = db.GetOrInsert(kindName, "viur_bill_sequences", count=1000)
idx = seqObj["count"]
seqObj["count"] += 1
db.Put( seqObj )
return str(idx)
def setKeyTxn( orderKey, idx ):
"""Assigns the new order to the given order"""
dbObj = db.Get( db.Key( orderKey ) )
if not dbObj:
return
dbObj[ "idx" ] = idx
db.Put( dbObj )
dbObj = db.Get(db.Key(orderKey))
if not dbObj:
return
idx = db.RunInTransaction(getKeyTxn, self.viewSkel().kindName, orderKey)
db.RunInTransaction(setKeyTxn, orderKey, idx)
self.billSequenceAvailable( orderKey )
def rebuildSearchIndex(self, step, orderKey, *args, **kwargs ):
"""
This rewrites the order after its completion.
As each step has its own (tiny) skeleton, the searchIndex saved is incomplete.
This loads the order using the (hopefully complete) viewSkel and saves it back,
so that it is ensuring a complete searchIndex.
Not a transaction, do not defer!
"""
skel = self.viewSkel()
if not skel.fromDB( orderKey ):
raise AssertionError()
skel.toDB()
def resetCart(self, step, orderKey, *args, **kwargs ):
"""
Clears the cart (if any) after the checkout
process is finished.
"""
session.current["cart_products"] = None
session.current.markChanged()
def getSkelByName(self, name, orderKey):
"""
Returns a skeleton for the given Name.
"""
if not name:
return self.viewSkel()
return self.viewSkel().subSkel(name)
def tmpSkipCheck(self, *args, **kwargs):
raise SkipStepException()
steps = [
{
"preHandler": tmpSkipCheck,
"mainHandler": {
"action": "function",
"function": tmpSkipCheck
}
},
{
"mainHandler": {
"action": "edit",
"skeleton": "billaddress",
"template": "order_billaddress",
"descr":u"Billinginformation"
}
},
{
"preHandler": checkSkipShippingAddress,
"mainHandler": {
"action": "edit",
"skeleton": "shippingaddress",
"template": "order_shipaddress",
"descr":u"Shippinginformation"
}
},
{
"mainHandler": {
"action": "edit",
"skeleton": "shiptype",
"template": "order_payment",
"descr":u"Payment"
},
"postHandler": calculateOrderSum
},
{
"mainHandler": {
"action": "view",
"skeleton": "",
"template": "order_verify",
"descr":u"Overview"
}
},
{
"preHandler": [rebuildSearchIndex,resetCart,startPayment],
"mainHandler": {
"action": "view",
"skeleton": "",
"template": "order_complete",
"descr":u"Order completed"
}
}
]
@internalExposed
def getSteps(self):
steps = []
for step in self.steps[:]:
step = step.copy()
step["mainHandler"] = step["mainHandler"].copy()
if "descr" in step["mainHandler"]:
step["mainHandler"].update({"descr": _(step["mainHandler"]["descr"])})
steps.append( step )
return steps
def getBillPdf(self, orderKey):
"""
Should be overridden to return the bill (as pdf) for the given order.
:type orderKey: str
:param orderKey: Order, for which the the bill should be generated.
:returns: Bytes of PDF or None.
:rtype: byte | None
"""
return None
def getDeliveryNotePdf(self, orderKey ):
"""
Should be overridden to return the delivery note (as pdf) for the given order.
:type orderKey: str
:param orderKey: Order, for which the the bill should be generated.
:returns: Bytes of PDF or None.
:rtype: byte | None
"""
return None
@exposed
def getBill(self, key, *args, **kwargs):
"""
Returns the Bill for the given order.
"""
skel = self.viewSkel()
if "canView" in dir( self ):
if not self.canView( key ):
raise errors.Unauthorized()
else:
queryObj = self.viewSkel().all().mergeExternalFilter( {"key": key} )
queryObj = self.listFilter( queryObj ) #Access control
if queryObj is None:
raise errors.Unauthorized()
bill = self.getBillPdf( key )
if not bill:
raise errors.NotFound()
request.current.get().response.headers['Content-Type'] = "application/pdf"
return( bill )
@exposed
def getDeliveryNote(self, key, *args, **kwargs):
"""
Returns the delivery note for the given order.
"""
skel = self.viewSkel()
if "canView" in dir( self ):
if not self.canView( key ):
raise errors.Unauthorized()
else:
queryObj = self.viewSkel().all().mergeExternalFilter( {"key": key} )
queryObj = self.listFilter( queryObj ) #Access control
if queryObj is None:
raise errors.Unauthorized()
bill = self.getDeliveryNotePdf( key )
if not bill:
raise errors.NotFound()
request.current.get().response.headers['Content-Type'] = "application/pdf"
return( bill )
@exposed
def checkout( self, step=None, key=None, skey=None, *args, **kwargs ):
"""
Performs the checkout process trough the state machine provided by self.steps.
:param step: The current step index, None for beginning a new checkout
:param key: Key of the current checkout
:param skey: Server security key
:return: Returns the rendered template or throws redirection exceptions.
"""
myKindName = self.viewSkel().kindName
if step is None:
logging.info("Starting new checkout process")
billObj = db.Entity( myKindName )
billObj["idx"] = "0000000"
for state in self.states:
billObj[ "state_%s" % state ] = "0"
db.Put( billObj )
key = str( billObj.key() )
#Copy the Cart
if "amountSkel" in dir ( self ):
cart = session.current.get("cart_products") or {}
s = self.amountSkel()
products = []
for prod, atts in cart.items():
for i in range( 0, atts[ "amount" ] ):
products.append( str(prod) )
s.fromClient( {"product": products} )
s.toDB()
session.current["order_"+myKindName] = {"key": str( key ), "completedSteps": [] }
session.current.markChanged()
raise errors.Redirect( "?step=0&key=%s" % str( key ) )
elif key:
try:
orderKey = db.Key( key )
step = int( step )
assert( step>=0 )
assert( step < len( self.steps ) )
except:
raise errors.NotAcceptable()
sessionInfo = session.current.get("order_"+myKindName)
if not sessionInfo or not sessionInfo.get("key") == str( orderKey ):
raise errors.Unauthorized()
if step in sessionInfo["completedSteps"]:
session.current["order_"+myKindName]["completedSteps"] = [ x for x in sessionInfo["completedSteps"] if x<step ]
session.current.markChanged()
#Make sure that no steps can be skipped
if step != 0 and not step-1 in sessionInfo["completedSteps"] :
raise errors.Redirect("?step=0&key=%s" % str( str(orderKey) ) )
currentStep = self.steps[ step ]
if "preHandler" in currentStep.keys():
try:
if isinstance( currentStep["preHandler"], list ):
for handler in currentStep["preHandler"]:
handler( self, step, str(orderKey), *args, **kwargs )
else:
currentStep["preHandler"]( self, step, str(orderKey),
refkwargs=kwargs, *args, **kwargs )
except SkipStepException:
session.current["order_"+myKindName]["completedSteps"].append( step )
session.current.markChanged()
raise errors.Redirect("?step=%s&key=%s" % ( str( step+1 ), str( orderKey ) ) )
except ReturnHtmlException as e:
return( e.html )
if "requiresSecurityKey" in currentStep and currentStep["requiresSecurityKey"] :
if not securitykey.validate( skey ):
raise errors.PreconditionFailed()
pass
if "mainHandler" in currentStep:
if currentStep["mainHandler"]["action"] == "edit":
skel = self.getSkelByName( currentStep["mainHandler"]["skeleton"], str(orderKey) )
skel.fromDB( str( orderKey ) )
if not len( kwargs.keys() ) or not skel.fromClient( kwargs ):
return( self.render.edit( skel, tpl=currentStep["mainHandler"]["template"], step=step ) )
skel.toDB()
if currentStep["mainHandler"]["action"] == "view":
if not "complete" in kwargs or not kwargs["complete"]==u"1":
skel = self.getSkelByName( currentStep["mainHandler"]["skeleton"], str(orderKey) )
skel.fromDB( str( orderKey ) )
return( self.render.view( skel, tpl=currentStep["mainHandler"]["template"], step=step ) )
elif currentStep["mainHandler"]["action"] == "function":
res = currentStep["mainHandler"]["function"]( self, step, str(orderKey), *args, **kwargs )
if res:
return res
if "postHandler" in currentStep:
currentStep["postHandler"]( self, step, str(orderKey), *args, **kwargs )
session.current["order_"+myKindName]["completedSteps"].append( step )
session.current.markChanged()
logging.info( "next ?step=%s&key=%s" % (str( step+1 ), str( orderKey ) ) )
raise errors.Redirect("?step=%s&key=%s" % (str( step+1 ), str( orderKey ) ) )
def archiveOrder(self, order):
self.setState( order.key.urlsafe(), "archived" )
self.sendOrderArchivedEMail( order.key.urlsafe() )
logging.error("Order archived: "+str( order.key.urlsafe() ) )
# @PeriodicTask(60*24)
def startArchiveOrdersTask( self, *args, **kwargs ):
self.doArchiveActiveOrdersTask( (datetime.now()-self.archiveDelay).strftime("%d.%m.%Y %H:%M:%S"), None )
self.doArchiveCancelledOrdersTask( (datetime.now()-self.archiveDelay).strftime("%d.%m.%Y %H:%M:%S"), None )
@callDeferred
def doArchiveActiveOrdersTask(self, timeStamp, cursor):
"""
Archive all payed,send and not canceled orders
"""
logging.debug("Archiving old orders")
query = self.viewSkel().all()\
.filter( "changedate <", datetime.strptime(timeStamp,"%d.%m.%Y %H:%M:%S") )\
.filter( "state_archived =", "0" )\
.filter( "state_send = ", "1" )\
.filter( "state_payed =", "1" )\
.filter( "state_canceled =", "0" ).cursor( cursor )
gotAtLeastOne = False
for order in query.fetch():
gotAtLeastOne = True
self.setArchived(order["key"])
newCursor = query.getCursor()
if gotAtLeastOne and newCursor and newCursor.urlsafe()!=cursor:
self.doArchiveActiveOrdersTask( timeStamp, newCursor.urlsafe() )
@callDeferred
def doArchiveCancelledOrdersTask(self, timeStamp, cursor):
"""
Archive all canceled orders
"""
query = self.viewSkel().all()\
.filter( "changedate <", datetime.strptime(timeStamp,"%d.%m.%Y %H:%M:%S") )\
.filter( "state_archived =", "0" )\
.filter( "state_canceled =", "1" ).cursor( cursor)
gotAtLeastOne = False
for order in query.fetch():
gotAtLeastOne = True
self.setArchived(order["key"])
newCursor = query.getCursor()
if gotAtLeastOne and newCursor and newCursor.urlsafe()!=cursor:
self.doArchiveCancelledOrdersTask( timeStamp, newCursor.urlsafe() )