OpenSlides/client/src/app/site/assignments/components/assignment-poll/assignment-poll.component.ts

264 lines
8.9 KiB
TypeScript
Raw Normal View History

2019-03-04 18:28:21 +01:00
import { Component, OnInit, Input } from '@angular/core';
import { FormGroup, FormBuilder } from '@angular/forms';
import { MatDialog, MatSnackBar } from '@angular/material';
2019-03-04 18:28:21 +01:00
import { TranslateService } from '@ngx-translate/core';
import { AssignmentPollDialogComponent } from '../assignment-poll-dialog/assignment-poll-dialog.component';
2019-03-04 18:28:21 +01:00
import { AssignmentPollService } from '../../services/assignment-poll.service';
import { AssignmentRepositoryService } from 'app/core/repositories/assignments/assignment-repository.service';
import { BaseViewComponent } from 'app/site/base/base-view';
2019-03-04 18:28:21 +01:00
import { MajorityMethod, CalculablePollKey } from 'app/core/ui-services/poll.service';
import { OperatorService } from 'app/core/core-services/operator.service';
import { AssignmentPoll } from 'app/shared/models/assignments/assignment-poll';
2019-03-04 18:28:21 +01:00
import { PromptService } from 'app/core/ui-services/prompt.service';
import { Title } from '@angular/platform-browser';
import { ViewAssignment } from '../../models/view-assignment';
import { ViewAssignmentPoll } from '../../models/view-assignment-poll';
import { ViewAssignmentPollOption } from '../../models/view-assignment-poll-option';
2019-03-04 18:28:21 +01:00
/**
* Component for a single assignment poll. Used in assignment detail view
*/
@Component({
selector: 'os-assignment-poll',
templateUrl: './assignment-poll.component.html',
styleUrls: ['./assignment-poll.component.scss']
})
export class AssignmentPollComponent extends BaseViewComponent implements OnInit {
2019-03-04 18:28:21 +01:00
/**
* The related assignment (used for metainfos, e.g. related user names)
*/
@Input()
public assignment: ViewAssignment;
/**
* The poll represented in this component
*/
@Input()
public poll: ViewAssignmentPoll;
2019-03-04 18:28:21 +01:00
/**
* Form for updating the poll's description
*/
public descriptionForm: FormGroup;
2019-03-04 18:28:21 +01:00
/**
* The selected Majority method to display quorum calculations. Will be
* set/changed by the user
*/
public majorityChoice: MajorityMethod | null;
/**
* permission checks.
* TODO stub
*
* @returns true if the user is permitted to do operations
*/
public get canManage(): boolean {
return this.operator.hasPerms('assignments.can_manage');
}
/**
* Gets the voting options
*
2019-03-04 18:28:21 +01:00
* @returns all used (not undefined) option-independent values that are
* used in this poll (e.g.)
*/
public get pollValues(): CalculablePollKey[] {
return this.pollService.pollValues.filter(name => this.poll[name] !== undefined);
}
/**
* @returns true if the description on the form differs from the poll's description
*/
public get dirtyDescription(): boolean {
return this.descriptionForm.get('description').value !== this.poll.description;
}
/**
* @returns true if vote results can be seen by the user
*/
public get pollData(): boolean {
if (!this.poll.has_votes) {
return false;
}
return this.poll.published || this.canManage;
}
2019-03-04 18:28:21 +01:00
/**
* Gets the translated poll method name
*
2019-03-04 18:28:21 +01:00
* TODO: check/improve text here
*
* @returns a name for the poll method this poll is set to (which is determined
* by the number of candidates and config settings).
*/
public get pollMethodName(): string {
if (!this.poll) {
return '';
}
switch (this.poll.pollmethod) {
case 'votes':
return this.translate.instant('Vote per Candidate');
case 'yna':
return this.translate.instant('Yes/No/Abstain per Candidate');
case 'yn':
return this.translate.instant('Yes/No per Candidate');
default:
return '';
}
}
/**
* constructor. Does nothing
*
* @param titleService
* @param matSnackBar
2019-03-04 18:28:21 +01:00
* @param pollService poll related calculations
* @param operator permission checks
* @param assignmentRepo The repository to the assignments
* @param translate Translation service
* @param dialog MatDialog for the vote entering dialog
* @param promptService Prompts for confirmation dialogs
*/
public constructor(
titleService: Title,
matSnackBar: MatSnackBar,
2019-03-04 18:28:21 +01:00
public pollService: AssignmentPollService,
private operator: OperatorService,
private assignmentRepo: AssignmentRepositoryService,
public translate: TranslateService,
public dialog: MatDialog,
private promptService: PromptService,
private formBuilder: FormBuilder
) {
super(titleService, translate, matSnackBar);
}
2019-03-04 18:28:21 +01:00
/**
* Gets the currently selected majority choice option from the repo
2019-03-04 18:28:21 +01:00
*/
public ngOnInit(): void {
this.majorityChoice =
this.pollService.majorityMethods.find(method => method.value === this.pollService.defaultMajorityMethod) ||
null;
this.descriptionForm = this.formBuilder.group({
description: this.poll ? this.poll.description : ''
});
2019-03-04 18:28:21 +01:00
}
/**
* Handler for the 'delete poll' button
*
* TODO: Some confirmation (advanced logic (e.g. not deleting published?))
*/
public async onDeletePoll(): Promise<void> {
const title = this.translate.instant('Are you sure you want to delete this poll?');
if (await this.promptService.open(title, null)) {
await this.assignmentRepo.deletePoll(this.poll).then(null, this.raiseError);
2019-03-04 18:28:21 +01:00
}
}
/**
* Print the PDF of this poll with the corresponding options and numbers
*
2019-03-04 18:28:21 +01:00
* TODO Print the ballots for this poll.
*/
public printBallot(poll: AssignmentPoll): void {
this.raiseError('Not yet implemented');
2019-03-04 18:28:21 +01:00
}
/**
* Determines whether the candidate has reached the majority needed to pass
* the quorum
*
* @param option
* @returns true if the quorum is successfully met
*/
public quorumReached(option: ViewAssignmentPollOption): boolean {
const yesValue = this.poll.pollmethod === 'votes' ? 'Votes' : 'Yes';
const amount = option.votes.find(v => v.value === yesValue).weight;
2019-03-04 18:28:21 +01:00
const yesQuorum = this.pollService.yesQuorum(this.majorityChoice, this.poll, option);
return yesQuorum && amount >= yesQuorum;
}
/**
* Opens the {@link AssignmentPollDialogComponent} dialog and then updates the votes, if the dialog
* closes successfully (validation is done there)
*/
public enterVotes(): void {
const dialogRef = this.dialog.open(AssignmentPollDialogComponent, {
// TODO deep copy of this.poll (JSON parse is ugly workaround) or sending just copy of the options
data: this.poll.copy(),
2019-03-04 18:28:21 +01:00
maxHeight: '90vh',
minWidth: '300px',
maxWidth: '80vw',
2019-03-04 18:28:21 +01:00
disableClose: true
});
dialogRef.afterClosed().subscribe(result => {
if (result) {
this.assignmentRepo.updateVotes(result, this.poll).then(null, this.raiseError);
2019-03-04 18:28:21 +01:00
}
});
}
/**
* Updates the majority method for this poll
*
* @param method the selected majority method
2019-03-04 18:28:21 +01:00
*/
public setMajority(method: MajorityMethod): void {
this.majorityChoice = method;
}
/**
* Toggles the 'published' state
*/
public togglePublished(): void {
this.assignmentRepo.updatePoll({ published: !this.poll.published }, this.poll);
}
/**
* Mark/unmark an option as elected
*
* @param option
*/
public toggleElected(option: ViewAssignmentPollOption): void {
2019-03-04 18:28:21 +01:00
if (!this.operator.hasPerms('assignments.can_manage')) {
return;
}
2019-03-04 18:28:21 +01:00
// TODO additional conditions: assignment not finished?
const viewAssignmentRelatedUser = this.assignment.assignmentRelatedUsers.find(
user => user.user_id === option.user_id
2019-03-04 18:28:21 +01:00
);
if (viewAssignmentRelatedUser) {
this.assignmentRepo.markElected(viewAssignmentRelatedUser, this.assignment, !option.is_elected);
2019-03-04 18:28:21 +01:00
}
}
/**
* Sends the edited poll description to the server
* TODO: Better feedback
*/
public async onEditDescriptionButton(): Promise<void> {
const desc: string = this.descriptionForm.get('description').value;
await this.assignmentRepo.updatePoll({ description: desc }, this.poll).then(null, this.raiseError);
}
/**
* Fetches a tooltip string about the quorum
* @param option
* @returns a translated
*/
public getQuorumReachedString(option: ViewAssignmentPollOption): string {
const name = this.translate.instant(this.majorityChoice.display_name);
const quorum = this.pollService.yesQuorum(this.majorityChoice, this.poll, option);
const isReached = this.quorumReached(option)
? this.translate.instant('reached')
: this.translate.instant('not reached');
return `${name} (${quorum}) ${isReached}`;
}
2019-03-04 18:28:21 +01:00
}