forked from larryhudson/lectureDL
-
Notifications
You must be signed in to change notification settings - Fork 2
/
lectureDL.py
executable file
·956 lines (831 loc) · 37.8 KB
/
lectureDL.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
#!/usr/bin/env python3
# lectureDL.py by Larry Hudson
# Python script to download all lecture files, either video or audio
# What it does:
# Logs in to Unimelb LMS system
# Builds list of subjects
# For each subject, navigate through to echo system
# Builds list of lectures
# For each lecture, builds filename based on subject number and date and downloads
# Features:
# Assigns week numbers based on date - formatted eg. "LING30001 Week 1 Lecture 2.m4a"
# Support for subjects with single or multiple lectures per week
# Skips if file already exists
# Can download either video files or audio files
# Allows user to choose specific subjects and to only download lectures newer than a specific date
# To do list:
# Allow user to choose download folder
# Replace list system (eg. to_download) with class and attributes?
# Change Week numbering from Week 1 to Week 01 (yeah yeah) - best boy Astrid xox
# READ ME (Update as of 2017-07-29):
# If you're modifying this in the future, know first off that the code was
# not designed with easy future use, nor abstraction in general, in mind.
# I've made it a bit better but it's still messy. Assuming you've got the
# required directory structure in place (check out the uni_folder variable),
# you'll have to:
# 1. Change the current year and semester if necessary.
# 2. Change the variables representing the start of the semester (such as
# start_week0 and current_date) for this semester.
# 3. Manually download the latest ChromeDriver and change the driver variable
# accordingly.
# 4. Perhaps change settings.py.
# While it might be worth it, I feel like it'd be a fair bit of work to
# refactor this project to be "Good TM", after which you could start adding
# extra features. Like imagine trying to catch a selenium error and closing
# chrome if one is encountered, it'd be like a million try/excepts.
# So yeah, maybe one day. Still it wasn't too hard to get it working again.
# UPDATE (As of 2017-10-07) - David Stern
# Updates:
# (1) Lecture Class Created & Implemented
# (2) Scrolling Bug Fixed (Long lists of lectures weren't clickable)
# (3) Fixed some constants
# (4) Simplified getSubjectList()
# (5) Require user to re-input choice of subjects, if invalid.
# As a part of this, broke determine_subjects_to_download() down to
# include:
# - getValidUserChoice() Requests input until valid selection obtained
# - getSubjects() Takes the list of subjects, returns only those
# selected by the user.
# (6) Switched to f-strings to improve clarity.
# (7) Created and implemented Subject() Class.
# (8) Other unlisted changes.
#
# TODO:
# Implement Graphical Folder Selection
# Implement full GUI
# Fix Dates (Think of a better way to select dates)
# Save file sizes in a .pickle file
# Shorten Scrolling Function (Line 561 in download_lectures_for_subject())
from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from selenium.webdriver.common.keys import Keys
from selenium.common.exceptions import (
NoSuchElementException,
ElementNotVisibleException,
StaleElementReferenceException,
WebDriverException,
)
import datetime
import functools
import getpass
import os
import os.path
import random
import re
import sys
import time
import urllib
from collections import defaultdict
from contextlib import suppress
from queue import Queue
from threading import Thread
from util import (
retry_until_result,
show_progress,
StdoutSpace,
)
# To revert to regular stdout, just comment out this line.
# The file=sys.__stdout__ part in util.show_progress could then also be removed.
sys.stdout = StdoutSpace(sys.stdout)
# Try to read in a settings file.
try:
from settings import (
settings,
getLectureName,
)
except ImportError as e:
print(f'Couldn\'t import a settings file: {str(e)}')
settings = defaultdict(lambda: None, {
# These are the defaults for when settings isn't defined.
'uni_location': os.path.join(os.path.expanduser('~'), 'Downloads'),
'lecture_subfolder_name': 'Lectures',
'auto_create_subfolders': True,
'default_auto_create_format': '{code} - {name}',
'driver_relative_path': 'chromedriver',
})
getLectureName = lambda lec: f'{lec.subjCode} Week {lec.week:02} Lecture {lec.lecOfWeek}'
print('Will download to ' + str(settings['uni_location']))
print('Will automatically create the subject folders.')
print('Default folder and lecture names will be used.')
# These are partial matches, so the best matches should appear first:
LECTURE_TAB_STRINGS = ["Lecture Recordings", "Lecture Capture", "Lectures",
"lectures", "Lecture capture", "Recordings",
"recordings", "Capture", "capture"]
# These must be exact matches:
INTERMEDIATE_LECTURE_CAPTURE_NAMES = [
'Lecture Capture', 'Lecture-Capture', 'Lecture Recordings',
]
LECTURE_FOLDER_NAME = settings['lecture_subfolder_name']
SUBJ_NAMES = settings['subject_names']
FOLDER_ERROR = (" doesn\'t exist.\nWould you like to use the Downloads" +
" folder instead? ")
FOLDER_NAME_ERROR = ("No folder with the code subject_code in its name was",
"found (e.g. 'My COMP10001 folder').\n",
"Either create such a folder manually, or retry with",
"'auto_create_subfolders' setting set to True in the",
"settings file.")
GET_ECHO = 'Getting past intermediate page / waiting for Echocenter to load...'
NO_DL_FOLDER = 'The downloads folder doesn\'t exist either, shutting down.'
class Subject(object):
def __init__(self, code, name, link, num, path=None, downloaded=0):
self.code = code
self.name = name
self.link = link
self.num = num
self.path = path
self.downloaded = downloaded
def __str__(self):
return f"{self.code} - {self.name}"
class Lecture(object):
def __init__(self, link, subjCode, week, lecOfWeek, date, subjName,
recNum, folder, fName=None, fPath=None, dl_status=None):
self.link = link
self.subjCode = subjCode
self.week = week
self.lecOfWeek = lecOfWeek
self.date = date
self.subjName = subjName
self.recNum = recNum
self.folder = folder
self.fName = fName
self.fPath = fPath
self.dl_status = dl_status
def __str__(self):
strFormat = f"{self.subjCode} {self.subjName} - Week {self.week}"
return strFormat + f" Lecture {self.lecOfWeek}"
def check_uni_folder(uni_folder, home_dir):
'''
@param: uni_folder - pathname generated using os.path
'''
if not os.path.exists(uni_folder):
conf = input(f"{uni_folder}{FOLDER_ERROR}")[0].lower()
if conf != 'y':
print('Ok, shutting down.')
sys.exit(1)
uni_folder = os.path.join(home_dir, "Downloads")
if not os.path.exists(uni_folder):
print(NO_DL_FOLDER, file=sys.stderr)
sys.exit(1)
return uni_folder
def getSubjectFolder(subject_code, uni_folder):
''' Enables any subject_code in which the subject code is included to be
identified as the appropriate folder for the subject.
'''
print(f"Retrieving folder with name that includes: {subject_code}")
# Using the subject code to find the appropriate folder.
for fold in os.listdir(uni_folder):
if subject_code.lower() in fold.lower():
subjectFolder = fold
break
try:
return subjectFolder
# If a folder with the subject code in the name wasn't found
except NameError as e:
# If the user wants to automatically create the folders, do so.
if settings['auto_create_subfolders']:
subjectFolder = settings['default_auto_create_format'].format(
code=subject.code, name=subject.name)
os.mkdir(os.path.join(uni_folder, subjectFolder))
print('Made folder: ' + subjectFolder)
# Print an error.
else:
print(FOLDER_NAME_ERROR, file=sys.stderr)
sys.exit(1)
# define function to find a link and return the one it finds
# works by making a list of the elements and sorts by descending list length,
# so it returns the one with length 1, avoiding the empty lists.
# if it can't find anything, it will return none
def search_link_text(browser, query_terms):
link_elements = []
for term in query_terms:
link_elements.append(browser.find_elements_by_partial_link_text(term))
sorted_links = sorted(link_elements, key=len, reverse=True)
sorted_links_flat = []
for i in sorted_links:
for j in i:
sorted_links_flat.append(j)
return sorted_links_flat[0]
# Determine download mode.
def get_download_mode():
valid_options = {'a': 'audio', 'v': 'video'}
# Using the media_type specified in settings it was set.
if settings['media_type']:
return settings['media_type']
valid = False
while not valid:
valid = True
print("Enter 'v' to download videos or 'a' to download audio.")
user_choice = input("> ")[0].lower()
if user_choice in valid_options:
return valid_options[user_choice]
else:
print('That wasn\'t an option.')
valid = False
# MUCH simpler selection of weeks.
# def select_lectures()
# if user enters comma-separated weeks, make a list for each and then
# concatenate
def get_weeks_to_download(current_year, week_day):
# TODO break up this god awful huge function.
# build week number dictionary
current_date = datetime.datetime(current_year, 7, 24)
today = datetime.datetime.today()
today_midnight = datetime.datetime(today.year, today.month, today.day)
# This is O-Week, so the start of week 1 should be 7 days after this.
start_week0 = datetime.datetime(current_year, 7, 17)
end_week0 = datetime.datetime(current_year, 7, 23)
day_delta = datetime.timedelta(days=1)
week_delta = datetime.timedelta(days=7)
weeks_in_semester = 12
week_counter = 1
day_counter = 1
midsemBreakWeek = 9 # Mid sem break occurs after this week.
# assigns a week number to each date.
while week_counter <= weeks_in_semester:
while day_counter <= 7:
week_day[current_date] = week_counter
day_counter += 1
current_date = current_date + day_delta
week_counter += 1
# If we enter the week of the midsem break, skip a week.
if week_counter == midsemBreakWeek + 1:
current_date = current_date + week_delta
day_counter = 1
current_week_no_offset = (datetime.datetime.today() - start_week0).days // 7
midsem_offset = (current_week_no_offset+1) // midsemBreakWeek
current_week = current_week_no_offset - midsem_offset
if current_week > weeks_in_semester:
current_week = weeks_in_semester
# The user input stage.
user_dates_input = "default"
print("Would you like to download lectures from specific weeks or since a particular date?")
while user_dates_input == "default":
# Automatically set the week range if specified in the settings.
if settings['update_lower_week']:
settings['date_range'] = f"{current_week}-{weeks_in_semester}"
# Read in the date range if none was given in the settings.
if settings['date_range'] is None:
print("Enter a range of weeks (eg. 1-5 or 1,3,4) or a date (DD/MM/2016) to download videos that have since been released.")
user_dates_input = input("> ")
else:
if len(settings['date_range']) > 0:
print("Using", settings['date_range'])
else:
print("Downloading lectures from every week.")
settings['date_range'] = '1-{weeks_in_semester}' # TODO This is a hack.
user_dates_input = settings['date_range']
dates_list = []
# if user enters comma-separated weeks, or just one, make a list for each and then concatenate
if "," in user_dates_input or user_dates_input.isdigit():
# TODO I think this might be a bit broken with the midsem thing.
# This whole part needs to be reworked anyway.
print("Lectures will be downloaded for: ")
chosen_weeks = user_dates_input.replace(" ", "").split(",")
for item in chosen_weeks:
start_date = start_week0 + (int(item) * week_delta)
end_date = end_week0 + (int(item) * week_delta)
dates_in_week = [start_date + datetime.timedelta(n) for n in range(int((end_date - start_date).days))]
dates_list += dates_in_week
print("Week ", item)
dates_list.append(today_midnight)
# create a table of dates between start date and end date
elif "-" in user_dates_input or "/" in user_dates_input:
if "-" in user_dates_input:
# splits the start and the end weeks
chosen_weeks = user_dates_input.split("-")
start_week = int(chosen_weeks[0])
if start_week > midsemBreakWeek:
start_week += 1
start_date = start_week0 + (start_week * week_delta)
end_week = int(chosen_weeks[1])
if end_week > midsemBreakWeek:
end_week += 1
end_date = end_week0 + (end_week * week_delta)
# create a range between start_date and today
elif "/" in user_dates_input:
start_date = datetime.datetime.strptime(user_dates_input, "%d/%m/%Y")
end_date = datetime.datetime.today()
# ???
dates_list = [start_date + datetime.timedelta(n) for n in range((end_date - start_date).days)]
dates_list.append(today_midnight)
print("Lectures will be downloaded for the dates between " + datetime.datetime.strftime(start_date, "%d %B")
+ " and " + datetime.datetime.strftime(end_date, "%d %B") + ", inclusive.")
# Go back to top of while loop.
else:
print("That wasn't a valid option")
user_dates_input = "default"
return dates_list
def sign_in(driver):
user_field = driver.find_element_by_css_selector("input[name=user_id]")
if settings['username'] is None:
settings['username'] = input("Enter your username: ")
user_field.send_keys(settings['username'])
pass_field = driver.find_element_by_css_selector("input[name=password]")
if settings['password'] is None:
settings['password'] = getpass.getpass("Enter your password: ")
pass_field.send_keys(settings['password'])
print()
pass_field.send_keys(Keys.RETURN)
# TODO think of a better way to select the lecture stuff and not the community stuff on the right.
@retry_until_result('Waiting for course list to load...')
def get_course_links(driver):
# NOTE: Because of the decorator, use this function as if it were a regular
# function that returns, not yields.
course_links = None
try:
# list items in list class "courseListing"
course_list_candidates = driver.find_elements_by_css_selector("ul.courseListing")
course_list = None
# Sometimes there is an invisible dummy subject list that of course
# lists no subjects. If the style property 'display' is 'none', we
# know it is the invisble one and we ignore it.
for c in course_list_candidates:
if c.value_of_css_property('display') == 'none':
continue
course_list = c
if course_list is None:
yield None
continue
# only get links with target="_top" to single out subject headings
course_links = course_list.find_elements_by_css_selector('a[target=_top]')
if course_links == []:
yield None
continue
# list to be appended with [subj_code, subj_name, subj_link]
yield course_links
yield None
except NoSuchElementException:
# This section must not have loaded yet.
yield None
def getSubjectList(course_links):
'''Takes the links found on the LMS page belonging to subjects,
Returns the subject list (with all the information for each)
'''
subject_list = []
for subj_num, link in enumerate(course_links):
# Turn link text into usable information.
# E.g. 'POLS20025_2017_SM2: International Relations: Key Questions'
try:
subj_code, _, _, subj_name = re.split(r"[_:]", link.text, 3)
except ValueError:
raise RuntimeError('Wrong box, communities probably')
subj_name = subj_name.lstrip()
subj_link = link.get_attribute("href")
subject_list.append(Subject(subj_code, subj_name, subj_link,
subj_num+1))
# They loaded! Don't recurse, return the list instead :)
return subject_list
def getValidUserChoice(max_subject_number):
''' Returns a list of ints, corresponding to the subject numbers
that the user wants to download.
'''
# This will be None if not specified in the settings.
user_choice = settings['subject_choices']
while True:
# Either get the user's choice.
if user_choice is None:
print("Please enter subjects you would like to download",
"(e.g. 1,2,3) or leave blank to download all.")
user_choice = input("> ")
# Or use pre-loaded subject choices.
else:
print(f"Using preloaded setting: {user_choice}")
user_choice = settings['subject_choices']
# If user_choice is empty, they just want all the subjects.
if user_choice == '':
print("User choice valid!")
return list(range(1, max_subject_number+1))
# The user has specified specific subjects, validate the input.
# Despite the earlier message, we allow commas or spaces. If the input
# is invalid we don't return and just go back around the loop.
with suppress(ValueError):
user_choice = user_choice.replace(',', ' ').split()
out = [int(x) for x in user_choice]
# Make sure that the selections are in the valid range.
if not [x for x in out if x < 1 or x > max_subject_number]:
return out
# The user choice was invalid, go back around the loop.
print('That was invalid, try again!')
user_choice = None
def getSubjects(subject_list):
'''
Takes a list of subjects, retrieves a valid selection of subjects from
the user, and returns just those subjects selected.
'''
# Get the user's choices, as a list of ints.
max_subject_number = max([subj.num for subj in subject_list])
user_choice = getValidUserChoice(max_subject_number)
return [subj for subj in subject_list if subj.num in user_choice]
def determine_subjects_to_download(subject_list):
'''
Prints candidate subjects for download, before clarifying which subjects
the user chooses to download.
'''
print("Subject list:")
for subject in subject_list:
print(f"{subject.num}. {subject.code}: {subject.name}")
return getSubjects(subject_list)
def download_lecture(dl_link, output_name, pretty_name, sizeLocal):
partial = bool(sizeLocal)
req = urllib.request.Request(dl_link)
if not partial:
# Full download.
mode = 'wb'
else:
# Resuming a partially completed download.
req.headers['Range'] = 'bytes=%s-' % sizeLocal
mode = 'ab'
f = urllib.request.urlopen(req)
# We do + sizeLocal because if we are doing a partial download, the length
# is only for what we requested to download, not the whole thing.
sizeWeb = int(f.headers["Content-Length"]) + sizeLocal
if not partial:
print(f"Downloading {pretty_name} to {output_name}.")
else:
print(f"Resuming partial download of {pretty_name} ({sizeLocal/1000:0.1f}/{sizeWeb/1000:0.1f}).")
# The ab is the append write mode.
with open(output_name, mode) as output:
for chunk in show_progress(f, pretty_name, sizeLocal, sizeWeb):
# Process the chunk
output.write(chunk)
f.close()
def getToRecordingsFirstPage(driver):
recs_first_page = search_link_text(driver, LECTURE_TAB_STRINGS)
if recs_first_page:
with suppress(WebDriverException):
recs_first_page.click()
return
# Try to move down the page (only once).
actions = webdriver.ActionChains(driver)
actions.send_keys(Keys.SPACE)
actions.perform()
recs_first_page = search_link_text(driver, LECTURE_TAB_STRINGS)
recs_first_page.click()
# @retry_until_result('Waiting for the echocenter to load... ')
def getLectureList(driver):
try:
with suppress(Exception):
iframe = driver.find_elements_by_tag_name('iframe')[1]
driver.switch_to_frame(iframe)
iframe = driver.find_elements_by_tag_name('iframe')[0]
driver.switch_to_frame(iframe)
iframe = driver.find_elements_by_tag_name('iframe')[0]
driver.switch_to_frame(iframe)
recs_ul = driver.find_element_by_css_selector("ul#echoes-list")
recs_list = recs_ul.find_elements_by_css_selector("li.li-echoes")
except NoSuchElementException:
return None
return (recs_ul, recs_list)
def getPastIntermediateRecordingsPage(driver):
# Try to get past an intermediate page if there is one.
for i in INTERMEDIATE_LECTURE_CAPTURE_NAMES:
with suppress(IndexError, StaleElementReferenceException):
# You'd be surprised at how effective this is, it can break some
# pretty nasty loops that happen because of same-name links.
# The only potentialy problem is the chance of timing out after
# a string of bad / unlucky choices.
# TODO: There is probably a better way to do this with generators
# or static vars or something.
w = random.choice(driver.find_elements_by_link_text(i))
w.click()
# TODO This max_retries should be specifiable by the settings.
@retry_until_result(GET_ECHO, max_retries=40)
def getToEchoCenter(driver):
getPastIntermediateRecordingsPage(driver)
return getLectureList(driver)
def assign_filepaths(lectures, download_mode, uni_folder):
'''Assign filepaths (and therefore also file names) to lectures.
Args:
lectures (list): List of lecture objects
download_mode (str): A string specifying audio ('audio') or video
('video') downloads.
Returns:
lectures (list): The list of lecture objects, with filepaths added.
'''
# Get the filepaths and file names
for lec in lectures:
filename = getLectureName(lec)
# Adjust name for audio files
if download_mode == 'audio':
filename_with_ext = filename + '.mp3'
else:
filename_with_ext = filename + '.m4v'
file_path = os.path.join(uni_folder, lec.folder, LECTURE_FOLDER_NAME,
filename_with_ext)
# Create the directory if it doesn't already exist.
if not os.path.isdir(os.path.join(uni_folder, lec.folder,
LECTURE_FOLDER_NAME)):
print(f'Making {LECTURE_FOLDER_NAME} folder for {lec.folder}')
os.makedirs(os.path.join(folder, lec.folder,
LECTURE_FOLDER_NAME))
lec.fName = filename
lec.fPath = file_path
return lectures
def download_lectures_for_subject(driver, subject, current_year, week_day,
dates_list, download_mode, uni_folder, q):
downloaded = []
skipped = []
print(f"\nNow working on {subject.code}: {subject.name}")
# Go to subject page and find Lecture Recordings page.
driver.get(subject.link)
main_window = driver.current_window_handle
# Get to the list of lectures.
getToRecordingsFirstPage(driver)
try:
recs_ul, recs_list = getToEchoCenter(driver)
except RuntimeError:
# TODO Make this error catching more specific.
print(f'NOTE! The echocenter could not be found for {subject.name}! Moving on...')
return None
# setup for recordings
multiple_lectures = False
lectures_list = []
to_download = []
# Getting the subject folder in which to put the lecture.
subjectFolder = getSubjectFolder(subject.code, uni_folder)
# print status
print("Building list of lectures...")
# for each li element, build up filename info and add to download list
for rec_num, recording in enumerate(recs_list):
# click on each recording to get different download links
date_div = recording.find_element_by_css_selector("div.echo-date")
# Deals with error where the next element can't be selected if it isn't
# literally visible. Limitation of selenium. Scrolls down to adjust.
while True:
try:
# Prevent header from hiding list
driver.execute_script(f"arguments[0].focus();", recs_ul)
driver.execute_script(f"window.scrollTo(0, 15);")
recording.click()
break
# Scroll down to element
except ElementNotVisibleException:
actions = webdriver.ActionChains(driver)
actions.move_to_element(recording)
actions.click()
actions.perform()
# convert string into datetime.datetime object
# date is formatted like "August 02 3:20 PM" but I want "August 02 2016"
# so I need to get rid of time and add year
date_string = " ".join(date_div.text.split(" ")[:-2]) + f" {current_year}"
try:
date = datetime.datetime.strptime(date_string, "%d %B %Y")
except ValueError:
# Sometimes the date is presented in different format.
date = datetime.datetime.strptime(date_string, "%B %d %Y")
# Checking if we can terminate early.
if date < dates_list[0]:
print("The lectures further down are outside the date range, no need to check them.")
break
# lookup week number and set default lecture number
try:
week_num = week_day[date]
except KeyError:
print('NOTE! Ignoring lecture with date ' + str(date) + ' because\n'
' it is outside of the standard semester week range,\n'
' you\'ll have to download it manually :/')
continue
lec_num = 1
# get link to initial download page for either audio or video
while True:
try:
if download_mode == "audio":
first_link = driver.find_element_by_partial_link_text("Audio File").get_attribute("href")
else:
first_link = driver.find_element_by_partial_link_text("Video File").get_attribute("href")
break
except NoSuchElementException:
time.sleep(0.5)
# check if week_num is already in to_download
for lecture in lectures_list:
if lecture.week == week_num:
# set multiple_lectures to true so filenames include lec nums
multiple_lectures = True
# add 1 to lec_num of earlier video
lecture.lecOfWeek += 1
# Create Lecture
lectures_list.append(Lecture(first_link, subject.code, week_num,
lec_num, date, subject.name,
len(recs_list) - rec_num, subjectFolder))
# assign filepaths, filenames
lectures_list = assign_filepaths(lectures_list, download_mode, uni_folder)
# DOWNLOADING STARTS HERE
# TODO - This is going into each link even if we don't need the lecture.
# This slows the program down massively.
# Perhaps filter out those with invalid dates & non-existent files?
# A part of this is caused by having to check file sizes every
# single time. Get the file sizes once, save into a document, so we
# don't have to do this every time.
# only add lectures to be downloaded if they are inside date range. else,
# skip them
for lec in lectures_list:
# Append to download list if the file in date range and doesn't exist yet.
if lec.date in dates_list and not os.path.isfile(lec.fPath):
print(f"Will download {lec.fName}")
to_download.append((lec, False)) # False means not downloaded at all.
# If the file is in the range but does exist, check that the file is completely
# downloaded. If not, we will add it to the download list and overwrite the
# local incomplete version.
# DAVETODO: SAVE FILE SIZES AND COMPLETED DOWNLOADS IN PICKLE FILE
# DAVETODO: CREATE SETTING 're-download' WHICH MAKES THE PROGRAM CHECK
# WHETHER OR NOT OLD FILES STILL EXIST, AND REDOWNLOAD IF
# NECESSARY.
elif lec.date in dates_list and os.path.isfile(lec.fPath):
while True:
try:
driver.get(lec.link)
dl_link = driver.find_element_by_partial_link_text("Download media file.").get_attribute("href")
# send javascript to stop download redirect
driver.execute_script('stopCounting=true')
break
except:
time.sleep(0.5)
# Check size of file on server. If the server version is larger than the local version,
# we notify the user of an incomplete file (perhaps the connection dropped or the user
# cancelled the download). We tell them we're going to download it again.
# Using wget we could resume the download, but python urllib doesn't have such functionality.
try:
# TODO: This whole thing is weird, we shouldn't have to open the
# web link twice. This should all probably be handled in the
# download function, or at least more elegantly than this.
f = urllib.request.urlopen(dl_link)
# This is the size of the file on the server in bytes.
sizeWeb = int(f.headers["Content-Length"])
except:
# Catching the situation where the server doesn't advertise the file length.
sizeWeb = 0
# Get size of file on disk.
statinfo = os.stat(lec.fPath)
sizeLocal = statinfo.st_size
# Add to download list with note that it was incomplete.
# TODO Unify the two bits of code to do with downloading / progress.
# BUG: Fully downloaded lectures are re-downloading?
if sizeWeb > sizeLocal:
lec.dl_status = "Incomplete file (%0.1f/%0.1f MiB)." % (
sizeLocal / 1024 / 1024,
sizeWeb / 1024 / 1024,
)
# Include (sizeLocal, sizeWeb) if partially downloaded.
to_download.append((lec, (sizeLocal, sizeWeb)))
print("Resuming " + lec.fName + ": " + lec.dl_status)
# Otherwise the file must be fully downloaded.
else:
lec.dl_status = "File already exists on disk (fully downloaded)."
skipped.append(lec)
print("Skipping " + lec.fName + ": " + lec.dl_status)
# Dealing with other cases.
else:
# if both outside date range and already exists
if not lec.date in dates_list and os.path.isfile(lec.fPath):
lec.dl_status = "Outside date range and file already exists"
# if just outside date range
elif not lec.date in dates_list:
lec.dl_status = "Outside date range"
# If file already exists and is fully completed.
# Shouldn't really get to this case (caught above).
elif os.path.isfile(lec.fPath):
lec.dl_status = "File already exists"
skipped.append(lec)
print(f"Skipping {lec.fName}: {lec.dl_status}")
# print list of lectures to be downloaded
if len(to_download) > 0:
print("Lectures to be downloaded:")
for lec, partial in to_download:
# Print with additional note if it's there.
# DAVE_HERE
if lec.dl_status is not None:
print(lec.fName, "-", lec.dl_status)
else:
print(lec.fName)
else:
print("No lectures to be downloaded for " + subject.name)
# for each lecture, set filename and download
for lec, partial in to_download:
# build up filename
print("Now working on", lec.fName)
# go to initial download page and find actual download link
while True:
try:
driver.get(lec.link)
dl_link = driver.find_element_by_partial_link_text("Download media file.").get_attribute("href")
# send javascript to stop download redirect
driver.execute_script('stopCounting=true')
break
except:
time.sleep(0.5)
# This handles a full download. Report the local size as 0.
if not partial:
dl_func = functools.partial(download_lecture, dl_link, lec.fPath, lec.fName, 0)
# This handles a partially downloaded file.
else:
sizeLocal, sizeWeb = partial
dl_func = functools.partial(download_lecture, dl_link, lec.fPath, lec.fName, sizeLocal)
q.put(dl_func)
downloaded.append(lec)
# when finished with subject
print(f"Queued downloads for {subject.code}! Going to next file!")
return downloaded, skipped
# Check dates_list
# The lectures further down are outside the date range, no need to check them.
def consume_dl_queue(q):
# This will just keep consuming an item from the queue and downloading it
# until the program ends. get() blocks if there isn't an item in the queue.
while True:
dl_func = q.get()
res = dl_func()
if res is False:
break
def main():
# Setup download folders
home_dir = os.path.expanduser("~")
uni_folder = check_uni_folder(settings['uni_location'], home_dir)
print("Welcome to", sys.argv[0])
# Date Junk
current_year = datetime.datetime.now().year
week_day = {}
dates_list = get_weeks_to_download(current_year, week_day)
# DATE ERROR
# print(dates_list)
download_mode = get_download_mode()
# Start Chrome instance
print("Starting up Chrome instance")
chrome_options = Options()
window_size = settings.get('window_size', '1600,900')
chrome_options.add_argument('--window-size=' + window_size)
if settings['hide_window']:
print('Running in headless (hidden window) mode.')
chrome_options.add_argument('--headless')
chrome_options.add_argument('--disable-gpu') # TODO: Remove this
try:
# We build an absolute path to avoid the "Message: 'chromedriver'
# executable needs to be in PATH" error.
path = os.path.abspath(settings['driver_relative_path'])
driver = webdriver.Chrome(path, chrome_options=chrome_options)
except Exception as e1:
try:
path = path + '.exe' # We're on Windows.
driver = webdriver.Chrome(path, chrome_options=chrome_options)
except Exception as e2:
print('Couldn\'t start Chrome!', file=sys.stderr)
print(str(e1), file=sys.stderr)
print(str(e2), file=sys.stderr)
sys.exit(1)
# Login
print("Starting login process")
driver.get("https://app.lms.unimelb.edu.au")
sign_in(driver)
driver.refresh()
print("Building list of subjects")
# This yucky looking control structure makes sure we get the right
# box (subjects and not communities).
subjectsFoundSuccess = False
while not subjectsFoundSuccess:
try:
course_listing = get_course_links(driver)
except StopIteration:
# I know this is messy, that this is needed even with the decorator.
time.sleep(0.5)
continue
try:
subject_list = getSubjectList(course_listing)
except RuntimeError:
continue
subjectsFoundSuccess = True
numSubjects = len(subject_list)
subjects_to_download = determine_subjects_to_download(subject_list)
print("Subjects to be downloaded:")
for subject in subjects_to_download:
print(f"{subject.code}: {subject.name}")
# Track which lectures we downloaded and which we skipped.
all_downloaded = []
all_skipped = []
q = Queue()
t = Thread(target=consume_dl_queue, args=(q,), daemon=True)
t.start()
for subject in subjects_to_download:
res = download_lectures_for_subject(driver, subject, current_year,
week_day, dates_list,
download_mode, uni_folder, q)
if res:
downloaded, skipped = res
all_downloaded += downloaded
all_skipped += skipped
# Done , close the browser.
print("All links have been collected, waiting for downloads to complete...")
driver.quit()
# Let the thread know that we're done collecting download links.
q.put(lambda: False)
# Wait for all the downloads to complete.
t.join()
# List the lectures that we downloaded and those we skipped.
if len(all_downloaded) > 0:
print(f"Downloaded {len(all_downloaded)} lecture(s):")
for lecture in all_downloaded:
print(lecture.fName)
if len(all_skipped) > 0:
print(f"Skipped {len(all_skipped)} lecture(s):")
for lecture in all_skipped:
print(lecture.fName + ": " + lecture.dl_status)
print("\nDone!\n")
if __name__ == '__main__':
main()