mirror of
https://github.com/standardebooks/web.git
synced 2025-07-05 14:20:29 -04:00
713 lines
21 KiB
PHP
713 lines
21 KiB
PHP
<?
|
||
use function Safe\curl_exec;
|
||
use function Safe\curl_getinfo;
|
||
use function Safe\curl_init;
|
||
use function Safe\curl_setopt;
|
||
use function Safe\json_decode;
|
||
use function Safe\parse_url;
|
||
use function Safe\preg_match;
|
||
use function Safe\preg_match_all;
|
||
use function Safe\preg_replace;
|
||
|
||
use Safe\DateTimeImmutable;
|
||
|
||
/**
|
||
* @property Ebook $Ebook
|
||
* @property User $Manager
|
||
* @property User $Reviewer
|
||
* @property string $Url
|
||
* @property string $EditUrl
|
||
* @property DateTimeImmutable $LastActivityTimestamp The timestamp of the latest activity, whether it's a commit, a discussion post, or simply the started timestamp.
|
||
* @property array<ProjectReminder> $Reminders
|
||
* @property ?string $VcsUrlDomain
|
||
* @property ?string $DiscussionUrlDomain
|
||
*/
|
||
final class Project{
|
||
use Traits\Accessor;
|
||
use Traits\FromRow;
|
||
use Traits\PropertyFromHttp;
|
||
|
||
public int $ProjectId;
|
||
public int $EbookId;
|
||
public Enums\ProjectStatusType $Status = Enums\ProjectStatusType::InProgress;
|
||
public string $ProducerName;
|
||
public ?string $ProducerEmail = null;
|
||
public ?string $DiscussionUrl = null;
|
||
public ?string $VcsUrl;
|
||
public DateTimeImmutable $Created;
|
||
public DateTimeImmutable $Updated;
|
||
public DateTimeImmutable $Started;
|
||
public ?DateTimeImmutable $Ended = null;
|
||
public int $ManagerUserId;
|
||
public int $ReviewerUserId;
|
||
public ?DateTimeImmutable $LastCommitTimestamp = null;
|
||
public ?DateTimeImmutable $LastDiscussionTimestamp = null;
|
||
public bool $IsStatusAutomaticallyUpdated = true;
|
||
|
||
protected Ebook $_Ebook;
|
||
protected User $_Manager;
|
||
protected User $_Reviewer;
|
||
protected string $_Url;
|
||
protected string $_EditUrl;
|
||
protected DateTimeImmutable $_LastActivityTimestamp;
|
||
/** @var array<ProjectReminder> $_Reminders */
|
||
protected array $_Reminders;
|
||
protected ?string $_VcsUrlDomain;
|
||
protected ?string $_DiscussionUrlDomain;
|
||
|
||
|
||
// *******
|
||
// GETTERS
|
||
// *******
|
||
|
||
protected function GetVcsUrlDomain(): ?string{
|
||
if(!isset($this->_VcsUrlDomain)){
|
||
if($this->VcsUrl === null){
|
||
$this->_VcsUrlDomain = null;
|
||
}
|
||
else{
|
||
try{
|
||
$domain = parse_url($this->VcsUrl, PHP_URL_HOST);
|
||
|
||
if(is_string($domain)){
|
||
$this->_VcsUrlDomain = strtolower($domain);
|
||
}
|
||
else{
|
||
$this->_VcsUrlDomain = null;
|
||
}
|
||
}
|
||
catch(\Exception){
|
||
$this->_VcsUrlDomain = null;
|
||
}
|
||
}
|
||
}
|
||
|
||
return $this->_VcsUrlDomain;
|
||
}
|
||
|
||
protected function GetDiscussionUrlDomain(): ?string{
|
||
if(!isset($this->_DiscussionUrlDomain)){
|
||
if($this->DiscussionUrl === null){
|
||
$this->_DiscussionUrlDomain = null;
|
||
}
|
||
else{
|
||
try{
|
||
$domain = parse_url($this->DiscussionUrl, PHP_URL_HOST);
|
||
|
||
if(is_string($domain)){
|
||
$this->_DiscussionUrlDomain = strtolower($domain);
|
||
}
|
||
else{
|
||
$this->_DiscussionUrlDomain = null;
|
||
}
|
||
}
|
||
catch(\Exception){
|
||
$this->_DiscussionUrlDomain = null;
|
||
}
|
||
}
|
||
}
|
||
|
||
return $this->_DiscussionUrlDomain;
|
||
}
|
||
|
||
protected function GetUrl(): string{
|
||
if(!isset($this->_Url)){
|
||
$this->_Url = '/projects/' . $this->ProjectId;
|
||
}
|
||
|
||
return $this->_Url;
|
||
}
|
||
|
||
protected function GetEditUrl(): string{
|
||
if(!isset($this->_EditUrl)){
|
||
$this->_EditUrl = $this->Url . '/edit';
|
||
}
|
||
|
||
return $this->_EditUrl;
|
||
}
|
||
|
||
protected function GetLastActivityTimestamp(): DateTimeImmutable{
|
||
if(!isset($this->_LastActivityTimestamp)){
|
||
$dates = [
|
||
(int)($this->LastCommitTimestamp?->format(Enums\DateTimeFormat::UnixTimestamp->value) ?? 0) => $this->LastCommitTimestamp ?? NOW,
|
||
(int)($this->LastDiscussionTimestamp?->format(Enums\DateTimeFormat::UnixTimestamp->value) ?? 0) => $this->LastDiscussionTimestamp ?? NOW,
|
||
(int)($this->Started->format(Enums\DateTimeFormat::UnixTimestamp->value)) => $this->Started,
|
||
];
|
||
|
||
ksort($dates);
|
||
|
||
$this->_LastActivityTimestamp = end($dates);
|
||
}
|
||
|
||
return $this->_LastActivityTimestamp;
|
||
}
|
||
|
||
/**
|
||
* @throws Exceptions\UserNotFoundException If the `User` can't be found.
|
||
*/
|
||
protected function GetManager(): User{
|
||
if(!isset($this->_Manager)){
|
||
$this->_Manager = User::Get($this->ManagerUserId);
|
||
}
|
||
|
||
return $this->_Manager;
|
||
}
|
||
|
||
/**
|
||
* @throws Exceptions\UserNotFoundException If the `User` can't be found.
|
||
*/
|
||
protected function GetReviewer(): User{
|
||
if(!isset($this->_Reviewer)){
|
||
$this->_Reviewer = User::Get($this->ReviewerUserId);
|
||
}
|
||
|
||
return $this->_Reviewer;
|
||
}
|
||
|
||
/**
|
||
* @return array<ProjectReminder>
|
||
*/
|
||
protected function GetReminders(): array{
|
||
if(!isset($this->_Reminders)){
|
||
$this->_Reminders = Db::Query('SELECT * from ProjectReminders where ProjectId = ? order by Created asc', [$this->ProjectId], ProjectReminder::class);
|
||
}
|
||
|
||
return $this->_Reminders;
|
||
}
|
||
|
||
|
||
// *******
|
||
// METHODS
|
||
// *******
|
||
|
||
/**
|
||
* @throws Exceptions\InvalidProjectException If the `Project` is invalid.
|
||
*/
|
||
public function Validate(bool $allowUnsetEbookId = false, bool $allowUnsetRoles = false): void{
|
||
$error = new Exceptions\InvalidProjectException();
|
||
|
||
if(!$allowUnsetEbookId && !isset($this->EbookId)){
|
||
$error->Add(new Exceptions\EbookRequiredException());
|
||
}
|
||
|
||
$this->ProducerEmail = trim($this->ProducerEmail ?? '');
|
||
if($this->ProducerEmail == ''){
|
||
$this->ProducerEmail = null;
|
||
}
|
||
|
||
// If we have an email address, try to see if we have a matching `User` in the database that we can pull the name from.
|
||
if($this->ProducerEmail !== null){
|
||
try{
|
||
$user = User::GetByEmail($this->ProducerEmail);
|
||
if($user->Name !== null){
|
||
$this->ProducerName = $user->Name;
|
||
}
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
// Pass.
|
||
}
|
||
}
|
||
|
||
$this->ProducerName = trim($this->ProducerName ?? '');
|
||
if($this->ProducerName == ''){
|
||
$error->Add(new Exceptions\ProducerNameRequiredException());
|
||
}
|
||
|
||
$this->DiscussionUrl = trim($this->DiscussionUrl ?? '');
|
||
if($this->DiscussionUrl == ''){
|
||
$this->DiscussionUrl = null;
|
||
}
|
||
else{
|
||
if(preg_match('|^https://groups\.google\.com/d/msgid/|iu', $this->DiscussionUrl)){
|
||
// This URL links to a message which will perform some HTTP redirects to resolve to the actual thread URL.
|
||
// Resolve that URL before continuing.
|
||
$curl = curl_init();
|
||
|
||
curl_setopt($curl, CURLOPT_HEADER, true);
|
||
curl_setopt($curl, CURLOPT_NOBODY, true);
|
||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
|
||
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
|
||
|
||
curl_setopt($curl, CURLOPT_URL, $this->DiscussionUrl);
|
||
curl_exec($curl);
|
||
|
||
/** @var string $url */
|
||
$url = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
|
||
|
||
$this->DiscussionUrl = $url;
|
||
}
|
||
|
||
if(preg_match('|^https://groups\.google\.com/g/standardebooks/|iu', $this->DiscussionUrl)){
|
||
// Get the base thread URL in case we were passed a URL with a specific message or query string.
|
||
$this->DiscussionUrl = preg_replace('|^(https://groups\.google\.com/g/standardebooks/c/[^/]+).*|iu', '\1', $this->DiscussionUrl);
|
||
}
|
||
|
||
if(!preg_match('|^https://groups\.google\.com/g/standardebooks/c/[^/\?]+$|iu', $this->DiscussionUrl)){
|
||
$error->Add(new Exceptions\InvalidDiscussionUrlException($this->DiscussionUrl));
|
||
}
|
||
}
|
||
|
||
$this->VcsUrl = trim($this->VcsUrl ?? '');
|
||
if($this->VcsUrl == ''){
|
||
$this->VcsUrl = null;
|
||
}
|
||
elseif(preg_match('|^https?://(www\.)?github.com/|ius', $this->VcsUrl)){
|
||
$this->VcsUrl = rtrim($this->VcsUrl, '/');
|
||
if(!preg_match('|^https://github.com/[^/]+/[^/]+$|ius', $this->VcsUrl)){
|
||
$error->Add(new Exceptions\InvalidVcsUrlException($this->VcsUrl));
|
||
}
|
||
}
|
||
|
||
if(!$allowUnsetRoles && !isset($this->ManagerUserId)){
|
||
$error->Add(new Exceptions\ManagerRequiredException());
|
||
}
|
||
elseif(isset($this->ManagerUserId)){
|
||
try{
|
||
$this->_Manager = User::Get($this->ManagerUserId);
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
$error->Add(new Exceptions\UserNotFoundException('Manager user not found.'));
|
||
}
|
||
}
|
||
|
||
if(!$allowUnsetRoles && !isset($this->ReviewerUserId)){
|
||
$error->Add(new Exceptions\ReviewerRequiredException());
|
||
}
|
||
elseif(isset($this->ReviewerUserId)){
|
||
try{
|
||
$this->_Reviewer = User::Get($this->ReviewerUserId);
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
$error->Add(new Exceptions\UserNotFoundException('Reviewer user not found.'));
|
||
}
|
||
}
|
||
|
||
if(!isset($this->Started)){
|
||
$this->Started = NOW;
|
||
}
|
||
|
||
if($error->HasExceptions){
|
||
throw $error;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Creates a new `Project`. If `Project::$Manager` or `Project::$Reviewer` are unassigned, they will be automatically assigned.
|
||
*
|
||
* @throws Exceptions\InvalidProjectException If the `Project` is invalid.
|
||
* @throws Exceptions\EbookIsNotAPlaceholderException If the `Project`'s `Ebook` is not a placeholder.
|
||
* @throws Exceptions\ProjectExistsException If the `Project`'s `Ebook` already has an active `Project`.
|
||
* @throws Exceptions\UserNotFoundException If a manager or reviewer could not be auto-assigned.
|
||
*/
|
||
public function Create(): void{
|
||
// Is this `Project` being produced by one of the editors?
|
||
try{
|
||
$producer = User::GetByIdentifier($this->ProducerName);
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
$producer = null;
|
||
}
|
||
|
||
if(!isset($this->ManagerUserId)){
|
||
try{
|
||
$this->Manager = User::GetByAvailableForProjectAssignment(Enums\ProjectRoleType::Manager, [$producer->UserId ?? 0]);
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
throw new Exceptions\UserNotFoundException('Could not auto-assign a suitable manager.');
|
||
}
|
||
|
||
$this->ManagerUserId = $this->Manager->UserId;
|
||
}
|
||
|
||
if(!isset($this->ReviewerUserId)){
|
||
try{
|
||
$this->Reviewer = User::GetByAvailableForProjectAssignment(Enums\ProjectRoleType::Reviewer, [$this->Manager->UserId, $producer->UserId ?? 0]);
|
||
}
|
||
catch(Exceptions\UserNotFoundException){
|
||
unset($this->Manager);
|
||
unset($this->ManagerUserId);
|
||
throw new Exceptions\UserNotFoundException('Could not auto-assign a suitable reviewer.');
|
||
}
|
||
|
||
$this->ReviewerUserId = $this->Reviewer->UserId;
|
||
}
|
||
|
||
$this->Validate(false, true);
|
||
|
||
try{
|
||
$this->FetchLastDiscussionTimestamp();
|
||
}
|
||
catch(Exceptions\AppException){
|
||
// Pass; it's OK if this fails during creation.
|
||
}
|
||
|
||
try{
|
||
$this->FetchLatestCommitTimestamp();
|
||
}
|
||
catch(Exceptions\AppException){
|
||
// Pass; it's OK if this fails during creation.
|
||
}
|
||
|
||
// Don't let the started date be later than the first commit date. This can happen if the producer starts to commit before their project is approved on the mailing list.
|
||
if($this->LastCommitTimestamp !== null && $this->Started > $this->LastCommitTimestamp){
|
||
$this->Started = $this->LastCommitTimestamp;
|
||
}
|
||
|
||
// Is this ebook already released?
|
||
if(!$this->Ebook->IsPlaceholder()){
|
||
throw new Exceptions\EbookIsNotAPlaceholderException();
|
||
}
|
||
|
||
// Does this `Ebook` already has an active `Project`?
|
||
if($this->Ebook->ProjectInProgress !== null){
|
||
throw new Exceptions\ProjectExistsException();
|
||
}
|
||
|
||
Db::Query('
|
||
INSERT into Projects
|
||
(
|
||
EbookId,
|
||
Status,
|
||
ProducerName,
|
||
ProducerEmail,
|
||
DiscussionUrl,
|
||
VcsUrl,
|
||
Created,
|
||
Updated,
|
||
Started,
|
||
Ended,
|
||
ManagerUserId,
|
||
ReviewerUserId,
|
||
LastCommitTimestamp,
|
||
LastDiscussionTimestamp,
|
||
IsStatusAutomaticallyUpdated
|
||
)
|
||
values
|
||
(
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?,
|
||
?
|
||
)
|
||
', [$this->EbookId, $this->Status, $this->ProducerName, $this->ProducerEmail, $this->DiscussionUrl, $this->VcsUrl, NOW, NOW, $this->Started, $this->Ended, $this->ManagerUserId, $this->ReviewerUserId, $this->LastCommitTimestamp, $this->LastDiscussionTimestamp, $this->IsStatusAutomaticallyUpdated]);
|
||
|
||
$this->ProjectId = Db::GetLastInsertedId();
|
||
|
||
// Notify the manager and reviewer.
|
||
if($this->Status == Enums\ProjectStatusType::InProgress){
|
||
// The manager is also the reviewer, just send one email.
|
||
if($this->ManagerUserId == $this->ReviewerUserId){
|
||
if($this->Manager->Email !== null && $this->Manager->Name != $this->ProducerName){
|
||
$em = new Email();
|
||
$em->From = ADMIN_EMAIL_ADDRESS;
|
||
$em->To = $this->Manager->Email;
|
||
$em->Subject = 'New ebook project to manage and review';
|
||
$em->Body = Template::EmailManagerNewProject(['project' => $this, 'role' => 'manage and review', 'user' => $this->Manager]);
|
||
$em->TextBody = Template::EmailManagerNewProjectText(['project' => $this, 'role' => 'manage and review', 'user' => $this->Manager]);
|
||
$em->Send();
|
||
}
|
||
}
|
||
else{
|
||
// Notify the manager.
|
||
if($this->Manager->Email !== null){
|
||
$em = new Email();
|
||
$em->From = ADMIN_EMAIL_ADDRESS;
|
||
$em->To = $this->Manager->Email;
|
||
$em->Subject = 'New ebook project to manage';
|
||
$em->Body = Template::EmailManagerNewProject(['project' => $this, 'role' => 'manage', 'user' => $this->Manager]);
|
||
$em->TextBody = Template::EmailManagerNewProjectText(['project' => $this, 'role' => 'manage', 'user' => $this->Manager]);
|
||
$em->Send();
|
||
}
|
||
|
||
// Notify the reviewer.
|
||
if($this->Reviewer->Email !== null){
|
||
$em = new Email();
|
||
$em->From = ADMIN_EMAIL_ADDRESS;
|
||
$em->To = $this->Reviewer->Email;
|
||
$em->Subject = 'New ebook project to review';
|
||
$em->Body = Template::EmailManagerNewProject(['project' => $this, 'role' => 'review', 'user' => $this->Reviewer]);
|
||
$em->TextBody = Template::EmailManagerNewProjectText(['project' => $this, 'role' => 'review', 'user' => $this->Reviewer]);
|
||
$em->Send();
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @throws Exceptions\InvalidProjectException If the `Project` is invalid.
|
||
*/
|
||
public function Save(): void{
|
||
$this->Validate();
|
||
|
||
Db::Query('
|
||
UPDATE
|
||
Projects
|
||
set
|
||
Status = ?,
|
||
ProducerName = ?,
|
||
ProducerEmail = ?,
|
||
DiscussionUrl = ?,
|
||
VcsUrl = ?,
|
||
Started = ?,
|
||
Ended = ?,
|
||
ManagerUserId = ?,
|
||
ReviewerUserId = ?,
|
||
LastCommitTimestamp = ?,
|
||
LastDiscussionTimestamp = ?,
|
||
IsStatusAutomaticallyUpdated = ?
|
||
where
|
||
ProjectId = ?
|
||
', [$this->Status, $this->ProducerName, $this->ProducerEmail, $this->DiscussionUrl, $this->VcsUrl, $this->Started, $this->Ended, $this->ManagerUserId, $this->ReviewerUserId, $this->LastCommitTimestamp, $this->LastDiscussionTimestamp, $this->IsStatusAutomaticallyUpdated, $this->ProjectId]);
|
||
|
||
if($this->Status == Enums\ProjectStatusType::Abandoned){
|
||
Db::Query('
|
||
UPDATE
|
||
EbookPlaceholders
|
||
set
|
||
IsInProgress = false
|
||
where
|
||
EbookId = ?
|
||
', [$this->EbookId]);
|
||
}
|
||
}
|
||
|
||
public function Delete(): void{
|
||
Db::Query('
|
||
DELETE
|
||
from ProjectReminders
|
||
where ProjectId = ?
|
||
', [$this->ProjectId]);
|
||
|
||
Db::Query('
|
||
DELETE
|
||
from Projects
|
||
where ProjectId = ?
|
||
', [$this->ProjectId]);
|
||
}
|
||
|
||
public function FillFromHttpPost(): void{
|
||
$this->PropertyFromHttp('EbookId');
|
||
$this->PropertyFromHttp('ProducerName');
|
||
$this->PropertyFromHttp('ProducerEmail');
|
||
$this->PropertyFromHttp('DiscussionUrl');
|
||
$this->PropertyFromHttp('Status');
|
||
$this->PropertyFromHttp('VcsUrl');
|
||
$this->PropertyFromHttp('Started');
|
||
$this->PropertyFromHttp('Ended');
|
||
$this->PropertyFromHttp('ManagerUserId');
|
||
$this->PropertyFromHttp('ReviewerUserId');
|
||
$this->PropertyFromHttp('IsStatusAutomaticallyUpdated');
|
||
}
|
||
|
||
/**
|
||
* @throws Exceptions\AppException If the operation failed.
|
||
*/
|
||
public function FetchLatestCommitTimestamp(?string $apiKey = null): void{
|
||
if(!preg_match('|^https://github\.com/|iu', $this->VcsUrl ?? '')){
|
||
return;
|
||
}
|
||
|
||
$headers = [
|
||
'Accept: application/vnd.github+json',
|
||
'X-GitHub-Api-Version: 2022-11-28',
|
||
'User-Agent: Standard Ebooks' // Required by GitHub.
|
||
];
|
||
|
||
if($apiKey !== null){
|
||
$headers[] = 'Authorization: Bearer ' . $apiKey;
|
||
}
|
||
|
||
// First, we check if the repo has been renamed. If so, update the repo now.
|
||
$curl = curl_init($this->VcsUrl);
|
||
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, Enums\HttpMethod::Head->value); // Only perform HTTP HEAD.
|
||
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
|
||
curl_exec($curl);
|
||
|
||
/** @var string $finalUrl */
|
||
$finalUrl = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
|
||
// Were we redirected?
|
||
if($finalUrl != $this->VcsUrl){
|
||
$this->VcsUrl = $finalUrl;
|
||
}
|
||
|
||
// Now check the actual commits.
|
||
$url = preg_replace('|^https://github.com/|iu', 'https://api.github.com/repos/', $this->VcsUrl . '/commits');
|
||
|
||
$curl = curl_init($url);
|
||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
|
||
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
|
||
|
||
try{
|
||
$response = curl_exec($curl);
|
||
/** @var int $httpCode */
|
||
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
||
|
||
if(!is_string($response)){
|
||
throw new Exceptions\AppException('Response from <' . $url . '> was not a string: ' . $response);
|
||
}
|
||
|
||
if($httpCode != Enums\HttpCode::Ok->value){
|
||
throw new Exception('HTTP code ' . $httpCode . ' received for URL <' . $url . '>.');
|
||
}
|
||
|
||
/** @var array<stdClass> $commits */
|
||
$commits = json_decode($response);
|
||
|
||
if(sizeof($commits) > 0){
|
||
$this->LastCommitTimestamp = new DateTimeImmutable($commits[0]->commit->committer->date);
|
||
}
|
||
}
|
||
catch(Exception $ex){
|
||
throw new Exceptions\AppException('Error when fetching commits for URL <' . $url . '>: ' . $ex->getMessage(), 0, $ex);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @throws Exceptions\AppException If the operation faile.d
|
||
*/
|
||
public function FetchLastDiscussionTimestamp(): void{
|
||
if(!preg_match('|^https://groups\.google\.com/g/standardebooks/|iu', $this->DiscussionUrl ?? '')){
|
||
return;
|
||
}
|
||
|
||
$curl = curl_init($this->DiscussionUrl);
|
||
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
|
||
|
||
try{
|
||
$response = curl_exec($curl);
|
||
/** @var int $httpCode */
|
||
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
||
|
||
if(!is_string($response)){
|
||
throw new Exceptions\AppException('Response from <' . $this->DiscussionUrl . '> was not a string: ' . $response);
|
||
}
|
||
|
||
if($httpCode != Enums\HttpCode::Ok->value){
|
||
throw new Exception('HTTP code ' . $httpCode . ' received for URL <' . $this->DiscussionUrl . '>.');
|
||
}
|
||
|
||
$matchCount = preg_match_all('/<span class="[^"]+?">([a-z]{3} [\d]{1,2}, [\d]{4}, [\d]{1,2}:[\d]{1,2}:[\d]{1,2} (?:AM|PM))/iu', $response, $matches);
|
||
|
||
if($matchCount > 0){
|
||
// Unsure of the time zone, so just assume UTC.
|
||
try{
|
||
$this->LastDiscussionTimestamp = new DateTimeImmutable(str_replace(' ', ' ', $matches[1][sizeof($matches[1]) - 1]));
|
||
}
|
||
catch(\Exception $ex){
|
||
// Failed to parse date, pass.
|
||
$this->LastDiscussionTimestamp = null;
|
||
}
|
||
}
|
||
else{
|
||
$this->LastDiscussionTimestamp = null;
|
||
}
|
||
}
|
||
catch(Exception $ex){
|
||
throw new Exceptions\AppException('Error when fetching discussion for URL <' . $this->DiscussionUrl . '>: ' . $ex->getMessage(), 0, $ex);
|
||
}
|
||
}
|
||
|
||
public function GetReminder(Enums\ProjectReminderType $type): ?ProjectReminder{
|
||
foreach($this->Reminders as $reminder){
|
||
if($reminder->Type == $type){
|
||
return $reminder;
|
||
}
|
||
}
|
||
|
||
return null;
|
||
}
|
||
|
||
public function SendReminder(Enums\ProjectReminderType $type): void{
|
||
if($this->ProducerEmail === null || $this->GetReminder($type) !== null){
|
||
return;
|
||
}
|
||
|
||
$reminder = new ProjectReminder();
|
||
$reminder->ProjectId = $this->ProjectId;
|
||
$reminder->Type = $type;
|
||
$reminder->Create();
|
||
|
||
$em = new Email();
|
||
$em->From = EDITOR_IN_CHIEF_EMAIL_ADDRESS;
|
||
$em->FromName = EDITOR_IN_CHIEF_NAME;
|
||
$em->To = $this->ProducerEmail;
|
||
$em->Subject = 'Your Standard Ebooks ebook';
|
||
|
||
switch($type){
|
||
case Enums\ProjectReminderType::Stalled:
|
||
$em->Body = Template::EmailProjectStalled();
|
||
$em->TextBody = Template::EmailProjectStalledText();
|
||
break;
|
||
|
||
case Enums\ProjectReminderType::Abandoned:
|
||
$em->Body = Template::EmailProjectAbandoned();
|
||
$em->TextBody = Template::EmailProjectAbandonedText();
|
||
break;
|
||
}
|
||
|
||
$em->Send();
|
||
}
|
||
|
||
|
||
// ***********
|
||
// ORM METHODS
|
||
// ***********
|
||
|
||
/**
|
||
* @throws Exceptions\ProjectNotFoundException If the `Project` can't be found.
|
||
*/
|
||
public static function Get(?int $projectId): Project{
|
||
if($projectId === null){
|
||
throw new Exceptions\ProjectNotFoundException();
|
||
}
|
||
|
||
return Db::Query('SELECT * from Projects where ProjectId = ?', [$projectId], Project::class)[0] ?? throw new Exceptions\ProjectNotFoundException();
|
||
}
|
||
|
||
/**
|
||
* @return array<Project>
|
||
*/
|
||
public static function GetAllByStatus(Enums\ProjectStatusType $status): array{
|
||
return Db::MultiTableSelect('SELECT * from Projects inner join Ebooks on Projects.EbookId = Ebooks.EbookId where Projects.Status = ? order by regexp_replace(Title, \'^(A|An|The)\\\s\', \'\') asc', [$status], Project::class);
|
||
}
|
||
|
||
/**
|
||
* @return array<Project>
|
||
*/
|
||
public static function GetAllByManagerUserId(int $userId): array{
|
||
return Db::MultiTableSelect('SELECT * from Projects inner join Ebooks on Projects.EbookId = Ebooks.EbookId where ManagerUserId = ? and Status in (?, ?) order by regexp_replace(Title, \'^(A|An|The)\\\s\', \'\') asc', [$userId, Enums\ProjectStatusType::InProgress, Enums\ProjectStatusType::Stalled], Project::class);
|
||
}
|
||
|
||
/**
|
||
* @return array<Project>
|
||
*/
|
||
public static function GetAllByReviewerUserId(int $userId): array{
|
||
return Db::MultiTableSelect('SELECT * from Projects inner join Ebooks on Projects.EbookId = Ebooks.EbookId where ReviewerUserId = ? and Status in (?, ?) order by regexp_replace(Title, \'^(A|An|The)\\\s\', \'\') asc', [$userId, Enums\ProjectStatusType::InProgress, Enums\ProjectStatusType::Stalled], Project::class);
|
||
}
|
||
|
||
/**
|
||
* Creates a `Project` from a multi table array containing a `Project` and an `Ebook`.
|
||
*
|
||
* @param array<string, stdClass> $row
|
||
*/
|
||
public static function FromMultiTableRow(array $row): Project{
|
||
$object = Project::FromRow($row['Projects']);
|
||
|
||
if($row['Projects']->EbookId !== null){
|
||
$object->Ebook = Ebook::FromRow($row['Ebooks']);
|
||
}
|
||
|
||
return $object;
|
||
}
|
||
}
|