mirror of
https://github.com/solidtime-io/solidtime.git
synced 2026-10-11 15:23:17 +01:00
8d34513bde
Partial updates of time entries only validated end against start if both were part of the payload. Start and end are now also validated against the persisted value if only one of them is sent (fixes #1189). The importers now fail if the end of a time entry is before the start and the database consistency check reports such time entries.
281 lines
11 KiB
PHP
281 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Service\Import\Importers;
|
|
|
|
use App\Enums\Role;
|
|
use App\Enums\TimeEntryType;
|
|
use App\Jobs\RecalculateSpentTimeForProject;
|
|
use App\Jobs\RecalculateSpentTimeForTask;
|
|
use App\Models\TimeEntry;
|
|
use Carbon\Exceptions\InvalidFormatException;
|
|
use Exception;
|
|
use Illuminate\Support\Carbon;
|
|
use Illuminate\Support\Str;
|
|
use League\Csv\Exception as CsvException;
|
|
use League\Csv\Reader;
|
|
use Override;
|
|
|
|
class ClockifyTimeEntriesImporter extends DefaultImporter
|
|
{
|
|
/**
|
|
* @return array<string>
|
|
*
|
|
* @throws ImportException
|
|
*/
|
|
private function getTags(string $tags): array
|
|
{
|
|
if (Str::trim($tags) === '') {
|
|
return [];
|
|
}
|
|
$tagsParsed = explode(', ', $tags);
|
|
$tagIds = [];
|
|
foreach ($tagsParsed as $tagParsed) {
|
|
$tagId = $this->tagImportHelper->getKey([
|
|
'name' => $tagParsed,
|
|
'organization_id' => $this->organization->id,
|
|
]);
|
|
$tagIds[] = $tagId;
|
|
}
|
|
|
|
return $tagIds;
|
|
}
|
|
|
|
/**
|
|
* @throws ImportException
|
|
*/
|
|
#[Override]
|
|
public function importData(string $data, string $timezone): void
|
|
{
|
|
try {
|
|
$reader = Reader::createFromString($data);
|
|
$reader->setHeaderOffset(0);
|
|
$reader->setDelimiter(',');
|
|
$reader->setEnclosure('"');
|
|
$reader->setEscape('');
|
|
$header = $reader->getHeader();
|
|
$this->validateHeader($header);
|
|
$taskKey = $this->getTaskKey($header);
|
|
$records = $reader->getRecords();
|
|
foreach ($records as $record) {
|
|
$userId = $this->userImportHelper->getKey([
|
|
'email' => $record['Email'],
|
|
], [
|
|
'name' => $record['User'],
|
|
'timezone' => 'UTC',
|
|
'is_placeholder' => true,
|
|
]);
|
|
$memberId = $this->memberImportHelper->getKey([
|
|
'user_id' => $userId,
|
|
'organization_id' => $this->organization->getKey(),
|
|
], [
|
|
'role' => Role::Placeholder->value,
|
|
]);
|
|
$member = $this->memberImportHelper->getModelById($memberId);
|
|
// Clockify allows a project/task/client/tags/billable on breaks, but those are
|
|
// meaningless for non-work time. Detect breaks up front and skip creating any of
|
|
// that so a break can't spawn an orphan project/tag or inflate the import counts.
|
|
$isBreak = isset($record['Type']) && strtolower($record['Type']) === 'break';
|
|
$clientId = null;
|
|
if (! $isBreak && ($record['Client'] ?? '') !== '') {
|
|
$clientId = $this->clientImportHelper->getKey([
|
|
'name' => $record['Client'],
|
|
'organization_id' => $this->organization->id,
|
|
]);
|
|
}
|
|
$projectId = null;
|
|
$project = null;
|
|
$projectMember = null;
|
|
if (! $isBreak && $record['Project'] !== '') {
|
|
$projectId = $this->projectImportHelper->getKey([
|
|
'name' => $record['Project'],
|
|
'client_id' => $clientId,
|
|
'organization_id' => $this->organization->id,
|
|
], [
|
|
'color' => $this->colorService->getRandomColor(),
|
|
'is_billable' => false,
|
|
]);
|
|
$project = $this->projectImportHelper->getModelById($projectId);
|
|
$projectMember = $this->projectMemberImportHelper->getModel([
|
|
'project_id' => $projectId,
|
|
'member_id' => $memberId,
|
|
]);
|
|
}
|
|
$taskId = null;
|
|
if (! $isBreak && $taskKey !== null && $record[$taskKey] !== '') {
|
|
$this->checkTaskNameLength($record[$taskKey]);
|
|
$taskId = $this->taskImportHelper->getKey([
|
|
'name' => $record[$taskKey],
|
|
'project_id' => $projectId,
|
|
'organization_id' => $this->organization->id,
|
|
]);
|
|
$this->taskImportHelper->getModelById($taskId);
|
|
}
|
|
$timeEntry = new TimeEntry;
|
|
$timeEntry->disableAuditing();
|
|
$timeEntry->user_id = $userId;
|
|
$timeEntry->member_id = $memberId;
|
|
$timeEntry->task_id = $taskId;
|
|
$timeEntry->project_id = $projectId;
|
|
$timeEntry->client_id = $clientId;
|
|
$timeEntry->organization_id = $this->organization->id;
|
|
if (strlen($record['Description']) > 5000) {
|
|
throw new ImportException('Time entry description is too long');
|
|
}
|
|
$timeEntry->description = $record['Description'];
|
|
if (isset($record['Billable'])) {
|
|
if (! in_array($record['Billable'], ['Yes', 'No'], true)) {
|
|
throw new ImportException('Invalid billable value');
|
|
}
|
|
$timeEntry->billable = $record['Billable'] === 'Yes';
|
|
}
|
|
if ($isBreak) {
|
|
// Breaks can not be billable or belong to a project/task (already skipped above)
|
|
$timeEntry->type = TimeEntryType::Break;
|
|
$timeEntry->billable = false;
|
|
}
|
|
$timeEntry->tags = $isBreak ? [] : $this->getTags($record['Tags']);
|
|
$timeEntry->is_imported = true;
|
|
|
|
// Start
|
|
$start = null;
|
|
try {
|
|
$startDateStr = $record['Start Date'];
|
|
$startTimeStr = $record['Start Time'];
|
|
$startStr = $startDateStr.' '.$startTimeStr;
|
|
$matches = [];
|
|
$checkResult = preg_match('/^([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{4}) ([0-9]{1,2}):([0-9]{1,2})(:[0-9]{1,2})? (AM|PM)$/', $startStr, $matches);
|
|
|
|
if ($checkResult === 1) {
|
|
if ((int) $matches[1] > 12) {
|
|
throw new ImportException('Start date ("'.$startDateStr.'") is invalid, please select the correct date format before exporting from Clockify');
|
|
}
|
|
if ($matches[6] === '') {
|
|
$start = Carbon::createFromFormat('m/d/Y h:i A', $startStr, $timezone);
|
|
} else {
|
|
$start = Carbon::createFromFormat('m/d/Y H:i:s A', $startStr, $timezone);
|
|
}
|
|
}
|
|
} catch (InvalidFormatException) {
|
|
throw new ImportException('Start date ("'.$startDateStr.'") or time ("'.$startTimeStr.'") are invalid');
|
|
}
|
|
if ($start === null) {
|
|
throw new ImportException('Start date ("'.$startDateStr.'") or time ("'.$startTimeStr.'") are invalid');
|
|
}
|
|
$timeEntry->start = $start->utc();
|
|
|
|
// End
|
|
$end = null;
|
|
try {
|
|
$endDateStr = $record['End Date'];
|
|
$endTimeStr = $record['End Time'];
|
|
$endStr = $endDateStr.' '.$endTimeStr;
|
|
$matches = [];
|
|
$checkResult = preg_match('/^([0-9]{1,2})\/([0-9]{1,2})\/([0-9]{4}) ([0-9]{1,2}):([0-9]{1,2})(:[0-9]{1,2})? (AM|PM)$/', $endStr, $matches);
|
|
|
|
if ($checkResult === 1) {
|
|
if ((int) $matches[1] > 12) {
|
|
throw new ImportException('Start date ("'.$endDateStr.'") is invalid, please select the correct date format before exporting from Clockify');
|
|
}
|
|
if ($matches[6] === '') {
|
|
$end = Carbon::createFromFormat('m/d/Y h:i A', $endStr, $timezone);
|
|
} else {
|
|
$end = Carbon::createFromFormat('m/d/Y H:i:s A', $endStr, $timezone);
|
|
}
|
|
}
|
|
} catch (InvalidFormatException) {
|
|
throw new ImportException('End date ("'.$endDateStr.'") or time ("'.$endTimeStr.'") are invalid');
|
|
}
|
|
if ($end === null) {
|
|
throw new ImportException('End date ("'.$endDateStr.'") or time ("'.$endTimeStr.'") are invalid');
|
|
}
|
|
if ($end->lt($start)) {
|
|
throw new ImportException('End ("'.$endStr.'") is before start ("'.$startStr.'")');
|
|
}
|
|
$timeEntry->end = $end->utc();
|
|
|
|
$timeEntry->billable_rate = $this->billableRateService->getBillableRateForTimeEntryWithGivenRelations(
|
|
$timeEntry,
|
|
$projectMember,
|
|
$project,
|
|
$member,
|
|
$this->organization
|
|
);
|
|
$timeEntry->save();
|
|
$this->timeEntriesCreated++;
|
|
}
|
|
foreach ($this->projectImportHelper->getCachedModels() as $usedProject) {
|
|
RecalculateSpentTimeForProject::dispatch($usedProject);
|
|
}
|
|
foreach ($this->taskImportHelper->getCachedModels() as $usedTask) {
|
|
RecalculateSpentTimeForTask::dispatch($usedTask);
|
|
}
|
|
} catch (ImportException $exception) {
|
|
throw $exception;
|
|
} catch (CsvException $exception) {
|
|
throw new ImportException('Invalid CSV data');
|
|
} catch (Exception $exception) {
|
|
report($exception);
|
|
throw new ImportException('Unknown error');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array<string> $header
|
|
*
|
|
* @throws ImportException
|
|
*/
|
|
private function validateHeader(array $header): void
|
|
{
|
|
$requiredFields = [
|
|
'Project',
|
|
'Description',
|
|
'User',
|
|
'Email',
|
|
'Tags',
|
|
'Start Date',
|
|
'Start Time',
|
|
'End Date',
|
|
'End Time',
|
|
];
|
|
foreach ($requiredFields as $requiredField) {
|
|
if (! in_array($requiredField, $header, true)) {
|
|
throw new ImportException('Invalid CSV header, missing field: '.$requiredField);
|
|
}
|
|
}
|
|
// Clockify names the task column "Task" or "Activity" depending on the export; accept either.
|
|
if ($this->getTaskKey($header) === null) {
|
|
throw new ImportException('Invalid CSV header, missing field: Task');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clockify names the task column "Task" or "Activity" depending on the export version.
|
|
*
|
|
* @param array<string> $header
|
|
*/
|
|
private function getTaskKey(array $header): ?string
|
|
{
|
|
foreach (['Task', 'Activity'] as $field) {
|
|
if (in_array($field, $header, true)) {
|
|
return $field;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
#[Override]
|
|
public function getName(): string
|
|
{
|
|
return __('importer.clockify_time_entries.name');
|
|
}
|
|
|
|
#[Override]
|
|
public function getDescription(): string
|
|
{
|
|
return __('importer.clockify_time_entries.description');
|
|
}
|
|
}
|