sanjacob / blackboardsync Goto Github PK

BlackboardSync Version

Latest

BlackboardSync Release

MacOS build

Python Version

No response

Operating System and Version

macOS

University Name

UAntwerpen

Problem Description

Somehow UAntwerpen formatted specific folders as "Documents" with tags referring to the actual documents. This raises a ValueError in download.py which is not intercepted. Adding a pass for ValueError solves this issue for me:

` elif res in (BBResourceType.file, BBResourceType.document) and has_changed:
attachments = []

        try:
            attachments = self._sess.fetch_file_attachments(course_id=course_id,
                                                            content_id=content.id)

        except RequestException:
            self.logger.warn(f"Error while getting attachments for {course_id}")
        except ValueError:
            pass`

Since its probably only a UAntwerpen thing and not applicable for other universities (and might break stuff) I decided to just let you know and make it a pull request.

Log File Contents

No response

University name: Centro Universitario de Tecnología y Arte Digital

Short name or abbreviation: U-tad

Link to Blackboard portal: https://u-tad.blackboard.com/

Landing URL after successfully logging in: https://u-tad.blackboard.com/ultra/

All DataSourceIDs are the same: "dataSourceId": "_2_1"

A response can contain "Disabled" or "Term" in the available field, which fails to validate as BBAvailability expects a bool. https://github.com/jacobszpz/BlackboardSync/blob/8e7acee46199e01596576155ec9b55458516fce9/blackboard_sync/blackboard/blackboard.py#L84-L85

These response values are observed for SHSU's Blackboard service.

• University name: Texas Tech University
• Short name or abbreviation: TTU
• Link to Blackboard portal: https://ttu.blackboard.com/
• Landing URL after successfully logging in: https://ttu.blackboard.com/ultra/institution-page

This should help the user realise where the app is located.

Previously, a 403 response error would generate a ValueError which was caught by BlackboardSync._sync_task(...) and handled as an authorization error. Because the subsequent call to BlackboardSync.auth(...) simply recreated the BlackboardSession and returned (effectively a no-op), the application would simply (attempt to) download the next item.

With the new, differentiated BBAuthError, this response code is no longer handled with this no-op. This will place the BlackboardSync object into an error state. Unfortunately, the response that I receive does not have any fields other than a message field; there is nothing to check for.

I would like to handle this type of response code explicitly instead of resetting the session, like is done with a 403 response for private courses. Since there is no clear way to differentiate different 403 responses, a base exception class titled BBForbiddenError should suffice. BBPrivateCourseError will inherit from this, as it is a 403-related error. I will edit this issue to reference the PR once the new exceptions are completely integrated.

University name: The Chinese University of Hong Kong, Shenzhen

Short name or abbreviation: CUHK-Shenzhen or CUHKSZ

Link to Blackboard portal: bb.cuhk.edu.cn

Landing URL after successfully logging in: https://bb.cuhk.edu.cn/webapps/portal/execute/tabs/tabAction?tab_tab_group_id=_1_1

I can see that this tool can support CUHK, and I think CUHK-Shenzhen works similarly. Thanks!

Since session is externally handled by Qt, cookie store must be cleaned out somehow

Some tests were skipped intentionally since the API has changed since they were written. Extra work is needed to adapt these tests for the current interface.

BlackboardSync Version

ecae7bf

BlackboardSync Release

From source

Python Version

Python 3.11

Operating System and Version

Linux 6.6.30-2-lts

University Name

University of Pretoria

Problem Description

The UI limits the download year to be from 2023 or before meaning I cannot download only the present year's content. Changing the maximum value to 2024 in qt/SetupWizard.ui seems to make it work as expected.

Log File Contents

No response

Following the release of pyinstaller 6.* ( #90) which changed library linking, the github actions workflow should be adapted to no longer perform this step and instead letting pyinstaller do it.

University name

University of Antwerp

Short name or abbreviation

UA

Link to Blackboard instance

https://lms.uantwerpen.be

Landing URL after logging in

https://lms.uantwerpen.be/ultra/

Valid Blackboard data sources (optional)

{
"name": "University of Antwerp",
"short_name": "Universiteit Antwerpen",
"login": {
"start_url": "https://lms.uantwerpen.be",
"target_url": "https://lms.uantwerpen.be/ultra/"
},
"api_url": "https://lms.uantwerpen.be/"
}

University ISP name (optional)

University of Antwerp

Anything else to add?

  Value error, 'x-bb-bltiplacement-mediasite.lesopnames' is not a valid BBResourceType [type=value_error, input_value='resource/x-bb-bltiplacement-mediasite.lesopnames', input_type=str]

I get an error when it tries to download the course video's (lesopnames) from blackboard.

Below is the log file. For courses without course video's, it works.
sync_error_2023-11-14T16_00_48_646488.log

License

• I agree to follow this project's License

By creating a fake API which returns pre-determinate results, and hosting it locally, it will be possible to test the download module.

First of all, thanks for creating this project. It would be great to see my own institution on this list if possible.
Name: University of Lincoln
Abbr.: UoL
Portal URL: https://blackboard.lincoln.ac.uk/
Landing URL: https://blackboard.lincoln.ac.uk/ultra
dateSourceID: _570_1

Bug only present on Linux, where the file path of the link is previously created as a directory, thus preventing the later creation of the web link.

The domain for SHSU's blackboard service will change to blackboard.shsu.edu at 8:00PM CST Nov 11, 2023 according to SHSU's own communications. I will monitor this change to see if the niversities.json file must change to reflect this.

With the goal of decoupling things and allowing these two projects to grow on their own, I have begun decoupling BlackboardSync from the Blackboard API Client (module blackboard), the latter now exists in its own repo bblearn.

The current goals for BlackboardSync are to improve error prevention, static verification, and to refactor.
Furthermore, also to set the scene for future features such as improved content filtering.

University name

Sam Houston State University

Short name or abbreviation

SHSU

Link to Blackboard instance

https://shsu.blackboard.com/

Landing URL after logging in

https://shsu.blackboard.com/ultra

Valid Blackboard data sources (optional)

No response

University ISP name (optional)

No response

Anything else to add?

The "login page" provides a list of options for universities to log in with. I have confirmed that at least one of these universities redirects back to the original shsu.blackboard.com domain, and I presume the API routes are likely the same.

For reference, here's my testing entry in universities.json:

  {
    "name": "Sam Houston State University",
    "short_name": "SHSU",
    "login": {
      "start_url": "https://shsu.blackboard.com/",
      "target_url": "https://shsu.blackboard.com/ultra/"
    },
    "api_url": "https://shsu.blackboard.com/"
  }

License

• I agree to follow this project's License

When I run the 'blackboard_sync' module using 'python -m blackboard_sync', the following error occurs:

Traceback (most recent call last):
File "", line 198, in run_module_as_main
File "", line 88, in run_code
File "C:\Python311\Lib\site-packages\blackboard_sync_main.py", line 32, in
raise SystemExit(main())
^^^^^^
File "C:\Python311\Lib\site-packages\blackboard_sync_main.py", line 27, in main
BBSyncController()
File "C:\Python311\Lib\site-packages\blackboard_sync\sync_controller.py", line 58, in init
self._build_login_window(self.model.university.login)
File "C:\Python311\Lib\site-packages\blackboard_sync\sync_controller.py", line 96, in _build_login_window
self.login_window = LoginWebView(start_url=uni_login_info.start_url,
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Python311\Lib\site-packages\blackboard_sync\qt\qt_elements.py", line 475, in init
self._init_ui()
File "C:\Python311\Lib\site-packages\blackboard_sync\qt\qt_elements.py", line 480, in _init_ui
self.web_view.load(QUrl.fromUserInput(self.start_url))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: arguments did not match any overloaded call:
fromUserInput(userInput: str): argument 1 has unexpected type 'pydantic_core._pydantic_core.Url'
fromUserInput(userInput: str, workingDirectory: str, options: Union[QUrl.UserInputResolutionOptions, QUrl.UserInputResolutionOption] = QUrl.DefaultResolution): argument 1 has unexpected type 'pydantic_core._pydantic_core.Url'

University name

Schoolcraft College

Short name or abbreviation

No response

Link to Blackboard instance

https://bb.schoolcraft.edu

Landing URL after logging in

https://bb.schoolcraft.edu/ultra/institution-page

Valid Blackboard data sources (optional)

_2_1

University ISP name (optional)

No response

Anything else to add?

No response

License

• I agree to follow this project's License

University name

University of Antwerp

Short name or abbreviation

UA

Link to Blackboard instance

lms.uantwerpen.be

Landing URL after logging in

lms.uantwerpen.be/ultra

Valid Blackboard data sources (optional)

No response

University ISP name (optional)

No response

Anything else to add?

The green folders are downloaded, the red one not

License

• I agree to follow this project's License

The exception handling in _sync_task incorrectly assumes that any ValueError is the result of an expired session. https://github.com/jacobszpz/BlackboardSync/blob/8e7acee46199e01596576155ec9b55458516fce9/blackboard_sync/sync.py#L174-L178

pydantic.ValidationError inherits from ValueError, causing _sync_task to handle validation errors with the above block. The result is that the application will assume that the session has expired when it has not. The application will then restart synchronization, validation will fail again, rinse, repeat. This loop does not break, and the user is provided no indication this is happening outside logs.

For SHSU specifically, the application:

1. Never downloads anything, and repeatedly queries the enrolled courses.
   • Caused by #105
2. Completes a partial download, and repeatedly re-downloads (and re-writes the files for) content.
   • Caused by #106

Hello, here is the data for the University of Pretoria

University name: University of Pretoria

Short name or abbreviation: UP

Link to Blackboard portal: https://clickup.up.ac.za

Landing URL after successfully logging in: https://clickup.up.ac.za/ultra

I have tested this on my machine and it does download the content.

The university is in Africa if you want to add it to the supported universities list

Thanks

This behaviour is not handled yet

University name: University of Otago
Short name: UOO
Link to Blackboard portal: https://blackboard.otago.ac.nz/
Landing URL: https://blackboard.otago.ac.nz/ultra/institution-page

A response may contain "x-bb-lesson" in the id field, which fails to validate as the BBResourceType enum does not have a corresponding value. https://github.com/jacobszpz/BlackboardSync/blob/8e7acee46199e01596576155ec9b55458516fce9/blackboard_sync/blackboard/blackboard.py#L106-L120

These response values are observed for SHSU's Blackboard service.

Probably implemented through windows installer. However, on macos this will require additional work.

Hello,
I'd like to add support for Blackboard Sync for Griffith University, Australia. Details are as follows:

University name: Griffith University

Short name or abbreviation: GriffUni

Link to Blackboard portal: http://bblearn.griffith.edu.au/

Landing URL after successfully logging in: https://bblearn.griffith.edu.au/webapps/portal/execute/tabs/tabAction?tab_tab_group_id=_1_1

And is there an ETA on the next release? :)

Kind regards,
Kristina
Learning and Teaching Solutions
Griffith University

Some courses may be structured in a way where some or most of the contents are only listed in one of the file attachments which actually exist within webdav. To download these, extra effort must be made to check for this webdav redirection and parse such files for links. Note that this is different from the current parsing for webdav links, as that happens within the body property of the API response, and this proposal relates to parsing the actual content of files downloaded, which means file content must be kept in memory temporarily to parse it out.

This scenario is quite rare and it isn't worth the trouble in my opinion, since the vast majority of the courses I have seen are not of this nature. However, if you would like to offer your comments on this proposal, please let me know here. If enough support for this proposal is gathered, I will consider implementing the feature.

BlackboardSync Version

0.11.2 Latest

BlackboardSync Release

windows and python

Python Version

3.11

Operating System and Version

windows 11

University Name

schoolcraft college

Problem Description

hey bro, I am sorry. I wasn't trying to be rude. I think we have a timezone difference thats why my messages come unorganized. Please man, I need this fixed before my class ends, that's why I was tagging you multiple times. Please help.

Log File Contents

No response

University name

Hanze University of Applied Sciences

Short name or abbreviation

Hanze UAS

Link to Blackboard instance

https://blackboard.hanze.nl

Landing URL after logging in

https://blackboard.hanze.nl/ultra

Valid Blackboard data sources (optional)

No response

University ISP name (optional)

No response

Anything else to add?

No response

License

• I agree to follow this project's License

University name (University of Connecticut).

Short name or abbreviation (UCONN).

Link to Blackboard portal (https://huskyct.uconn.edu/ or https://lms.uconn.edu/).
Both work from browser but unsure which one is correct

Landing URL after successfully logging in (https://huskyct.uconn.edu/ultra/).

Further investigation is needed

Hi, here is the data for University of Minho. I already tried it and it seems be working.

name: University of Minho
short_name: UM
start_url: https://elearning.uminho.pt
target_url: https://elearning.uminho.pt/ultra/
api_url: https://elearning.uminho.pt

Data sourceIDs is always "_2_1"