This repository has been archived by the owner on May 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
XiboOfflineDownload.py
executable file
·1085 lines (893 loc) · 37.4 KB
/
XiboOfflineDownload.py
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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Xibo - Digitial Signage - http://www.xibo.org.uk
# Copyright (C) 2010-2013 Alex Harrington
#
# This file is part of Xibo.
#
# Xibo is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
#
# Xibo is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Xibo. If not, see <http://www.gnu.org/licenses/>.
# Static Variables
VERSION = '1.6.0'
APP_NAME = 'Xibo Offline Download Client'
# Imports
from XiboOfflineDownloadUI import XiboOfflineDownloadUI
from XiboOfflineDownloadUI import AddDisplayUI
import wx
import os
import ConfigParser
import uuid
from threading import Thread, Semaphore
import urlparse
import xml.parsers.expat
from xml.dom import minidom
from SOAPpy import WSDL
import SOAPpy.Types
import SOAPpy.Errors
import socket
import hashlib
import shutil
import Queue
class XiboOfflineDownload(XiboOfflineDownloadUI):
# Called after the GUI is initialised but before it's shown
def setup_tasks(self):
self.SetTitle(APP_NAME)
self.txtOutput.AppendText('%s v%s\n' % (APP_NAME,VERSION));
# Define Variables
self.AddDisplayDialog = None
self.downloadThread = None
# Queue for download requests
self.downloadQueue = Queue.Queue()
# Figure out where our config is saved
self.__config_path = os.path.expanduser('~')
self.__config_file = os.path.join(self.__config_path,'xibo-offline.cfg')
global log
log = self.writeLog
# Read config (if exists)
global config
config = ConfigParser.ConfigParser()
config.readfp(open('defaults.cfg'))
self.readConfig()
def updateDisplays(self):
# Add displays defined in the config file
displayNames = []
for section in config.sections():
if section != 'Main':
displayNames.append(section)
# End For Loop
# Sort the names alphabetically ignoring case
displayNames.sort(key=lambda x: x.lower())
# Clear the list
self.selectedDisplays.Set(displayNames)
def writeLog(self,message,appendLineBreak=True,important=False):
if config.getboolean('Main','verbose') or important:
wx.CallAfter(self.txtOutput.AppendText, message)
if appendLineBreak:
wx.CallAfter(self.txtOutput.AppendText, '\n')
def getConfigFile(self):
return self.__config_file
def saveConfig(self,outFile=None):
if outFile == None:
outFile = self.__config_file
try:
fh = open(outFile, 'w+')
config.write(fh)
fh.close()
except IOError:
log('Unable to write configuration file at %s. Check your filesystem permissions.' % outFile,True,True)
return False
return True
def readConfig(self,inFile=None):
global config
global log
# Work out the file to read
if inFile == None:
inFile = self.__config_file
try:
print _("Reading user configuration")
config.read([inFile])
# Setup the GUI with options from the config file
self.chkVerbose.SetValue(config.getboolean('Main','verbose'))
if config.get('Main','xmdsUrl') != '':
self.txtServerURL.Clear()
self.txtServerURL.WriteText(config.get('Main','xmdsUrl'))
if config.get('Main','xmdsKey') != '':
self.txtServerKey.Clear()
self.txtServerKey.WriteText(config.get('Main','xmdsKey'))
if config.get('Main','chunkSize') != '':
self.txtChunkSize.Clear()
self.txtChunkSize.WriteText(config.get('Main','chunkSize'))
except:
# Something went wrong reading config
# Load defaults again to be sure
print log('Invalid configuration file. Loading defaults.',True,True)
config = ConfigParser.ConfigParser()
config.readfp(open('defaults.cfg'))
# Add displays defined in the config file
self.updateDisplays()
def updateProgressBar(self,value):
wx.CallAfter(self.gaProgress.SetValue, value)
def finishedDownload(self):
log('Finished Download',True,True)
log('===============================',True,True)
self.btnCancel.Disable()
self.btnDownload.Enable()
self.updateProgressBar(0)
# Event Handlers
def onSelectAll(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Select all items in the display list
numItems = self.selectedDisplays.GetCount()
for i in range(0,numItems):
self.selectedDisplays.SetSelection(i)
if numItems > 0:
self.btnRemove.Enable()
self.btnDownload.Enable()
event.Skip()
def onSelectNone(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Clear all selections in the display list
numItems = self.selectedDisplays.GetCount()
for i in range(0,numItems):
self.selectedDisplays.Deselect(i)
self.btnRemove.Disable()
self.btnDownload.Disable()
event.Skip()
def onSelectInvert(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Invert the selections in the display list.
selected = self.selectedDisplays.GetSelections()
numItems = self.selectedDisplays.GetCount()
for i in range(0,numItems):
if i in selected:
self.selectedDisplays.Deselect(i)
else:
self.selectedDisplays.SetSelection(i)
if len(self.selectedDisplays.GetSelections()) > 0:
self.btnRemove.Enable()
self.btnDownload.Enable()
else:
self.btnRemove.Disable()
self.btnDownload.Disable()
event.Skip()
def onAddDisplay(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
if self.AddDisplayDialog == None:
self.AddDisplayDialog = AddDisplay(self,-1)
self.AddDisplayDialog.Show()
self.AddDisplayDialog.setParent(self)
event.Skip()
def onDeleteDisplay(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Are you sure
dlg = wx.MessageDialog(self, _("Are you sure you want to delete the selected displays?"),_("Delete Displays?"),style=wx.YES_NO|wx.NO_DEFAULT|wx.ICON_QUESTION|wx.STAY_ON_TOP)
if dlg.ShowModal() == wx.ID_YES:
# Get a list of selected Displays
selections = self.selectedDisplays.GetSelections()
for i in selections:
display = self.selectedDisplays.GetString(i)
config.remove_section(display)
log(_('Removed display %s') % display,True,True)
self.saveConfig()
self.updateDisplays()
dlg.Destroy()
event.Skip()
def onDownload(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Disable Download Button
self.btnDownload.Disable()
self.updateProgressBar(0)
# Enable Cancel Button
self.btnCancel.Enable()
try:
outdir = config.get('Main','outDir')
except ConfigParser.NoOptionError:
outdir=''
log('Saved Output Directory: %s' % outdir)
# Display a dialog asking for a folder to write to
dlg = wx.DirDialog(self,_("Select output USB drive root folder"),outdir)
if dlg.ShowModal() == wx.ID_OK:
outdir = dlg.GetPath()
config.set('Main','outDir',outdir)
self.saveConfig()
log('Selected Output Directory: %s' % outdir)
dlg.Destroy()
# Get the displays selected:
displays = []
selections = self.selectedDisplays.GetSelections()
for i in selections:
displays.append(self.selectedDisplays.GetString(i))
# Make the single instance library store if it doesn't exist
try:
os.mkdir(os.path.join(outdir,'library'))
except IOError:
log(_('Unable to create output directory. Check filesystem permissions.'),True,True)
return
except OSError:
# Directory already exists. Do nothing.
pass
# Displays now contains a list of display names to download content for
# Create output folders for each display key:
for display in displays:
try:
key = config.get(display,'license')
except ConfigParser.NoOptionError:
log(_('No license key for display %s. Please check configuration.') % display,True,True)
# Remove the display from the list
del displays[displays.index(display)]
continue
# Delete the client folders. This converts from older style per display update format to
# new format automatically, and clears out any trash that might be in there too!
try:
shutil.rmtree(os.path.join(outdir,key))
except OSError:
if os.path.isdir(os.path.join(outdir,key)):
log(_('Unable to remove old output directory. Check filesystem permissions.'),True,True)
continue
else:
# Do nothing - we're golden.
pass
try:
os.mkdir(os.path.join(outdir,key))
except IOError:
log(_('Unable to create output directory. Check filesystem permissions.'),True,True)
continue
except OSError:
# Directory already exists. Do nothing
pass
displayDict = {'name': display, 'key': key, 'outdir': os.path.join(outdir,key), 'libdir': os.path.join(outdir,'library')}
self.downloadQueue.put(displayDict)
# Finish while loop for displays
self.updateProgressBar(2)
# Push the queue in to a download thread and start it running
self.downloadThread = XMDSDownloadThread(self,self.downloadQueue)
self.downloadThread.start()
event.Skip()
def onCancel(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
if self.downloadThread != None:
# Ask running thread to stop
self.downloadThread.requestStop()
self.btnCancel.Disable()
log(_('Cancelling...'),True,True)
event.Skip()
def onConfigSave(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
config.set('Main','xmdsUrl',self.txtServerURL.GetValue())
config.set('Main','xmdsKey',self.txtServerKey.GetValue())
try:
tmpInt = int(self.txtChunkSize.GetValue())
except ValueError:
log('Error: Chunk size must be a whole positive number greater than 0',True,True)
event.Skip()
return
if int(self.txtChunkSize.GetValue()) < 1:
log('Error: Chunk size must be a whole positive number greater than 0',True,True)
event.Skip()
return
config.set('Main','chunkSize', self.txtChunkSize.GetValue())
if self.chkVerbose.IsChecked():
config.set('Main','verbose','true')
else:
config.set('Main','verbose','false')
if not self.saveConfig():
event.Skip()
return
log('Configuration saved',True,True)
self.btnSave.Disable()
event.Skip()
def onConfigExport(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Create a save file dialog
dialog = wx.FileDialog( None, style = wx.SAVE | wx.OVERWRITE_PROMPT )
# Show the dialog and get user input
if dialog.ShowModal() == wx.ID_OK:
outFile = dialog.GetPath()
# Save the config to file
self.saveConfig(outFile)
# Destroy the dialog
dialog.Destroy()
event.Skip()
def onConfigImport(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# Create a file select dialog
dialog = wx.FileDialog(None, style=wx.OPEN)
if dialog.ShowModal() == wx.ID_OK:
inFile = dialog.GetPath()
# Pass the config file in
self.readConfig(inFile)
# Save the new config
self.saveConfig()
event.Skip()
def onDisplayListDClick(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
# print "Event handler `onDisplayListDClick' not implemented"
event.Skip()
def onDisplayListClick(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
if len(self.selectedDisplays.GetSelections()) > 0:
self.btnRemove.Enable()
self.btnDownload.Enable()
else:
self.btnRemove.Disable()
self.btnDownload.Disable()
event.Skip()
def onServerUrlChange(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
self.btnSave.Enable()
event.Skip()
def onServerKeyChange(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
self.btnSave.Enable()
event.Skip()
def onVerboseChange(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
self.btnSave.Enable()
event.Skip()
def onChunkSizeChange(self, event): # wxGlade: XiboOfflineDownloadUI.<event_handler>
self.btnSave.Enable()
event.Skip()
class AddDisplay(AddDisplayUI):
def onCreateDisplay(self, event): # wxGlade: AddDisplayUI.<event_handler>
# Save the new display to config
try:
config.add_section(self.txtClientName.GetValue())
except ConfigParser.DuplicateSectionError:
log('A display with that name already exists.',True,True)
event.Skip()
return
except ValueError:
log('You may not name a display "DEFAULT". Please choose another name.',True,True)
event.Skip()
return
try:
config.set(self.txtClientName.GetValue(),'license',self.txtClientKey.GetValue())
except ConfigParser.NoSectionError:
log('Something went wrong adding the display to your configuration file.',True,True)
event.Skip()
return
if not self.__parent.saveConfig():
event.Skip()
return
# Actually Add the Display
xmds = XMDS(self.txtClientKey.GetValue(),self.txtClientName.GetValue(),config.get('Main','xmdsKey'))
try:
xmds.RegisterDisplay()
except XMDSException:
log('Webservice Exception',True,True)
event.Skip()
return
# If all went well, reninitialize the form and close it
self.txtClientKey.Clear()
self.txtClientName.Clear()
self.btnCreateDisplay.Disable()
self.txtClientKey.WriteText(hashlib.sha1(uuid.uuid4().hex).hexdigest())
self.__parent.updateDisplays()
self.Close()
event.Skip()
def onGenerateKey(self, event): # wxGlade: AddDisplayUI.<event_handler>
self.txtClientKey.Clear()
self.txtClientKey.WriteText(hashlib.sha1(uuid.uuid4().hex).hexdigest())
event.Skip()
def onCancel(self, event): # wxGlade: AddDisplayUI.<event_handler>
self.txtClientKey.Clear()
self.txtClientName.Clear()
self.btnCreateDisplay.Disable()
self.Close()
event.Skip()
def onClientNameChange(self, event): # wxGlade: AddDisplayUI.<event_handler>
if self.validateFields():
self.btnCreateDisplay.Enable()
else:
self.btnCreateDisplay.Disable()
event.Skip()
def onClientKeyChange(self, event): # wxGlade: AddDisplayUI.<event_handler>
if self.validateFields():
self.btnCreateDisplay.Enable()
else:
self.btnCreateDisplay.Disable()
event.Skip()
def validateFields(self):
ret = True
if len(self.txtClientKey.GetValue()) < 1:
ret = False
if len(self.txtClientName.GetValue()) < 1:
ret = False
return ret
def setParent(self,parent):
self.__parent = parent
class XMDSDownloadThread(Thread):
def __init__(self,parent,downloadQueue):
Thread.__init__(self)
self.__parent = parent
self.__q = downloadQueue
self.xmds = None
self.__serverKey = config.get('Main','xmdsKey')
# Flag that exits the downloader if requested.
self.__running = False
def run(self):
self.__running = True
log('Starting Download Thread')
try:
while self.__running:
# While loop will be broken by Queue empty exception if we're not cancelled
display = self.__q.get(False)
key = display['key']
name = display['name']
outdir = display['outdir']
libdir = display['libdir']
self.xmds = XMDS(key,name,self.__serverKey)
log('Processing Display %s' % name, True, True)
self.downloadSchedule(key,outdir)
rf = self.downloadRequiredFiles(key,outdir)
self.__parent.updateProgressBar(5)
# Work out total size for this display
tSize = 0.00000001
for tmpFile in rf:
tSize = tSize + tmpFile['size']
self.__tIncrement = 95.0 / tSize
self.__tProgBar = 5
for tmpFile in rf:
if self.__running:
fileid = tmpFile['fileid']
size = tmpFile['size']
checksum = tmpFile['checksum']
filetype = tmpFile['filetype']
log('Processing file %s for display %s' % (fileid,name))
if filetype == 'media':
self.downloadMedia(tmpFile,libdir)
else:
self.downloadLayout(tmpFile,libdir)
except Queue.Empty:
# Queue is empty.
log('Download Queue is empty')
self.__running = False
self.__parent.finishedDownload()
def downloadSchedule(self,key,outdir):
log('Download Schedule [IN]')
schedule = '<schedule/>'
try:
schedule = self.xmds.Schedule()
f = open(os.path.join(outdir,'schedule.xml'),'w')
f.write(schedule)
f.close()
except IOError:
log('Error writing schedule to disk',True,True)
except XMDSException:
log('Error communicating with the server',True,True)
return
def downloadRequiredFiles(self,key,outdir):
# Download RF, save to disk and return a list of dicts of files
# rf = [{'fileid':1, 'size':49320, 'checksum':'<checksum!>', 'filetype':'media'}]
rfRet = []
log('Download Required Files [IN]')
reqFiles = '<files></files>'
try:
reqFiles = self.xmds.RequiredFiles()
# print reqFiles
f = open(os.path.join(outdir,'rf.xml'),'w')
f.write(reqFiles)
f.close()
except IOError:
log('Error writing required files to disk',True,True)
return []
except XMDSException:
log('Error communicating with the server',True,True)
return []
doc = None
# Pull apart the retuned XML
try:
doc = minidom.parseString(reqFiles)
except:
log(_("XMDS RequiredFiles returned invalid XML"),True,True)
return []
fileNodes = doc.getElementsByTagName('file')
for f in fileNodes:
try:
tmpFileName = str(f.attributes['path'].value)
tmpSize = int(f.attributes['size'].value)
tmpHash = str(f.attributes['md5'].value)
tmpType = str(f.attributes['type'].value)
rfRet.append({ 'fileid': tmpFileName,
'size': tmpSize,
'checksum': tmpHash,
'filetype': tmpType })
except KeyError:
# Pass over blacklist nodes
pass
return rfRet
def downloadMedia(self,tmpFile,outdir):
log('downloadMedia [IN]')
fileid = tmpFile['fileid']
size = tmpFile['size']
checksum = tmpFile['checksum']
filetype = tmpFile['filetype']
tmpPath = os.path.join(outdir,fileid)
# Check if the file already exists
download = False
if not os.path.isfile(tmpPath):
# File doesn't exist at all
log(_("Marking file %s for download as it doesn't exist.") % fileid)
download = True
elif not os.path.getsize(tmpPath) == size:
# File is incorrect size
log(_("Marking file %s for download as it's not the right size.") % fileid)
download = True
elif not self.md5sum(tmpPath) == checksum:
log(_("Marking file %s for download as it's checksum doesn't match.") % fileid)
# File checksum is wrong
download = True
if download:
# Do the download as it's needed
# Delete the file if it exists already
if os.path.isfile(tmpPath):
try:
os.remove(tmpPath)
except:
log(_("Unable to delete file: ") + tmpPath, True, True)
return
fh = None
try:
fh = open(tmpPath, 'wb')
except:
log(_("Unable to write file: ") + tmpPath, True, True)
return
tries = 0
offset = 0
chunk = config.getint('Main','chunkSize')
finished = False
while self.__running and tries < 5 and not finished:
tries = tries + 1
failCounter = 0
while self.__running and offset < size and failCounter < 3:
# If downloading this chunk will complete the file
# work out exactly how much to download this time
if offset + chunk > size:
chunk = size - offset
try:
response = self.xmds.GetFile(fileid,filetype,offset,chunk)
fh.write(response)
fh.flush()
self.__tProgBar = int(self.__tIncrement * chunk) + self.__tProgBar
self.__parent.updateProgressBar(self.__tProgBar)
offset = offset + chunk
failCounter = 0
except RuntimeError:
# TODO: Do something sensible
pass
except XMDSException:
# TODO: Do something sensible
failCounter = failCounter + 1
except ValueError:
finished = True
break
# End while offset<tmpSize
try:
fh.close()
except:
# TODO: Do something sensible
pass
# TODO: Check size/md5 here?
# End while
return
def downloadLayout(self,tmpFile,outdir):
log('downloadLayout [IN]')
fileid = tmpFile['fileid']
filename = tmpFile['fileid'] + '.xlf'
size = tmpFile['size']
checksum = tmpFile['checksum']
filetype = tmpFile['filetype']
tmpPath = os.path.join(outdir,filename)
# Check if the file already exists
download = False
if not os.path.isfile(tmpPath):
# File doesn't exist at all
log(_("Marking file %s.xlf for download as it doesn't exist.") % fileid)
download = True
elif not os.path.getsize(tmpPath) == size:
# File is incorrect size
log(_("Marking file %s.xlf for download as it's not the correct size.") % fileid)
download = True
elif not self.md5sum(tmpPath) == checksum:
# File checksum is wrong
log(_("Marking file %s.xlf for download as it's checksum doesn't match.") % fileid)
download = True
if download:
# Do the download as it's needed
# Delete the file if it exists already
if os.path.isfile(tmpPath):
try:
os.remove(tmpPath)
except:
log(_("Unable to delete file: ") + tmpPath, True, True)
return
fh = None
try:
fh = open(tmpPath, 'wb')
except:
log(_("Unable to write file: ") + tmpPath, True, True)
return
tries = 0
offset = 0
chunk = 0
finished = False
while self.__running and tries < 5 and not finished:
tries = tries + 1
failCounter = 0
# If downloading this chunk will complete the file
# work out exactly how much to download this time
if offset + chunk > size:
chunk = size - offset
try:
response = self.xmds.GetFile(filename,filetype,offset,chunk)
fh.write(response)
fh.flush()
self.__tProgBar = int(self.__tIncrement * len(response)) + self.__tProgBar
self.__parent.updateProgressBar(self.__tProgBar)
offset = offset + chunk
failCounter = 0
except RuntimeError:
# TODO: Do something sensible
pass
except XMDSException:
# TODO: Do something sensible
failCounter = failCounter + 1
except ValueError:
finished = True
break
try:
fh.close()
except:
# TODO: Do something sensible
pass
# TODO: Check size/md5 here?
# End while
return
def requestStop(self):
# Signal that we should abort
self.__running = False
def md5sum(self,tmpPath):
log(_("Calculating checksum for file %s") % tmpPath)
m = hashlib.md5()
try:
for line in open(tmpPath,"rb"):
m.update(line)
except IOError:
return "0"
log(_("Checksum: %s") % m.hexdigest())
return m.hexdigest()
#### Webservice
class XMDSException(Exception):
def __init__(self, value):
self.value = value
def __str__(self):
return repr(self.value)
class XMDS:
def __init__(self,licenseKey,clientName,serverKey):
self.__schemaVersion__ = "3";
# Semaphore to allow only one XMDS call to run check simultaneously
self.checkLock = Semaphore()
self.hasInitialised = False
self.uuid = licenseKey
self.name = clientName
self.key = serverKey
self.socketTimeout = None
try:
self.socketTimeout = int(config.get('Main','socketTimeout'))
except:
self.socketTimeout = 30
try:
socket.setdefaulttimeout(self.socketTimeout)
log(_("Set socket timeout to: ") + str(self.socketTimeout))
except:
log(_("Unable to set socket timeout. Using system default"))
pass
# Setup a Proxy for XMDS
self.xmdsUrl = None
try:
self.xmdsUrl = config.get('Main','xmdsUrl')
if self.xmdsUrl[-1] != "/":
self.xmdsUrl = self.xmdsUrl + "/"
self.xmdsUrl = self.xmdsUrl + "xmds.php"
except ConfigParser.NoOptionError:
log(_("No XMDS URL specified in your configuration"),True,True)
log(_("Please check your xmdsUrl configuration option"),True,True)
except IndexError:
log(_("Invalid XMDS URL. Check configuration."),True,True)
# Work out the URL for XMDS and add HTTP URL quoting (ie %xx)
self.wsdlFile = self.xmdsUrl + '?wsdl'
# Work out the host that XMDS is on so we can get an IP address for ourselves
tmpParse = urlparse.urlparse(self.xmdsUrl)
self.xmdsHost = tmpParse.hostname
del tmpParse
def getUUID(self):
return str(self.uuid)
def getName(self):
return str(self.name)
def getKey(self):
return str(self.key)
def check(self):
if self.hasInitialised:
return True
else:
self.checkLock.acquire()
# Check again as we may have been called and blocked by another thread
# doing this work for us.
if self.hasInitialised:
self.checkLock.release()
return True
self.server = None
tries = 0
while self.server == None and tries < 3:
tries = tries + 1
# log.log(2,"info",_("Connecting to XMDS at ") + self.xmdsUrl + " " + _("Attempt") + " " + str(tries))
try:
self.server = WSDL.Proxy(self.wsdlFile)
self.hasInitialised = True
# log.log(2,"info",_("Connected to XMDS via WSDL at %s") % self.wsdlFile)
except xml.parsers.expat.ExpatError:
# log.log(0,"error",_("Could not connect to XMDS."))
pass
# End While
if self.server == None:
self.checkLock.release()
return False
self.checkLock.release()
return True
def RequiredFiles(self):
"""Connect to XMDS and get a list of required files"""
# log.lights('RF','amber')
req = None
if self.check():
# try:
# Update the IP Address shown on the infoScreen
# log.updateIP(self.getIP())
# except:
# pass
# log.updateFreeSpace(self.getDisk())
try:
req = self.server.RequiredFiles(self.getKey(),self.getUUID(),self.__schemaVersion__)
except SOAPpy.Types.faultType, err:
# log.lights('RF','red')
raise XMDSException("RequiredFiles: Incorrect arguments passed to XMDS.")
except SOAPpy.Errors.HTTPError, err:
# log.lights('RF','red')
# log.log(0,"error",str(err))
raise XMDSException("RequiredFiles: HTTP error connecting to XMDS.")
except socket.error, err:
# log.lights('RF','red')
# log.log(0,"error",str(err))
raise XMDSException("RequiredFiles: socket error connecting to XMDS.")
except AttributeError, err:
# log.lights('RF','red')
# log.log(0,"error",str(err))
self.hasInitialised = False
raise XMDSException("RequiredFiles: webservice not initialised")
except KeyError, err:
# log.lights('RF', 'red')
# log.log(0,"error",str(err))
self.hasInitialised = False
raise XMDSException("RequiredFiles: Webservice returned non XML content")
else:
# log.log(0,"error","XMDS could not be initialised")
# log.lights('RF','grey')
raise XMDSException("XMDS could not be initialised")
# log.lights('RF','green')
return req
def Schedule(self):
"""Connect to XMDS and get the current schedule"""
# log.lights('S','amber')
req = None
if self.check():
try:
try:
req = self.server.Schedule(self.getKey(),self.getUUID(),self.__schemaVersion__)
except SOAPpy.Types.faultType, err:
# log.log(0,"error",str(err))
# log.lights('S','red')
raise XMDSException("Schedule: Incorrect arguments passed to XMDS.")
except SOAPpy.Errors.HTTPError, err:
# log.log(0,"error",str(err))
# log.lights('S','red')
raise XMDSException("Schedule: HTTP error connecting to XMDS.")
except socket.error, err:
# log.log(0,"error",str(err))
# log.lights('S','red')
raise XMDSException("Schedule: socket error connecting to XMDS.")
except AttributeError, err:
# log.lights('S','red')
# log.log(0,"error",str(err))
self.hasInitialised = False
raise XMDSException("Schedule: webservice not initialised")
except KeyError, err:
# log.lights('S', 'red')
# log.log(0,"error",str(err))
self.hasInitialised = False
raise XMDSException("Schedule: Webservice returned non XML content")
except AttributeError, err:
# For some reason the except SOAPpy.Types line above occasionally throws an
# exception when the client first starts saying SOAPpy doesn't have a Types attribute
# Catch that here I guess!
# log.lights('S','red')
# log.log(0,"error",str(err))
self.hasInitiated = False
raise XMDSException("RequiredFiles: webservice not initalised")
else:
# log.log(0,"error","XMDS could not be initialised")
# log.lights('S','grey')
raise XMDSException("XMDS could not be initialised")