Skip to content
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.

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

Add a full rescan option to UDOIT #898

Merged
merged 5 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
17 changes: 17 additions & 0 deletions assets/js/Components/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class App extends React.Component {
this.handleIssueSave = this.handleIssueSave.bind(this)
this.handleFileSave = this.handleFileSave.bind(this)
this.handleCourseRescan = this.handleCourseRescan.bind(this)
this.handleFullCourseRescan = this.handleFullCourseRescan.bind(this)
this.handleNewReport = this.handleNewReport.bind(this)
this.resizeFrame = this.resizeFrame.bind(this)
}
Expand All @@ -53,6 +54,7 @@ class App extends React.Component {
navigation={this.state.navigation}
handleNavigation={this.handleNavigation}
handleCourseRescan={this.handleCourseRescan}
handleFullCourseRescan={this.handleFullCourseRescan}
handleModal={this.handleModal} />

{(('welcome' !== this.state.navigation) && ('summary' !== this.state.navigation)) &&
Expand Down Expand Up @@ -148,6 +150,11 @@ class App extends React.Component {
return api.scanCourse(this.settings.course.id)
}

fullRescan() {
let api = new Api(this.settings)
return api.fullRescan(this.settings.course.id)
}

disableReview = () => {
return this.state.syncComplete && !this.state.disableReview
}
Expand All @@ -162,6 +169,16 @@ class App extends React.Component {
this.forceUpdate()
}

handleFullCourseRescan() {
if (this.state.hasNewReport) {
this.setState({ hasNewReport: false, syncComplete: false })
this.fullRescan()
.then((response) => response.json())
.then(this.handleNewReport)
}
this.forceUpdate()
}

handleNewReport(data) {
let report = this.state.report
let hasNewReport = this.state.hasNewReport
Expand Down
1 change: 1 addition & 0 deletions assets/js/Components/Header.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ class Header extends React.Component {
{/* <Menu.Item onClick={() => this.handleMoreNav('settings')}>{this.props.t('menu.settings')}</Menu.Item> */}
<Menu.Separator />
<Menu.Item onClick={this.props.handleCourseRescan}>{this.props.t('menu.scan_course')}</Menu.Item>
<Menu.Item onClick={this.props.handleFullCourseRescan}>{this.props.t('menu.full_rescan')}</Menu.Item>
<Menu.Separator />
<Menu.Item href={pdfUrl}>{this.props.t('menu.download_pdf')}</Menu.Item>
</Menu>
Expand Down
16 changes: 16 additions & 0 deletions assets/js/Services/Api.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export default class Api {
adminCourses: '/api/admin/courses/account/{account}/term/{term}',
scanContent: '/api/sync/content/{contentItem}',
scanCourse: '/api/sync/{course}',
fullRescan: '/api/sync/rescan/{course}',
scanIssue: '/api/issues/{issue}/scan',
adminReport: '/api/admin/courses/{course}/reports/latest',
adminReportHistory: '/api/admin/reports/account/{account}/term/{term}',
Expand Down Expand Up @@ -233,6 +234,21 @@ export default class Api {
})
}

fullRescan(courseId)
{
const authToken = this.getAuthToken()
let url = `${this.apiUrl}${this.endpoints.fullRescan}`
url = url.replace('{course}', courseId)

return fetch(url, {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'X-AUTH-TOKEN': authToken,
},
})
}

scanContent(contentId)
{
const authToken = this.getAuthToken()
Expand Down
53 changes: 53 additions & 0 deletions src/Controller/SyncController.php
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,59 @@ public function requestSync(Course $course, LmsFetchService $lmsFetch)
return new JsonResponse($response);
}

#[Route('/api/sync/rescan/{course}', name: 'full_rescan')]
public function fullCourseRescan(Course $course, LmsFetchService $lmsFetch) {
$response = new ApiResponse();
$user = $this->getUser();
$reportArr = false;

try {
if (!$this->userHasCourseAccess($course)) {
throw new \Exception('msg.no_permissions');
}
if ($course->isDirty()) {
throw new \Exception('msg.course_scanning');
}
if (!$course->isActive()) {
$response->setData(0);
throw new \Exception('msg.sync.course_inactive');
}

$prevReport = $course->getPreviousReport();

$course->removeAllReports();

$lmsFetch->refreshLmsContent($course, $user);

$report = $course->getLatestReport();

if (!$report) {
throw new \Exception('msg.no_report_created');
}

$reportArr = $report->toArray();
$reportArr['files'] = $course->getFileItems();
$reportArr['issues'] = $course->getAllIssues();
$reportArr['contentItems'] = $course->getContentItems();

$response->setData($reportArr);

if ($prevReport && ($prevReport->getIssueCount() == $report->getIssueCount())) {
$response->addMessage('msg.no_new_content', 'success', 5000);
} else {
$response->addMessage('msg.new_content', 'success', 5000);
}
} catch (\Exception $e) {
if ('msg.course_scanning' === $e->getMessage()) {
$response->addMessage($e->getMessage(), 'info', 0, false);
} else {
$response->addMessage($e->getMessage(), 'error', 0);
}
}

return new JsonResponse($response);
}

#[Route('/api/sync/content/{contentItem}', name: 'content_sync', methods: ['GET'])]
public function requestContentSync(ContentItem $contentItem, LmsFetchService $lmsFetch, PhpAllyService $phpAlly)
{
Expand Down
6 changes: 6 additions & 0 deletions src/Entity/Course.php
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,12 @@ public function removeReport(Report $report): self
return $this;
}

public function removeAllReports(): self
{
$this->reports->clear();
return $this;
}

public function getPreviousReport(): ?Report
{
$reports = $this->reports->toArray();
Expand Down
1 change: 1 addition & 0 deletions translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
"menu.admin": "Admin",
"menu.download_pdf": "Download PDF",
"menu.scan_course": "Rescan Course",
"menu.full_rescan": "Force Full Rescan",

"msg.no_permissions": "You do not have permission to access the specified course.",
"msg.course_scanning": "Course scanning...",
Expand Down