Skip to content

Option to redownload file when the file on Moodle with the same path is modified #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Option to redownload file when the file on Moodle with the same path is modified #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion config.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"totpsecret": "",
"basedir": "./",
"cookie_file": "./session",
"root_node_cache_file": "./cached_root_node",
"use_secret_service": false,
"secret_service_store_totp_secret": false,
"no_links": false,
Expand All @@ -23,5 +24,6 @@
"folder": true
},
"exclude_filetypes": [],
"exclude_files": []
"exclude_files": [],
"update_files": true
}
52 changes: 49 additions & 3 deletions syncmymoodle/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def __init__(
parent,
url=None,
additional_info=None,
timemodified=None,
is_downloaded=False,
):
self.name = name
Expand All @@ -81,14 +82,15 @@ def __init__(
self.additional_info = (
additional_info # Currently only used for course_id in opencast
)
self.timemodified = timemodified
self.is_downloaded = (
is_downloaded # Can also be used to exclude files from being downloaded
)

def __repr__(self):
return f"Node(name={self.name}, id={self.id}, url={self.url}, type={self.type})"

def add_child(self, name, id, type, url=None, additional_info=None):
def add_child(self, name, id, type, url=None, additional_info=None, timemodified=None):
if url:
url = url.replace("?forcedownload=1", "").replace(
"mod_page/content/3", "mod_page/content"
Expand All @@ -99,7 +101,7 @@ def add_child(self, name, id, type, url=None, additional_info=None):
if url and any([True for c in self.children if c.url == url]):
return None

temp = Node(name, id, type, self, url=url, additional_info=additional_info)
temp = Node(name, id, type, self, url=url, additional_info=additional_info, timemodified=timemodified)
self.children.append(temp)
return temp

Expand All @@ -111,6 +113,17 @@ def get_path(self):
cur = cur.parent
return ret

def go_to_path(self, target_path):
target_node = [self]
for path_child in target_path:
if path_child == '':
continue
try:
target_node.append([node_child for node_child in target_node[-1].children if node_child.name == path_child][0])
except IndexError:
raise Exception("The path is not found in this root node. Wrong path?")
return target_node[-1]

def remove_children_nameclashes(self):
# Check for duplicate filenames

Expand Down Expand Up @@ -197,6 +210,21 @@ def __init__(self, config):
self.wstoken = None
self.user_id = None
self.root_node = None
root_node_cache_file = Path(self.config.get("root_node_cache_file", "./cached_root_node"))
if root_node_cache_file.exists():
with root_node_cache_file.open("rb") as f:
try:
self.cached_root_node = pickle.load(f)
except EOFError:
self.cached_root_node = None
print("Error loading root_node cache.")
else:
self.cached_root_node = None

def cache_root_node(self):
root_node_cache_file = Path(self.config.get("root_node_cache_file", "./cached_root_node"))
with root_node_cache_file.open("wb") as f:
pickle.dump(self.root_node, f)

# RWTH SSO Login

Expand Down Expand Up @@ -697,13 +725,15 @@ def sync(self):
c["fileurl"],
"Folder File",
url=c["fileurl"],
timemodified=c["timemodified"]
)
else:
folder_node.add_child(
c["filename"],
c["fileurl"],
"Folder File",
url=c["fileurl"],
timemodified=c["timemodified"]
)

# Get embedded videos in pages or labels
Expand Down Expand Up @@ -902,7 +932,10 @@ def download_file(self, node):
downloadpath = self.get_sanitized_node_path(node)

if downloadpath.exists():
return True
if not self.config.get("updatefiles"):
return True
elif self.cached_root_node is not None and node.timemodified == self.cached_root_node.go_to_path(node.get_path()).timemodified:
return True

if len(node.name.split(".")) > 0 and node.name.split(".")[
-1
Expand Down Expand Up @@ -1204,6 +1237,9 @@ def main():
parser.add_argument(
"--cookiefile", default=None, help="set the location of a cookie file"
)
parser.add_argument(
"--rootnodecachefile", default=None, help="set the location of a root node cache file"
)
parser.add_argument(
"--courses",
default=None,
Expand Down Expand Up @@ -1234,6 +1270,11 @@ def main():
default=None,
help='specify whether specific file types should be excluded, comma-separated e.g. "mp4,mkv"',
)
parser.add_argument(
"--updatefiles",
action="store_true",
help="define whether modified files with the same name/path should be redownloaded",
)
parser.add_argument(
"-v",
"--verbose",
Expand Down Expand Up @@ -1272,6 +1313,7 @@ def main():
config["totp"] = args.totp or config.get("totp")
config["totpsecret"] = args.totpsecret or config.get("totpsecret")
config["cookie_file"] = args.cookiefile or config.get("cookie_file", "./session")
config["root_node_cache_file"] = args.rootnodecachefile or config.get("root_node_cache_file", "./cached_root_node")
config["selected_courses"] = (
args.courses.split(",") if args.courses else config.get("selected_courses", [])
)
Expand Down Expand Up @@ -1306,6 +1348,8 @@ def main():
)

config["exclude_files"] = config.get("exclude_files", [])

config["updatefiles"] = args.updatefiles or config.get("update_files")

logging.basicConfig(level=args.loglevel)

Expand Down Expand Up @@ -1387,6 +1431,8 @@ def main():
smm.sync()
print("Downloading files...")
smm.download_all_files()
print("Saving root node as cache...")
smm.cache_root_node()


if __name__ == "__main__":
Expand Down