def _handle_description(self, section_name: str, module_name: str,
module_modname: str, module_id: str,
module_description: str) -> [File]:
"""
Creates a description file
@param module_description: The description of the module
@params: All necessary parameters to create a file.
@return: A list of files that exist in a module.
"""
files = []
content_type = 'description'
content_filename = module_name
content_filepath = '/'
content_filesize = len(module_description)
content_fileurl = ''
content_timemodified = 0
content_isexternalfile = False
m = hashlib.sha1()
hashable_description = ResultsHandler._filter_changing_attributes(
module_description)
m.update(hashable_description.encode('utf-8'))
hash_description = m.hexdigest()
if module_modname.startswith(('url', 'index_mod')):
module_modname = 'url_description'
description = File(
module_id=module_id,
section_name=section_name,
module_name=module_name,
content_filepath=content_filepath,
content_filename=content_filename,
content_fileurl=content_fileurl,
content_filesize=content_filesize,
content_timemodified=content_timemodified,
module_modname=module_modname,
content_type=content_type,
content_isexternalfile=content_isexternalfile,
hash=hash_description,
)
description.text_content = module_description
files += self._find_all_urls_in_description(section_name, module_name,
module_modname, module_id,
content_filepath,
module_description)
files.append(description)
return files
def _handle_files(self, section_name: str, module_name: str,
module_modname: str, module_id: str,
module_contents: []) -> [File]:
"""
Iterates over all files that are in a module or assignment and
returns a list of all files
@param module_contents: The list of content of the module
or assignment.
@params: All necessary parameters to create a file.
@return: A list of files that exist in a module.
"""
files = []
for content in module_contents:
content_type = content.get('type', '')
content_filename = content.get('filename', '')
content_filepath = content.get('filepath', '/')
if content_filepath is None:
content_filepath = '/'
content_filesize = content.get('filesize', 0)
content_fileurl = content.get('fileurl', '')
content_timemodified = content.get('timemodified', 0)
content_isexternalfile = content.get('isexternalfile', False)
if content_fileurl == '' and module_modname.startswith(
('url', 'index_mod', 'cookie_mod')):
continue
if module_modname.startswith('index_mod'):
content_filename = module_name
hash_description = None
if content_type == 'description':
content_description = content.get('description', '')
hashable_description = ResultsHandler._filter_changing_attributes(
content_description)
m = hashlib.sha1()
m.update(hashable_description.encode('utf-8'))
hash_description = m.hexdigest()
new_file = File(
module_id=module_id,
section_name=section_name,
module_name=module_name,
content_filepath=content_filepath,
content_filename=content_filename,
content_fileurl=content_fileurl,
content_filesize=content_filesize,
content_timemodified=content_timemodified,
module_modname=module_modname,
content_type=content_type,
content_isexternalfile=content_isexternalfile,
hash=hash_description,
)
if content_type == 'description':
new_file.text_content = content_description
files += self._find_all_urls_in_description(
section_name, module_name, module_modname, module_id,
content_filepath, content_description)
files.append(new_file)
return files
def _handle_files(
self,
section_name: str,
section_id: int,
module_name: str,
module_modname: str,
module_id: str,
module_contents: [],
) -> [File]:
"""
Iterates over all files that are in a module or assignment and
returns a list of all files
@param module_contents: The list of content of the module
or assignment.
@params: All necessary parameters to create a file.
@return: A list of files that exist in a module.
"""
files = []
for content in module_contents:
content_type = content.get('type', '')
content_filename = content.get('filename', '')
content_filepath = content.get('filepath', '/')
if content_filepath is None:
content_filepath = '/'
content_filesize = content.get('filesize', 0)
content_fileurl = content.get('fileurl', '')
content_timemodified = content.get('timemodified', 0)
content_isexternalfile = content.get('isexternalfile', False)
# description related
content_description = content.get('description', '')
no_search_for_urls = content.get('no_search_for_urls', False)
no_search_for_moodle_urls = content.get('no_search_for_moodle_urls', False)
filter_urls_during_search_containing = content.get('filter_urls_during_search_containing', [])
content_no_hash = content.get('no_hash', False)
# html related
content_html = content.get('html', '')
if content_fileurl == '' and module_modname.startswith(('url', 'index_mod', 'cookie_mod')):
continue
# Add the extention condition to avoid renaming pdf files or other downloaded content from moodle pages.
if module_modname.startswith('index_mod') and content_filename.endswith('.html'):
content_filename = module_name
hash_description = None
if content_type == 'description' and not content_no_hash:
hashable_description = ResultsHandler._filter_changing_attributes(content_description)
m = hashlib.sha1()
m.update(hashable_description.encode('utf-8'))
hash_description = m.hexdigest()
new_file = File(
module_id=module_id,
section_name=section_name,
section_id=section_id,
module_name=module_name,
content_filepath=content_filepath,
content_filename=content_filename,
content_fileurl=content_fileurl,
content_filesize=content_filesize,
content_timemodified=content_timemodified,
module_modname=module_modname,
content_type=content_type,
content_isexternalfile=content_isexternalfile,
hash=hash_description,
)
if content_type == 'description':
new_file.text_content = content_description
content_html = content_description
if content_type == 'html':
new_file.html_content = content_html
if content_type in ['description', 'html'] and not no_search_for_urls:
files += self._find_all_urls(
section_name,
section_id,
module_name,
module_modname,
module_id,
content_filepath,
content_html,
no_search_for_moodle_urls,
filter_urls_during_search_containing,
)
files.append(new_file)
return files
