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.

Sign up for GitHub

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 pending reason notification events #18162

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Add pending reason notification events #18162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
165 changes: 165 additions & 0 deletions phpunit/functional/PendingReasonTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,16 @@
use CommonITILObject;
use DbTestCase;
use ITILFollowup;
use Notification;
use Notification_NotificationTemplate;
use NotificationTemplate;
use NotificationTemplateTranslation;
use PendingReason;
use PendingReason_Item;
use PHPUnit\Framework\Attributes\DataProvider;
use Problem;
use ProblemTask;
use SolutionTemplate;
use Ticket;
use TicketTask;

Expand Down Expand Up @@ -894,4 +900,163 @@ public function testHandlePendingReasonUpdateFromNewTimelineItem(): void
}
}
}

public function testNotificationEvents(): void
{
/** @var array $CFG_GLPI */
global $CFG_GLPI;

$notification = new Notification();
$entities_id = $this->getTestRootEntity(true);

$add_notifications_id = $notification->add([
'name' => 'Add PendingReason',
'entities_id' => $entities_id,
'itemtype' => 'Ticket',
'event' => 'pendingreason_add',
'is_active' => 1
]);

$remove_notifications_id = $notification->add([
'name' => 'Remove PendingReason',
'entities_id' => $entities_id,
'itemtype' => 'Ticket',
'event' => 'pendingreason_del',
'is_active' => 1
]);

$autoclose_notifications_id = $notification->add([
'name' => 'Auto close PendingReason',
'entities_id' => $entities_id,
'itemtype' => 'Ticket',
'event' => 'pendingreason_close',
'is_active' => 1
]);

$notification_template = new NotificationTemplate();
$notification_notification_template = new Notification_NotificationTemplate();

$add_template_id = $notification_template->add([
'name' => 'PendingReason Add',
'itemtype' => 'Ticket',
]);

$remove_template_id = $notification_template->add([
'name' => 'PendingReason Remove',
'itemtype' => 'Ticket',
]);

$autoclose_template_id = $notification_template->add([
'name' => 'PendingReason Auto close',
'itemtype' => 'Ticket',
]);

$notification_notification_template->add([
'notifications_id' => $add_notifications_id,
'mode' => 'mailing',
'notificationtemplates_id' => $add_template_id,
]);
$notification_notification_template->add([
'notifications_id' => $remove_notifications_id,
'mode' => 'mailing',
'notificationtemplates_id' => $remove_template_id,
]);
$notification_notification_template->add([
'notifications_id' => $autoclose_notifications_id,
'mode' => 'mailing',
'notificationtemplates_id' => $autoclose_template_id,
]);

$translation = new NotificationTemplateTranslation();
$translation->add([
'notificationtemplates_id' => $add_template_id,
'language' => '',
'subject' => 'PendingReason Add',
'content_text' => 'PendingReason Add',
'content_html' => 'PendingReason Add',
]);
$translation->add([
'notificationtemplates_id' => $remove_template_id,
'language' => '',
'subject' => 'PendingReason Remove',
'content_text' => 'PendingReason Remove',
'content_html' => 'PendingReason Remove',
]);
$translation->add([
'notificationtemplates_id' => $autoclose_template_id,
'language' => '',
'subject' => 'PendingReason Auto close',
'content_text' => 'PendingReason Auto close',
'content_html' => 'PendingReason Auto close',
]);

$target = new \NotificationTarget();
$target->add([
'notifications_id' => $add_notifications_id,
'type' => 1, // User
'items_id' => 7 // Writer
]);
$target->add([
'notifications_id' => $remove_notifications_id,
'type' => 1, // User
'items_id' => 7 // Writer
]);
$target->add([
'notifications_id' => $autoclose_notifications_id,
'type' => 1, // User
'items_id' => 7 // Writer
]);

$solutiontemplate = new SolutionTemplate();
$solutiontemplates_id = $solutiontemplate->add([
'name' => __FUNCTION__,
'content' => __FUNCTION__,
'entities_id' => $entities_id,
]);
$pending_reason = new PendingReason();
$pending_reason->add([
'name' => __FUNCTION__,
'entities_id' => $entities_id,
'followup_frequency' => DAY_TIMESTAMP,
'followups_before_resolution' => 3,
'solutiontemplates_id' => $solutiontemplates_id,
]);

$this->login();
$ticket = new Ticket();

$ticket->add([
'name' => __FUNCTION__,
'content' => __FUNCTION__,
'entities_id' => $entities_id,
'status' => CommonITILObject::WAITING,
]);

$CFG_GLPI['use_notifications'] = 1;
$CFG_GLPI['notifications_mailing'] = 1;

$this->assertTrue(PendingReason_Item::createForItem($ticket, [
'pendingreasons_id' => $pending_reason->getID(),
'followup_frequency' => DAY_TIMESTAMP,
'followups_before_resolution' => 3,
]));
$this->assertCount(1, getAllDataFromTable('glpi_queuednotifications', ['notificationtemplates_id' => $add_template_id]));

$pri = new PendingReason_Item();
$this->assertTrue($pri->getFromDBByCrit([
'items_id' => $ticket->getID(),
'itemtype' => $ticket::getType(),
]));
$this->assertTrue($pri->update([
'id' => $pri->getID(),
'bump_count' => 3,
'last_bump_date' => date('Y-m-d H:i:s', time() - (2 * DAY_TIMESTAMP)),
]));

\PendingReasonCron::cronPendingreason_autobump_autosolve(new \CronTask());
$this->assertCount(1, getAllDataFromTable('glpi_queuednotifications', ['notificationtemplates_id' => $autoclose_template_id]));

PendingReason_Item::deleteForItem($ticket);
$this->assertCount(1, getAllDataFromTable('glpi_queuednotifications', ['notificationtemplates_id' => $remove_template_id]));
}
}
3 changes: 3 additions & 0 deletions src/NotificationTargetCommonITILObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@ public function getEvents()
'user_mention' => __('User mentioned'),
'auto_reminder' => ITILReminder::getTypeName(1),
'add_document' => __('New document'),
'pendingreason_add' => __('Pending reason added'),
'pendingreason_del' => __('Pending reason removed'),
'pendingreason_close' => __('Pending reason auto close'),
];

asort($events);
Expand Down
1 change: 1 addition & 0 deletions src/PendingReasonCron.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ public static function cronPendingreason_autobump_autosolve(CronTask $task)
'_disable_auto_assign' => true,
]);
$task->addVolume(1);
NotificationEvent::raiseEvent('pendingreason_close', $item);
}
}

Expand Down
4 changes: 4 additions & 0 deletions src/PendingReason_Item.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ public static function createForItem(CommonDBTM $item, array $fields): bool
$success = $em->add($fields);
if (!$success) {
trigger_error("Failed to create PendingReason_Item", E_USER_WARNING);
} else {
NotificationEvent::raiseEvent('pendingreason_add', $item);
}

return $success;
Expand Down Expand Up @@ -164,6 +166,8 @@ public static function deleteForItem(CommonDBTM $item): bool

if (!$success) {
trigger_error("Failed to delete PendingReason_Item", E_USER_WARNING);
} else {
NotificationEvent::raiseEvent('pendingreason_del', $item);
}

return $success;
Expand Down
Loading