Ubuntu

db = ($db ?? Db::get()); $this->pluginManager = ($pluginManager ?? PluginManager::getInstance()); } /** * Add any new changes for a plugin to the changes table * * @param string $pluginName * * @throws \Exception */ public function addChanges(string $pluginName): void { if ($this->pluginManager->isValidPluginName($pluginName) && $this->pluginManager->isPluginInFilesystem($pluginName)) { $plugin = $this->pluginManager->loadPlugin($pluginName); if (!$plugin) { return; } $changes = $plugin->getChanges(); foreach ($changes as $change) { $this->addChange($pluginName, $change); } } } /** * Remove all changes for a plugin * * @param string $pluginName */ public function removeChanges(string $pluginName): void { $table = Common::prefixTable('changes'); try { $this->db->query("DELETE FROM " . $table . " WHERE plugin_name = ?", [$pluginName]); } catch (\Exception $e) { if (Db::get()->isErrNo($e, Migration\Db::ERROR_CODE_TABLE_NOT_EXISTS)) { return; } throw $e; } } /** * Add a change item to the database table * * @param string $pluginName * @param array $change */ public function addChange(string $pluginName, array $change): void { if(!isset($change['version']) || !isset($change['title']) || !isset($change['description'])) { StaticContainer::get('Psr\Log\LoggerInterface')->warning( "Change item for plugin {plugin} missing version, title or description fields - ignored", ['plugin' => $pluginName]); return; } $table = Common::prefixTable('changes'); $fields = ['created_time', 'plugin_name', 'version', 'title', 'description']; $params = [Date::now()->getDatetime(), $pluginName, $change['version'], $change['title'], $change['description']]; if (isset($change['link_name']) && isset($change['link'])) { $fields[] = 'link_name'; $fields[] = 'link'; $params[] = $change['link_name']; $params[] = $change['link']; } $insertSql = 'INSERT IGNORE INTO ' . $table . ' ('.implode(',', $fields).') VALUES ('.Common::getSqlStringFieldsArray($params).')'; try { $this->db->query($insertSql, $params); } catch (\Exception $e) { if (Db::get()->isErrNo($e, Migration\Db::ERROR_CODE_TABLE_NOT_EXISTS)) { return; } throw $e; } } /** * Check if any changes items exist * * @param int|null $newerThanId Only count new changes as having a key > than this sequential key * * @return int */ public function doChangesExist(?int $newerThanId = null): int { $changes = $this->getChangeItems(); $all = 0; $new = 0; foreach ($changes as $c) { $all++; if ($newerThanId === null || (isset($c['idchange']) && $c['idchange'] > $newerThanId)) { $new++; } } if ($all === 0) { return self::NO_CHANGES_EXIST; } else if ($all > 0 && $new === 0) { return self::CHANGES_EXIST; } else { return self::NEW_CHANGES_EXIST; } } /** * Return an array of change items from the changes table * * @return array * @throws DbException */ public function getChangeItems(): array { $showAtLeast = 10; // Always show at least this number of changes $expireOlderThanDays = 90; // Don't show changes that were added to the table more than x days ago $table = Common::prefixTable('changes'); $selectSql = "SELECT * FROM " . $table . " WHERE title IS NOT NULL ORDER BY idchange DESC"; try { $changes = $this->db->fetchAll($selectSql); } catch (\Exception $e) { if (Db::get()->isErrNo($e, Migration\Db::ERROR_CODE_TABLE_NOT_EXISTS)) { return []; } throw $e; } // Remove expired changes, only if there are at more than the minimum changes $cutOffDate = Date::now()->subDay($expireOlderThanDays); foreach ($changes as $k => $change) { if (isset($change['idchange'])) { $changes[$k]['idchange'] = (int)$change['idchange']; } if (count($changes) > $showAtLeast && $change['created_time'] < $cutOffDate) { unset($changes[$k]); } } /** * Event triggered before changes are displayed * * Can be used to filter out unwanted changes * * **Example** * * Piwik::addAction('Changes.filterChanges', function ($changes) { * foreach ($changes as $k => $c) { * // Hide changes for the CoreHome plugin * if (isset($c['plugin_name']) && $c['plugin_name'] == 'CoreHome') { * unset($changes[$k]); * } * } * }); * * @param array &$changes */ Piwik::postEvent('Changes.filterChanges', array(&$changes)); return $changes; } }