UserChanges.php
105 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Changes; |
| 10 | |
| 11 | use Piwik\Container\StaticContainer; |
| 12 | use Piwik\Date; |
| 13 | use Piwik\Plugins\UsersManager\Model as UsersModel; |
| 14 | /** |
| 15 | * CoreHome user changes class |
| 16 | */ |
| 17 | class UserChanges |
| 18 | { |
| 19 | private $user; |
| 20 | private $changesModel; |
| 21 | /** |
| 22 | * @param array $user |
| 23 | */ |
| 24 | public function __construct(array $user) |
| 25 | { |
| 26 | $this->user = $user; |
| 27 | $this->changesModel = StaticContainer::get(\Piwik\Changes\Model::class); |
| 28 | } |
| 29 | /** |
| 30 | * Return a value indicating if there are any changes available to show the user |
| 31 | * |
| 32 | * @return int Changes\Model::NO_CHANGES_EXIST, Changes\Model::CHANGES_EXIST or Changes\Model::NEW_CHANGES_EXIST |
| 33 | * @throws \Exception |
| 34 | */ |
| 35 | public function getNewChangesStatus() : int |
| 36 | { |
| 37 | return $this->changesModel->doChangesExist($this->getIdchangeLastViewed()); |
| 38 | } |
| 39 | /** |
| 40 | * Return the count of new changes unseen by the user |
| 41 | * |
| 42 | * @return int Change count |
| 43 | * @throws \Exception |
| 44 | */ |
| 45 | public function getNewChangesCount() : int |
| 46 | { |
| 47 | return $this->changesModel->getNewChangesCount($this->getIdchangeLastViewed()); |
| 48 | } |
| 49 | /** |
| 50 | * Return the key of the last viewed change for the user, if any |
| 51 | * |
| 52 | * @return int |
| 53 | */ |
| 54 | private function getIdchangeLastViewed() : ?int |
| 55 | { |
| 56 | return isset($this->user['idchange_last_viewed']) ? intval($this->user['idchange_last_viewed']) : null; |
| 57 | } |
| 58 | /** |
| 59 | * Return true if the changes popup is snoozed |
| 60 | * |
| 61 | * @return bool If changes were shown to the user in the last 24hrs then this will be true, otherwise false |
| 62 | */ |
| 63 | public function shownRecently() : bool |
| 64 | { |
| 65 | $lastShown = isset($this->user['ts_changes_shown']) ? $this->user['ts_changes_shown'] : null; |
| 66 | if (!$lastShown) { |
| 67 | return \false; |
| 68 | // Never shown |
| 69 | } |
| 70 | // Less than 24hrs since last shown |
| 71 | return Date::factory('now')->getTimestamp() - Date::factory($lastShown)->getTimestamp() < 86400; |
| 72 | } |
| 73 | /** |
| 74 | * Return an array of changes and update the user's popup last shown timestamp |
| 75 | * |
| 76 | * @return array |
| 77 | */ |
| 78 | public function getChanges() : array |
| 79 | { |
| 80 | $usersModel = new UsersModel(); |
| 81 | $usersModel->updateUserFields($this->user['login'], ['ts_changes_shown' => Date::now()->getDatetime()]); |
| 82 | return $this->changesModel->getChangeItems(); |
| 83 | } |
| 84 | /** |
| 85 | * Record all changes as read |
| 86 | * |
| 87 | * @return void |
| 88 | * @throws \Piwik\Tracker\Db\DbException |
| 89 | */ |
| 90 | public function markChangesAsRead() : void |
| 91 | { |
| 92 | $changes = $this->changesModel->getChangeItems(); |
| 93 | $maxId = null; |
| 94 | foreach ($changes as $k => $change) { |
| 95 | if ($maxId < $change['idchange']) { |
| 96 | $maxId = $change['idchange']; |
| 97 | } |
| 98 | } |
| 99 | if ($maxId) { |
| 100 | $usersModel = new UsersModel(); |
| 101 | $usersModel->updateUserFields($this->user['login'], ['idchange_last_viewed' => $maxId]); |
| 102 | } |
| 103 | } |
| 104 | } |
| 105 |